API ReferenceOrders

Get Shipment Logs by Order ID and Shipment ID

View as Markdown
Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

orderIdintegerRequired
The order id to get the shipment for
shipmentIdintegerRequired
The shipment id to get

Response

Success
log_type_idintegerOptional
Log type id of the shipment
log_type_namestring or nullOptional
Name of the log type
log_type_textstring or nullOptional
Summary of log type meaning
metadatamap from strings to strings or nullOptional
Specifics data for the event
timestampdatetimeOptional
Timestamp of event

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error