Orders
An Order represents a Consumer's request to purchase one or more items from a Retailer. After the Consumer completes the checkout process, participating Retailers will submit Orders to RevCascade. Once received and validated by RevCascade, Orders may be accessed by Suppliers for fulfillment.
Relationships
- Retailer • Orders belong to Retailers.
- Order Lines • Orders can have many Order Lines.
- Shipping Method • Orders have an expected shipping method (see requested_shipping_method).
- Shipping Accounts • Orders can have many Shipping Accounts.
Operations (Click on an Operation to view requirements, options, & examples)
| GET | /v1/brands/{brand_id}/orders/ | Get a list of Orders |
|---|---|---|
| GET | /v1/brands/{brand_id}/orders/{id}/ | Get a single Order |
| PUT | /v1/brands/{brand_id}/orders/{id}/acknowledge/ | Acknowledge an Order |
| PUT | /v1/brands/{brand_id}/orders/{id}/close/ | Close an Order |
| PUT | /v1/brands/{brand_id}/orders/{id}/reopen/ | Re-open an Order |
Fields
| id | A static id assigned by RevCascade. Can be used as the primary key in the url of other Order endpoints. |
|---|---|
| retailer_order_number | Order Number assigned by the Retailer. |
| retailer |
The Retailer that accepted the order. {
"id": "1083",
"name": "Wayfair"
...
}
id: RevCascade's static identifier for the Retailer. name: The name of the Retailer. |
| acknowledge_by | The date & time when the Order is expected to be acknowledged or canceled. This field is determined automatically by RevCascade based on the SLA set by the Retailer. |
| fulfill_by | The date & time when all Line Items on an Order are expected to be completely fulfilled. This field is determined automatically by RevCascade based on the SLA set by the Retailer. |
| ship_to_name1 | Destination name line #1. |
| ship_to_name2 (optional) | Destination name line #2. |
| ship_to_street1 | Destination street line #1. |
| ship_to_street2 (optional) | Destination street line #2. |
| ship_to_city | Destination city. |
| ship_to_province | Destination state or province. |
| ship_to_postal_code | Destination postal code. |
| ship_to_country | Two-Character Country Code (e.g. US) • Reference |
| ship_to_phone (optional) | Destination phone number. |
| requested_shipping_method |
The shipping service level requested by the consumer. {
"name": "Expedited",
"description": "Should arrive within 2-3 days after processing time."
}
|
| shipping_accounts |
An array of shipping accounts elligible for use with this Order. Shipping Accounts are configured per Connection. "shipping_accounts":[{
"id":1,
"nickname":"Demo Brand FedEx",
"owner_type":"brand",
"carrier":{
"id":1,
"name":"FedEx",
"code":"FDEG"
},
"shipping_methods":[{
"id":1,
"name":"FedEx Ground",
"code":"FEDEX_GROUND"
},{
"id":2,
"name":"FedEx 2 Day",
"code":"FEDEX_2_DAY"
}]
}]
|
| status |
The current status of the order: open - One or more line items are outstanding. closed - All line items and quantities have been fulfilled. canceled - The entire order was canceled. |
| is_acknowledged | Boolean flag that indicates whether the order has been Acknowledged by the Supplier. When a Supplier acknowledges an Order, that indicates to the Retailer that the Supplier intends to fulfill the Order. |
| ordered_at | The timestamp when the Order was placed by the Consumer. |
| acknowledged_at | The timestamp when the Order was acknowledged by the Supplier. This field is null if the Order has not been acknowledged. |
| closed_at | The timestamp when the Order was closed. This field is null if the Order has not been closed. |
| canceled_at | The timestamp when the Order was canceled. This field is null if the Order has not been canceled. |
| order_lines |
An array or Order Line Items attached to the Order. {
"id": "10000",
"variant": {
"id": "100084",
"name": "Contemporary Nightstand",
"brand_identifier": "1234",
"upc": "123456789456",
"size": "large",
"color": "brown",
...
},
"quantity": 1,
"quantity_shipped": 0,
"quantity_returned": 0,
"quantity_canceled": 0,
"price": "39.00",
"subtotal": "39.00",
"status": "open",
"canceled_at": null,
}
id - RevCascade's static identifier for the Order Line. variant - The exact item that was sold. quantity - The number of items ordered. quantity_shipped - Items that have shipped to date. quantity_returned - Items that have been fully returned to date. quantity_canceled - Items that have been canceled to date. price - The price the consumer was charged for the item(s). subtotal - The subtotal the consumer was charged for the item(s). status - The current status of the Line Item ("open","closed") |
Examples
| GET | /v1/brands/orders/ | Get a list of Orders |
|---|
| Optional Query String Parameters | |
| status | Show orders based on their current status ("open","closed" or "canceled"). |
|---|---|
| is_acknowledged |
Boolean filter that returns orders based on whether or not they have been acknowleged.
1 - show only only orders that have been acknowledged. 0 - show orders that have not been acknowledged. |
| ordered_at_{operator} |
Show orders placed before or after 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). |
| acknowledged_at_{operator} |
Show orders that were acknowledged before or after 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 Orders GET https://api.revcascade.com/v1/brands/500/orders/?is_acknowledged=0 |
|
|
Get all open Orders GET https://api.revcascade.com/v1/brands/500/orders/?status=open&is_acknowledged=1 |
|
| GET | /v1/brands/{brand_id}/orders/{id}/ | Get a single Order |
|---|
|
Get a single Order by its ID. GET https://api.revcascade.com/v1/brands/500/orders/100000/ |
| PUT | /v1/brands/{brand_id}/orders/{id}/acknowledge/ | Acknowledge an Order |
|---|
|
Acknowledge an Order. PUT https://api.revcascade.com/v1/brands/500/orders/100000/acknowledge/ |
| PUT | /v1/brands/{brand_id}/orders/{id}/close/ | Close an Order |
|---|
|
Close an Order. PUT https://api.revcascade.com/v1/brands/500/orders/100000/close/ |
| PUT | /v1/brands/{brand_id}/orders/{id}/reopen/ | Reopen an Order |
|---|
|
Reopen a closed Order PUT https://api.revcascade.com/v1/brands/500/orders/100000/reopen/ |
