LogoLogo
System Status
2021-12-13
2021-12-13
  • 2021-12-13
  • Charges
    • Charge basics
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File Links
    • File link basics
  • Files
    • File basics
  • Fulfillments
  • Fulfillment cancellations
  • Fulfillment orders
  • Fulfillment returns
  • Inventory items
  • Inventory levels
  • Invoices
    • Invoice basics
  • Logistics returns
  • Orders
    • Order basics
  • Payouts
  • Plans
    • Plan basics
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping labels
  • Shipping quotes
  • SKUs
  • SKU Groups
  • Sources
  • Subscriptions
    • Subscription basics
  • Tax identifiers
  • Webhooks
  • Drop-in checkout links
  • Drop-in checkout sessions
    • Checkout-sessions basics
  • Drop-in shipping quotes
  • Store credit callout
Powered by GitBook
On this page

Shipments

PreviousSales transactionsNextShipping labels

Last updated 7 months ago

The Shipments resource is a pivotal component of the fulfillment process, providing detailed information about one or more shipments within a fulfillment order. It encompasses all the necessary details required to track and manage the delivery of goods, ensuring efficient coordination between ordering, packing, and transportation activities. This resource is essential for maintaining transparency and accuracy in the logistics workflow.

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
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
GET /shipments HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "id": "29016544906",
      "createdTime": "2018-04-25T20:36:00Z",
      "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
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
GET /shipments/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "id": "29016544906",
  "createdTime": "2018-04-25T20:36:00Z",
  "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
}
  • GETReturns a list of shipments
  • GETGets a shipment by ID