Sign in
shipping
shipment

List all shipments

get/shipping/{connection_id}/shipment

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

carrier_idstring

The ShippingCarrier ID to filter by

org_idstring

The org 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
created_atstring date-time
updated_atstring date-time
order_idstring
organization_idstring
carrier_idstring
service_codestring
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'
rate_idstring
label_idstring
tracking_idstring
shipped_atstring date-time
rate_amountnumber
rate_currencystring
rate_service_namestring
rate_estimated_daysnumber
rate_estimated_delivery_atstring date-time
is_rate_guaranteedboolean
return_authorization_numberstring
warehouse_location_idstring
warehouse_location_namestring
is_internationalboolean
special_instructionsstring[]

Array of special instructions

is_signature_requiredboolean
is_adult_signature_requiredboolean
reference_numberstring
is_returnboolean
original_shipment_idstring
return_reasonstring
return_type'CUSTOMER' | 'VENDOR' | 'WARRANTY' | 'DEFECTIVE' | 'OTHER'
carrier_namestring
tracking_urlstring
rawobject

Changes

Changed in 1 of the 34 revisions of this API.9

  • 8903b6e341979See the full diff
    • ○

      added the new optional query request parameter org_id

      new-optional-request-parameter

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added