API reference / Composite items

Composite items API

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

GET

List

/api/v1/composite-items

Scope: Scalar360.composite-items.READ

Example request

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

POST

Assemble

/api/v1/composite-items/{itemId}/assemble

Scope: Scalar360.composite-items.CREATE

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

Body field	Type	Required	Notes
`warehouseId`	string (uuid)
`quantity`	number	Yes	required

Example request

curl -X POST "https://api.scalar360.com/api/v1/composite-items/{itemId}/assemble" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"quantity":100}'

GET

Get

/api/v1/composite-items/{itemId}/components

Scope: Scalar360.composite-items.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/composite-items/{itemId}/components" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Set components

/api/v1/composite-items/{itemId}/components

Scope: Scalar360.composite-items.UPDATE

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

Body field	Type	Required	Notes
`components`	array of object
`components[].componentItemId`	string (uuid)
`components[].quantity`	number	Yes	required

Example request

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

POST

Disassemble

/api/v1/composite-items/{itemId}/disassemble

Scope: Scalar360.composite-items.CREATE

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

Body field	Type	Required	Notes
`warehouseId`	string (uuid)
`quantity`	number	Yes	required

Example request

curl -X POST "https://api.scalar360.com/api/v1/composite-items/{itemId}/disassemble" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"quantity":100}'