Merchant API
List Cart Inventory
Returns last known inventory levels for a specific cart. This is cached data that can be used to determine which SKUs exist for a given order source as well as what products and inventory levels the order source last reported (Generally refreshed every 4 hours). It may not be available for all carts at all times. Use the List Inventory endpoint to see what products and inventory CartRover actually has on file for the merchant.
Notices:
- This endpoint contains cart specific data which may differ depending on the cart connected.
- There may be multiple results for a single SKU if the cart allows for it and has set up multiple/different products with the same SKU.
Note: Any filters should be passed with the URL as GET arguments.
Filters
| Argument | Description |
|---|---|
| limit | Number of products to return at once. Default 20, max 100 |
| page | Page of results to return. Default 1 |
Array Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| sku | String | 45 | |
| product_id | String | The internal ID of the main product from the cart. You shouldn't need this. | |
| product_variant_id | String | If this item has variants, this identifies this specific variant. You shouldn't need this. | |
| product_type | String | physical, virtual | |
| site_inventory_enabled | Boolean | Will return false if we detect the cart is not tracking inventory levels for this product, or doesn't care about them. | |
| last_cart_inventory | Int | Last inventory level pulled from or pushed to the cart. This is almost always the quantity Available. But for some carts this will be the quantity On Hand. | |
| date_checked | Timestamp | Time this record was last confirmed/verified. |
Response Headers
| Field | Description |
|---|---|
| Total-Records | Contains the total number of records that would have been returned if there was no limit. |
get/v1/cart/inventory/{ORDER_SOURCE}
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ORDER_SOURCEstring required
Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.