Long Description
Gives a query-able list of shipments for a brokerages. All shipments are scoped to the office that the POS user is assigned to. Currently, this endpoint is only supported by the POS.
Parameters
Name | Description | Value Type | Required |
|---|---|---|---|
| type | Type of the shipment (e.g. Delivery::FedEx) | String | Optional |
| state | State of the shipment (e.g. delivered, in_transit) | String | Optional |
| order_group_id | The Order Group the shipment belongs to | Integer | Optional |
| order_link_id | The Order Link for the brokerage | Integer | Optional |
| tracking_number | The tracking for the shipment | String | Optional |
| ship_to_name | The name of the shipment recipient | String | Optional |
| ship_from_name | The name of the shipment sender | String | Optional |
| first_event_occurs_at | The ISO-8601 date (e.g. 2013-01-01) for when the first event occurs. Can also be refined with a range (e.g. first_event_occurs_at.gt, first_event_occurs_at.gte first_event_occurs_at.lt, first_event_occurs_at.lte) | String | Optional |
| order_by | The column to order results by. Only columns that are filterable can also be order-able. | String | Optional |
| order_direction | The way results should be ordered (e.g. asc, desc) | String | Optional |
Examples
| Request | Response |
|---|---|
| /v9/shipments/status?first_event_occurs_at.gte=2013-04-10&first_event_occurs_at.lte=2013-04-12&order_by=id&order_direction=desc | |
Paste in Request Code | {
"shipments":[
{
"ship_to_name":"Patrick Boston",
"order_group_id":22173,
"id":38715,
"type":"Delivery::FedEx",
"tracking_number":"799435511652",
"order_link_id":95430,
"ship_from_name":null,
"state":"in_transit",
"office_id":50,
"first_event_occurs_at":"2013-04-10T19:00:00Z"
},
{
"ship_to_name":"Thomas Przestwor",
"order_group_id":22036,
"id":38577,
"type":"Delivery::FedEx",
"tracking_number":"799435479185",
"order_link_id":95155,
"ship_from_name":null,
"state":"in_transit",
"office_id":50,
"first_event_occurs_at":"2013-04-10T20:00:00Z"
},
{
"ship_to_name":"Owyn Stephens",
"order_group_id":21840,
"id":38380,
"type":"Delivery::FedEx",
"tracking_number":"799439801975",
"order_link_id":94751,
"ship_from_name":null,
"state":"in_transit",
"office_id":50,
"first_event_occurs_at":"2013-04-11T19:10:00Z"
}
]
}
|