API ReferenceReceiving

Update box tracking for a Warehouse Receiving Order

View as Markdown

Updates tracking numbers on the listed boxes and stamps the carrier onto them; boxes not listed are left unchanged. Tracking numbers must be unique across all boxes of the order. Not available when ShipBob shipping labels were purchased for the order — the purchased labels determine the tracking numbers.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

idintegerRequired
Id of the receiving order

Request

The tracking update to apply
boxeslist of objectsRequired
Boxes to update, addressed by box number.
vendor_carrier_namestringRequired1-450 characters

Carrier delivering the listed boxes, from the ShipBob vendor-carrier list, or the literal “Other” with the carrier name supplied in other_carrier_name.

other_carrier_namestring or nullOptional<=50 characters

Free-text carrier name (max 50 characters); required when vendor_carrier_name is “Other”, not valid otherwise.

Response

Success
boxeslist of objectsOptional
Tracking state of every box on the order
idintegerOptional
Id of the receiving order

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error