Inventory
RevCascade asks Suppliers to update stock levels for all items at least once per day. Inventory levels are then made available to Retailers on demand through the Inventory API.
Operations
Click on an Operation to view requirements, options, & examples.
| GET | /v1/retailers/{retailer_id}/inventory/ | Get inventory for all permitted items. |
|---|---|---|
| GET | /v1/retailers/{retailer_id}/inventory/{id}/ | Get inventory for a single item. |
Data Fields
| variant |
An item you are permitted to list for sale. {
"id": 1000,
"name": "Outdoor Bench",
"identifier": 15123613,
"upc": "1234567892123"
}
Please Note: By default, the identifier returned will be the supplier's identifier. However, if RevCascade has mapped retailer identifiers during onboarding, then we will return the retailer identifier. |
|---|---|
| sellable | Boolean flag for whether or not a retailer should list an item for sale. Items may be flagged as unsellable for a variety of reasons that may or may not coincide with inventory levels reaching 0. The sellable flag should always be respected above actual inventory levels. |
| sellable_updated_at | The timestamp when the inventory value was last updated. |
| inventory | The amount of inventory available. |
| inventory_updated_at | The timestamp when the inventory value was last updated (by the brand or by RevCascade). |
| brand_inventory_updated_at | The timestamp when the inventory value was last updated by the brand. |
| estimated_availability | The timestamp when the item is estimated by Supplier to return to stock. Generally, RevCascade asks suppliers to supply an availability date if the inventory is 0, but not all suppliers have this capability. The value will be null if no date is known. |
| locations (optional) | Array of Supplier warehouses with current inventory at each warehouse. May be disregarded for most use cases. |
Examples
| GET | /v1/retailers/inventory/ | Get inventory for all permitted items. |
|---|
| Optional Query String Parameters | |
| brand_id | Filter inventory by a single supplier's brand_id. |
|---|---|
| connection_id | Filter inventory based on a connection_id. In general, suppliers and retailers share only a single connection, but it is possible to have multiple connections with a single supplier. |
| inventory_updated_at_{operator} |
Show only items with inventory updated 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). |
| brand_inventory_updated_at_{operator} |
Show only items that only the brand has updated 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 current inventory for all permitted items. GET https://api.revcascade.com/v1/retailers/500/inventory/ |
|
|
Get current inventory for permitted items that were updated between two timestamps. GET https://api.revcascade.com/v1/retailers/500/inventory/?updated_at_gte=1461675600&updated_at_lte=1461704400 |
|
| GET | /v1/retailers/inventory/{id}/ | Get inventory for a single item. |
|---|
|
Get current inventory for a single permitted item using RevCascade Item ID. GET https://api.revcascade.com/v1/retailers/500/inventory/10065/ |
