Shipments
The Shipments resource describes one or more shipments in a fulfillment order.
Get all shipments
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.
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.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
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
}
]
}Retrieves the details of a shipment. You must supply the unique identifier of the shipment.
Shipment identifier.
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
}Last updated