Inventory
RevCascade asks vendors 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. |
Inventory Properties
| Name | Description |
|---|---|
|
variant object |
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 vendor's identifier. However, if RevCascade has mapped retailer identifiers during onboarding, then we will return the retailer identifier. |
|
sellable boolean |
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 ISO-8601 Datetime |
The timestamp when the inventory value was last updated. |
|
inventory integer (11) |
The amount of inventory available. |
|
inventory_updated_at ISO-8601 Datetime |
The date & time when the inventory value was last updated by the brand or by RevCascade. Please note that when RevCascade receives an order we automatically decrement inventory and update this timestamp. |
|
brand_inventory_updated_at ISO-8601 Datetime |
The date & time when the inventory value was last submitted by the brand. |
|
estimated_availability ISO-8601 Datetime may be null |
The date & time when the item is estimated by the vendor to return to stock. Generally, RevCascade asks vendors to provide an availability date if inventory reaches 0, but not all vendors have this capability. The value will be null if the return date is not provided by the brand. |
|
is_stale boolean beta |
Boolean flag that indicates whether the item has been updated within the connection-level SLA. |
|
discontinued boolean beta |
Boolean flag that indicates the item has been discontinued. |
|
discontinued_at ISO-8601 Datetime beta |
The date & time the item was discontinued. |
|
locations array |
Array of vendor warehouses with current inventory levels at each warehouse. May be disregarded for most use cases. |
Operation Details & Examples
| GET | /v1/retailers/inventory/ | Get inventory for all permitted items. |
|---|
| Optional Query String Parameters | |
|
brand_id integer (11) |
Filter inventory by a single vendors's brand_id. |
|
connection_id integer (11) |
Filter inventory based on a connection_id. In general, vendors and retailers share only a single connection, but it is possible to have multiple connections with a single vendor. |
|
updated_at_{operator} timestamp |
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} timestamp |
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 integer (3) |
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 |
|
| 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/ |