GET v1/Stock?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Stock Units.

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	A comma-separated list of field names	string	None.
where	A where clause	string	None.
order	An order by clause	string	None.
page	The page number (default: 1)	integer	Default value is 1
rows	Rows per page (default: 50, maximum: 250)	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of StockUnit

Name	Description	Type	Additional information
ProductId	The unique Cin7 product Id.	integer	None.
ProductOptionId	The Product Option Id	integer	None.
ModifiedDate	Last Transaction Date	date	None.
StyleCode	The style code.	string	None.
Code	The unique code i.e. SKU	string	None.
Barcode	Barcode i.e. UPC	string	None.
BranchId	The unique Cin7 branch Id.	integer	None.
BranchName	The branch name.	string	None.
ProductName	The product name	string	None.
Option1	Product option 1 (example: Red)	string	Max length: 50
Option2	Product option 2 (example: XL)	string	Max length: 50
Option3	Product option 3 (example: Cotton)	string	Max length: 50
Size	Size (mainly for clothing when color size grid module is used)	string	None.
Available	Available to Sell (StockOnHand - OpenSales)	decimal number	None.
StockOnHand	The stock on hand (SOH)	decimal number	None.
OpenSales	The open sales quantity i.e. The number of stock items on order.	decimal number	None.
Incoming	Inbound purchase order quantity	decimal number	None.
Virtual	Virtual stock for Kit products, zero for non-kit products	decimal number	None.
Holding	Holding stock.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "productId": 1,
    "productOptionId": 0,
    "modifiedDate": "2025-11-25T17:07:00.4634181+13:00",
    "styleCode": "StyleCode123",
    "code": "ABC123",
    "barcode": "123456789012",
    "branchId": 1,
    "branchName": "Main Branch",
    "productName": "T-Shirt",
    "option1": "Red",
    "option2": null,
    "option3": null,
    "size": "XXL",
    "available": 2.0,
    "stockOnHand": 9.0,
    "openSales": 7.0,
    "incoming": 8.0,
    "virtual": 0.0,
    "holding": 0.0
  }
]