API reference / Price lists

Price lists API

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

GET

List

/api/v1/price-lists

Scope: Scalar360.price-lists.READ

Example request

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

POST

Create

/api/v1/price-lists

Scope: Scalar360.price-lists.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`isDefault`	boolean
`items`	array of object
`items[].itemId`	string (uuid)
`items[].price`	number

Example request

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

GET

Get

/api/v1/price-lists/{id}

Scope: Scalar360.price-lists.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/price-lists/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update

/api/v1/price-lists/{id}

Scope: Scalar360.price-lists.UPDATE

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

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`isDefault`	boolean
`items`	array of object
`items[].itemId`	string (uuid)
`items[].price`	number

Example request

curl -X PUT "https://api.scalar360.com/api/v1/price-lists/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","isDefault":true,"items":[{"itemId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d","price":100}]}'

DELETE

Delete

/api/v1/price-lists/{id}

Scope: Scalar360.price-lists.DELETE

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

Example request

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