API reference / Supply chain

Supply chain API

6 endpoints. Scopes: Scalar360.scm.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

List

/api/v1/scm/couriers

Scope: Scalar360.scm.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/scm/couriers" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create

/api/v1/scm/couriers

Scope: Scalar360.scm.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`baseUrl`	string
`apiKey`	string
`enabled`	boolean
`isDefault`	boolean
`config`	string

Example request

curl -X POST "https://api.scalar360.com/api/v1/scm/couriers" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

PUT

Update

/api/v1/scm/couriers/{id}

Scope: Scalar360.scm.UPDATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`baseUrl`	string
`apiKey`	string
`enabled`	boolean
`isDefault`	boolean
`config`	string

Example request

curl -X PUT "https://api.scalar360.com/api/v1/scm/couriers/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","baseUrl":"string","apiKey":"string","enabled":true,"isDefault":true,"config":"string"}'

DELETE

Delete

/api/v1/scm/couriers/{id}

Scope: Scalar360.scm.DELETE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/scm/couriers/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Test

/api/v1/scm/couriers/test

Scope: Scalar360.scm.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`baseUrl`	string
`apiKey`	string
`enabled`	boolean
`isDefault`	boolean
`config`	string

Example request

curl -X POST "https://api.scalar360.com/api/v1/scm/couriers/test" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

GET

Dashboard

/api/v1/scm/dashboard

Scope: Scalar360.scm.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/scm/dashboard" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"