Track schemas

This section contains the schemas for the Track API.

Response schema for 200

Name	Type	Required	Description
tracking_number	string	false	Tracking number of the Order
tracking_url	string	false	URL presenting tracking info for the Order. This can be shown to the recipient to give them status updates on the Order.
success	boolean	false	Whether or not this tracking request was successful - should always be true as tracking errors are returned at the top-level response.
error	string	false	Errors associated with the tracking request - should always be null as tracking errors are returned at the top-level response.
track	array, see table	false	A list of historical tracking statuses for the Order. At minimum, this lists the order status, along with the date and time when it changed, and who was responsible for the status change.

Response schema for track

Name	Type	Required	Description
date	string(date)	true	The ISO-8601 date as YYYY-MM-DD when the event happened.
status_owner	string	true	The party responsible for the status change.
timestamp	string	true	The time in HH:MM:SS that the tracking event happened.
status	string	true	The status of the order

Response schema for 400

Name	Type	Required	Description
error	object	true	A Hash of error codes returned by tracking response. Each error code is returned as a key, with an array of strings for each instance of the error.
order_id	array	true	Indicates an order that cannot be found.
success	boolean	false	Returns false
error_description	string	false	Human-readable description of error encountered.