Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Shipments

Gets a shipment by ID

Retrieves the details of a shipment. You must supply the unique identifier of the shipment.

get/shipments/{id}

Path parameters

idstring required

Shipment identifier.

Response

OK.

idstring

The unique identifier of a shipment.

createdTimestring date-time

Time when the shipment was created.

fulfillmentOrderIdstring

The identifier of the fulfillment order.

fulfillmentOrderUpstreamIdstring

The upstream identifier of the fulfillment order.

shippingChoiceIdstring

The shipping method.

trackingCompanyIdstring nullable

The unique identifier of the tracking or carrier company.

trackingCompanystring

The name of the tracking or carrier company.

trackingNumberstring

The tracking number provided by the carrier company.

trackingUrlstring

The URL of the fulfillment tracking page.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "id": "29016544906",
  "createdTime": "2018-04-25T20:36:00Z",
  "fulfillmentOrderId": "5774321009",
  "shippingChoiceId": "SG",
  "trackingCompanyId": "0001",
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "items": [
    {
      "id": "8760948870",
      "fulfillmentOrderItemId": "650398674428",
      "fulfillmentOrderItemUpstreamId": "650398674428",
      "partNumber": "SWG1224J10L",
      "quantity": 1,
      "trackingUrls": [
        {
          "trackingNumber": ".",
          "trackingUrl": "."
        }
      ],
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ]
}