Merchant API

List Inventory

Returns inventory levels for all products from the warehouse. <br/><br/> Note: Any filters should be passed with the URL as GET arguments.

Argument	Description
from_date	Optional Timestamp. Filters by the warehouse loaded_datetime, returning inventory updates loaded in CartRover after the timestamp.
to_date	Optional Timestamp. Filters by the warehouse loaded_datetime, returning inventory updates loaded in CartRover before the timestamp. The from_date parameter must be included.
limit	Number of products to return at once. Default 20, max 100
page	Page of results to return. Default 1
include_aliases	N, Y, or ALL. Default N If Y, aliases will be returned as key-value pairs. If ALL, a numeric list will be returned, each containing: code_type, code

Field	Data Type	Length	Description
sku	String	45
qty_available	Int		Total quantity available. Can be negative if item is backordered.
qty_on_hand	Int		Total quantity on hand. Available plus committed or on hold.
wms_datetime	Timestamp		Time warehouse last verified qty
aliases	Array		List of aliases for this product. Only if include_aliases param is passed.
warehouses	Array		Breakdown of inventory by warehouse

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
loaded_datetime	Timestamp		Time CartRover received this quantity from the WMS
wms_datetime	Timestamp		Time warehouse last verified qty

Field	Description
Total-Records	Contains the total number of records that would have been returned if there was no limit.

get/v1/merchant/inventory

Request

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

object required

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