Merchant API

Get Product Inventory

Returns inventory levels for the specified product from the warehouse.

Response Fields

Field	Data Type	Length	Description
sku	String	45
qty_available	Int		Can be negative if item is backordered
qty_on_hand	Int
wms_datetime	Timestamp		Time warehouse last verified qty
warehouses	Array		Breakdown of inventory by warehouse

The qty_available inventory levels of each warehouse entry when added together may not match the summary qty_available field. This is because recent sales for each location cannot be subtracted from available quantity for a specific location if CartRover does not know how they will route. The summary inventory level will always be accurate.

Warehouse Fields

Field	Data Type	Length	Description
warehouse	String	100	Warehouse name as setup in CartRover
qty_available	Int		Quantity for just this warehouse
qty_on_hand	Int		Quantity for just this warehouse
wms_datetime	Timestamp		Time warehouse last verified qty

get/v1/merchant/inventory/{SKU}

Request

Base URL
http://{{base_url}}
Auth
HTTP basic
TypeScript
https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/docs/v1/merchant/inventory/:SKU/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

SKUstring required

Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.