shipping
tracking

List all trackings

Changed on
get/shipping/{connection_id}/tracking

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/shipping/{connection_id}/tracking
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

order_idstring

The AccountingOrder ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this tracking object

created_atstring date-time

The date that this tracking object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this tracking object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

shipment_idstring

Reference to the shipment

tracking_numberstring

Tracking number for the shipment

status'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED'

Current status of the shipment

estimated_deliverystring date-time

Estimated delivery date

actual_delivery_atstring date-time

Actual delivery timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status_descriptionstring

Human-readable status

carrier_idstring

Reference to the carrier

carrier_status_codestring

Carrier's status code

carrier_status_descriptionstring

Carrier's status description

rawobject

The raw data returned by the integration for this tracking

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status