API reference / Shipments

Shipments API

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

GET

List

/api/v1/shipments

Scope: Scalar360.shipments.READ

Example request

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

GET

Get

/api/v1/shipments/{id}

Scope: Scalar360.shipments.READ

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

Example request

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

PATCH

Update

/api/v1/shipments/{id}

Scope: Scalar360.shipments.UPDATE

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

Body field	Type	Required	Notes
`carrier`	string
`trackingNumber`	string
`shipDate`	string (date)
`notes`	string
`status`	string

Example request

curl -X PATCH "https://api.scalar360.com/api/v1/shipments/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"carrier":"string","trackingNumber":"string","shipDate":"2026-10-12","notes":"string","status":"string"}'

POST

Cancel

/api/v1/shipments/{id}/cancel

Scope: Scalar360.shipments.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/v1/shipments/{id}/cancel" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Delivery note

/api/v1/shipments/{id}/delivery-note

Scope: Scalar360.shipments.READ

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

Example request

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

POST

Push courier

/api/v1/shipments/{id}/push-courier

Scope: Scalar360.shipments.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/v1/shipments/{id}/push-courier" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Sync tracking

/api/v1/shipments/{id}/sync-tracking

Scope: Scalar360.shipments.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/v1/shipments/{id}/sync-tracking" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Delivery note preview

/api/v1/shipments/delivery-note/preview-pdf

Scope: Scalar360.shipments.CREATE

Body field	Type	Required	Notes
`gid`	string (uuid)
`name`	string	Yes	required
`legalName`	string
`gstin`	string
`pan`	string
`email`	string
`phone`	string
`address`	string
`state`	string
`pin`	string
`bankAccountNo`	string
`bankName`	string
`bankIfsc`	string
`bankAddress`	string
`financialYearStart`	string
`taxPreference`	string
`logoUrl`	string
`accentColor`	string
`invoiceFooter`	string
`invoiceTemplate`	string
`deliveryNoteTemplate`	string
`deliveryNoteFooter`	string
`deliveryNoteAccent`	string
`deliveryNoteLogoUrl`	string
`deliveryProvider`	string
`deliveryApiUrl`	string
`deliveryApiKey`	string
`deliveryApiEnabled`	boolean
`deliveryApiConfig`	string
`payslipTemplate`	string
`payslipNote`	string
`termsAndConditions`	string
`invoiceLayoutConfig`	string
`status`	string
`timezone`	string
`booksLockedUntil`	string (date)
`booksLockedByUserId`	integer
`booksLockedAt`	string (date-time)
`openingBalanceDate`	string (date)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Example request

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