Shipments

The Shipments resource describes one or more shipments in a fulfillment order.

Returns a list of shipments

get

Get all shipments

Query parameters

endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

Responses

200

200 OK

application/json

hasMorebooleanOptional

Indicates whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

/shipments

HTTPcURLJavaScriptPython

GET /shipments HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "29016544906",
      "createdTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "fulfillmentOrderId": "5774321009",
      "fulfillmentOrderUpstreamId": "text",
      "shippingChoiceId": "SG",
      "trackingCompanyId": "0001",
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "items": [
        {
          "id": "8760948870",
          "fulfillmentOrderItemId": "650398674428",
          "fulfillmentOrderItemUpstreamId": "650398674428",
          "inventoryItemId": "text",
          "partNumber": "SWG1224J10L",
          "quantity": 1,
          "trackingUrls": [
            {
              "trackingNumber": ".",
              "trackingUrl": "."
            }
          ],
          "unitAttributes": [
            {
              "serialNumber": ".",
              "imeiNumber": ".",
              "simCardNumber": "."
            }
          ]
        }
      ],
      "liveMode": false
    }
  ]
}

Gets a shipment by ID.

get

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

Path parameters

idstringRequired

Shipment identifier.

Responses

200

OK.

application/json

idstringRead-onlyOptional

The unique identifier of a shipment.

Example: 29016544906

createdTimestring · date-timeRead-onlyOptional

Time when the shipment was created.

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2018,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"WEDNESDAY","dayOfYear":115,"month":"APRIL"}

fulfillmentOrderIdstringOptional

The identifier of the fulfillment order.

Example: 5774321009

fulfillmentOrderUpstreamIdstringOptional

The upstream identifier of the fulfillment order.

shippingChoiceIdstringRead-onlyOptional

The shipping method.

Example: SG

trackingCompanyIdstring · nullableRead-onlyOptional

The unique identifier of the tracking or carrier company.

Example: 0001

trackingCompanystringOptional

The name of the tracking or carrier company.

Example: Fedex

trackingNumberstringOptional

The tracking number provided by the carrier company.

Example: 5678901234

trackingUrlstringOptional

The URL of the fulfillment tracking page.

Example: http://www.digitalriver.com?code=5678901234

liveModebooleanOptional

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

Example: false

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

404 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

/shipments/{id}

HTTPcURLJavaScriptPython

GET /shipments/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "29016544906",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "fulfillmentOrderId": "5774321009",
  "fulfillmentOrderUpstreamId": "text",
  "shippingChoiceId": "SG",
  "trackingCompanyId": "0001",
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "items": [
    {
      "id": "8760948870",
      "fulfillmentOrderItemId": "650398674428",
      "fulfillmentOrderItemUpstreamId": "650398674428",
      "inventoryItemId": "text",
      "partNumber": "SWG1224J10L",
      "quantity": 1,
      "trackingUrls": [
        {
          "trackingNumber": ".",
          "trackingUrl": "."
        }
      ],
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ],
  "liveMode": false
}