Shipments
A Shipment represents a successful fulfillment of one or more Order Line Items.
Relationships
- Order • Shipments belong to Orders.
- Shipment Lines • Shipments can have many Shipment Lines
Operations
Click on an Operation to view requirements, options, & examples.
GET | /v1/retailers/{retailer_id}/shipments/ | Get a list of shipments |
---|---|---|
GET | /v1/retailers/{retailer_id}/shipments/{id}/ | Get a single shipment |
PUT | /v1/retailers/{retailer_id}/shipments/{id}/acknowledge/ | Acknowledge receipt |
Shipment Properties
id | Static identifier for the Shipment assigned by RevCascade. Should be used as {id} in other Shipment API endpoints. |
---|---|
order_id | The RevCascade order id that owns this shipment. |
purchase_order_number | The purchase order that owns this shipment. |
ordered_at | Timestamp (in UTC) when the order was placed by consumer. |
shipping_account | The Shipping account billed for the shipment. |
shipping_method |
The shipping method that was used for the shipment. "shipping_method": { "id": 1, "name": "FedEx Ground", "code": "FEDEX_GROUND", "type": "small_parcel", "carrier": { "id": 1, "name": "FedEx", "code": "FDEG" } } |
ship_from |
The shipment origin address printed on the label. "ship_from": { "type": null, "name1": "Manchester", "name2": null, "street1": "1522 Manchester Rd", "street2": null, "city": "West Carrollton", "province": "OH", "postal_code": "45458", "country": "US", "phone1": null, "phone2": null, "fax": null, "email": null } |
ship_weight | The total weight of the carton (in pounds). |
ship_width | The width of the carton (in inches). |
ship_length | The length of the carton (in inches). |
ship_height | The height of the carton (in inches). |
ship_girth | The girth of the package calculated using (d1+d2)*2 + d3 where d1 & d2 are the shortest dimensions. (in inches) |
ship_volume | The volume of the package (in cubic inches). |
batch_number | An identifier that groups a set of shipments together. |
label_reference | 30 character string that may be added to shipping label by the supplier. |
tracking_number | The tracking number of the shipment supplied by the carrier. |
tracking |
Critical tracking events from the carrier. "tracking": { "picked_up_at": "2016-07-25T19:19:45Z", "delivered_at": null } When available, both values will be ISO-8601 timestamps (in UTC). |
shipped_at | ISO-8601 Timestamp (in UTC) capturing the time the shipment was generated. The value will be null until a tracking number is supplied and/or generated by supplier. |
picked_up_at | ISO-8601 Timestamp (in UTC) capturing the time the shipment picked up by the carrier. Will be null until the shipment is picked up. |
delivered_at | ISO-8601 Timestamp (in UTC) capturing the time the shipment was delivered to the consumer. Will be null until the shipment is delivered. |
status | The status of a shipment. Either "open" when no tracking number is present or "closed" when a tracking number is present. |
is_acknowledged | Boolean flag that indicates whether the retailer has received and processed this shipment. |
shipment_lines |
An array of Shipment Line Items attached to the Shipment. { "id": "10000", "order_line_number": 1, "variant": { "id": "100084", "name": "X60 Bench, Espresso Brown" "identifier": "GTT123453", "upc": "123456789456", } "quantity": 1, } id - static id assigned by RevCascade. variant - The exact item that was shipped. quantity - The number of items included in the carton. |
Examples
GET | /v1/retailers/shipments/ | Get a list of shipments. |
---|
Optional Query String Parameters | |
is_acknowledged |
Boolean filter that returns shipments based on whether or not they have been processed
by the retailer.
1 - show only only shipments that have been acknowledged. 0 - show shipments that have not been acknowledged. |
---|---|
is_picked_up |
Boolean filter that returns shipments based on whether or not they have been picked
up by the carrier.
1 - show only only shipments that have been picked up. 0 - show shipments that are awaiting pickup. |
shipped_at_{operator} |
Show only items that have been shipped since an epoch timestamp in UTC.
Please substitute {operator} with "lt" (less than),"lte" (less than or equal), "gt" (greater than), or "gte" (greater than or equal). |
limit | Customize the number of results return (max 250). |
Get all "new" shipments. GET https://api.revcascade.com/v1/retailers/500/shipments/?is_acknowledged=0 |
GET | /v1/retailers/shipments/{id}/ | Get a single shipment. |
---|
Get a single shipment using the RevCascade shipment id. GET https://api.revcascade.com/v1/retailers/500/shipments/10065/ |
PUT | /v1/retailers/{retailer_id}/shipments/{id}/acknowledge/ | Acknowledge receipt |
---|
Acknowledge receipt of a new shipment. GET https://api.revcascade.com/v1/retailers/500/shipments/123645/acknowledge/ |