shipping
shipment

Retrieve a shipment

Changed on

Retrieves a single ShippingShipment by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/shipping/{connection_id}/shipment/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Shipment

Query parameters

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 shipment object

created_atstring date-time

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

updated_atstring date-time

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

order_idstring

Reference to commerce_order or accounting_order

organization_idstring

ref -> accounting Organization this shipment belongs to (multi-company ERPs)

carrier_idstring

Reference to the carrier

service_codestring

Code for the shipping service used

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

rate_idstring

Optional reference to the selected rate (for traceability)

label_idstring

Optional reference to the shipping label

tracking_idstring

Optional reference to the tracking information

shipped_atstring date-time

When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rate_amountnumber

The rate amount used (may differ from shipping_cost due to adjustments)

rate_currencystring

Currency for rate_amount

rate_service_namestring

Service name from the rate (e.g., "Priority Mail")

rate_estimated_daysnumber

Estimated delivery days from the rate

rate_estimated_delivery_atstring date-time

Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_rate_guaranteedboolean

Whether delivery is guaranteed (from rate)

return_authorization_numberstring

RMA number if return shipment

warehouse_location_idstring

Origin warehouselocation ID; points to CommerceLocation

warehouse_location_namestring

Origin warehouse location name

is_internationalboolean

Whether shipment is international

special_instructionsstring[]

Array of special instructions

is_signature_requiredboolean

Signature required on delivery

is_adult_signature_requiredboolean

Adult signature required

reference_numberstring

Customer reference number

is_returnboolean

Whether this is a return shipment

original_shipment_idstring

Reference to original shipment if return; points to ShippingShipment

return_reasonstring

Reason for return

return_type'CUSTOMER' | 'VENDOR' | 'WARRANTY' | 'DEFECTIVE' | 'OTHER'

Type of return

carrier_namestring

Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)

tracking_urlstring

Carrier tracking URL for this shipment

rawobject

The raw data returned by the integration for this shipment

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

  • 8903b6e34197Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status