Get Shipments
GET/orders/:lookupKey/:lookupValue/shipments
Use this endpoint to retrieve a list of all order shipments.
Request
Path Parameters
lookupKey stringrequired
Use id
or externalId
lookupValue stringrequired
The id
or externalId
of the order
Responses
- 200
- 404
Get Shipments - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Shipments - 404
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 15001,
"messages": [
"Order with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}
{
"error": {
"code": 15001,
"messages": [
"Order with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}
Loading...