Get All Order Shipments

Returns all shipments recorded against an order.

get

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Path parameters

order_idintegerRequired

Order Desk's internal order ID. This is not your source_id.

Example: 736745

Responses

200

The order's shipments.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

total_recordsintegerOptionalExample: 1

idintegerRead-onlyOptionalExample: 44821

order_idintegerRead-onlyOptionalExample: 925086

store_idintegerRead-onlyOptionalExample: 11

tracking_numberstringOptional

Carrier-assigned tracking number. Use n/a if no tracking number is applicable.

Example: 1Z999AA10123456784

carrier_codestringOptional

Carrier code such as USPS or FedEx, when available.

Example: UPS

shipment_methodstringOptional

Shipping service name, such as First Class International.

Example: UPS Ground

weightnumber · doubleOptional

Final shipment weight.

Example: 2.4

costnumber · doubleOptional

Your cost to send the shipment.

Example: 9.5

statusstringOptional

Current shipment status, used by the EasyPost webhook.

tracking_urlstringOptional

If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.

label_formatstringRead-onlyOptional

Format of the stored label, when one exists.

label_imagestringRead-onlyOptional

Stored shipping label, when one exists.

print_statusstringRead-onlyOptional

Whether the label has been printed.

cart_shipment_idstringRead-onlyOptional

Shipment ID in the originating cart, when known.

label_shipment_idstringRead-onlyOptional

Shipment ID at the label provider, when known.

Other propertiesanyOptional

date_shippedstringOptional

Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.

Example: 2019-01-15 12:12:10

date_addedstringOptional

Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.

Example: 2019-01-15 12:12:10

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

404

No record matches that ID in your store.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

get/orders/{order_id}/shipments

curl "https://app.orderdesk.me/api/v2/orders/736745/shipments" \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

{
  "status": "success",
  "message": "text",
  "execution_time": "0.1524 seconds",
  "total_records": 1,
  "shipments": [
    {
      "id": 44821,
      "order_id": 925086,
      "store_id": 11,
      "tracking_number": "1Z999AA10123456784",
      "carrier_code": "UPS",
      "shipment_method": "UPS Ground",
      "weight": 2.4,
      "cost": 9.5,
      "status": "text",
      "tracking_url": "text",
      "label_format": "text",
      "label_image": "text",
      "print_status": "text",
      "cart_shipment_id": "text",
      "label_shipment_id": "text",
      "order_items": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "date_shipped": "2019-01-15 12:12:10",
      "date_added": "2019-01-15 12:12:10"
    }
  ]
}