Merchant API
Update Inventory
Updates the inventory levels for products in CartRover. Inventory levels will be pushed to the Order Sources based on each cart's settings. CartRover will keep track of sales between the time you make this call and when the inventory is pushed to the shopping cart. If you pass a SKU that does not exist for the merchant in CartRover, it will be created dynamically and synced to any carts which have a matching SKU.
Note: There is an API call limit of 100 products per call.
Request
Array Request Fields
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| sku | String | 45 | Y | Unique product SKU |
| qty_available | Int | Y | Available Quantity | |
| qty_on_hand | Int | N | On Hand Quantity. Generally not used. | |
| wms_datetime | Timestamp | N | Defaults to NOW if not specified. This should be the exact time the WMS verified the quantity. Timestamp will be used for sales calculations. | |
| wms_product_id | String | 45 | N | Product ID of this product in WMS system. |
| description | String | 150 | N | Only loaded if product is brand new. Ignored during update. |
| warehouse_pk | Int | N | Optionally specify which warehouse to load inventory into. If none provided, inventory will be loaded into default warehouse. You can get a list of available warehouses here: List Warehouses: /merchant/warehouse/list | |
| wms_warehouse_id | String | N | Optionally specify which warehouse to load inventory into using the wms_warehouse_id field. This value is set by your WMS. Ignored if warehouse_pk is provided. | |
| wms_warehouse_name | String | N | Optionally specify which warehouse to load inventory into using the wms_warehouse_name field. This value is set by your WMS. Ignored if warehouse_pk is provided. |
Response
Array Response Fields
| Field Name | Data Type | Length | Description |
|---|---|---|---|
| products | Array | detailed API response of each product |
Orders Array Fields
| Field Name | Data Type | Length | Description |
|---|---|---|---|
| sku | String | 45 | Unique product SKU |
| success | Boolean | Was product inventory successfully updated | |
| qty_available | Int | New Available Quantity | |
| message | String | Message if product update failed |
post/v1/merchant/inventory/update
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Content-Typestring
Request body */*
string required
Example request
"\"[\\n {\\n \\\"sku\\\": \\\"CIO-1001\\\",\\n \\\"qty_available\\\": \\\"11\\\",\\n \\\"qty_on_hand\\\": \\\"15\\\"\\n },\\n {\\n \\\"sku\\\": \\\"CIO-1002\\\",\\n \\\"qty_available\\\": \\\"22\\\",\\n \\\"qty_on_hand\\\": \\\"20\\\",\\n \\\"wms_datetime\\\": \\\"2016-08-27T02:24:58+00:00\\\"\\n },\\n {\\n \\\"sku\\\": \\\"CIO-1003\\\",\\n \\\"qty_available\\\": \\\"33\\\",\\n \\\"qty_on_hand\\\": \\\"30\\\",\\n \\\"wms_datetime\\\": \\\"2016-08-27T02:24:58+00:00\\\"\\n },\\n {\\n \\\"sku\\\": \\\"CIO-1004\\\"\\n }\\n]\""Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.