f21981db32be
Returns a list of shipments
Get all shipments
Query parameters
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
- eq—return values where the createdTime field equals to this timestamp
- gt—return values where the createdTime field is after this timestamp
- gte—return values where the createdTime field is after or equal to this timestamp
- lt—return values where the createdTime field is before this timestamp
- lte—return values where the createdTime field is before or equal to this timestamp
A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
- eq—return values where the updatedTime field equals this timestamp
- gt—return values where the updatedTime field is after this timestamp
- gte—return values where the updatedTime field is after or equal to this timestamp
- lt—return values where the updatedTime field is before this timestamp
- lte—return values where the updatedTime field is before or equal to this timestamp
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.
Response
200 OK
Example response
{
"hasMore": true,
"data": [
{
"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": "."
}
]
}
]
}
]
}