Stock

Get a list of Stock Units.

get/api/v1/Stock

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/Stock
  • Auth: none declared

Query parameters

fieldsstring

A comma-separated list of field names

wherestring

A where clause

orderstring

An order by clause

pageinteger

The page number (default: 1)

rowsinteger

Rows per page (default: 50, maximum: 250)

Response

OK

productIdinteger

The unique Cin7 product Id.

productOptionIdinteger

The Product Option Id

modifiedDatestring date-time nullable

Last Transaction Date

styleCodestring nullable

The style code.

codestring nullable

The unique code i.e. SKU

barcodestring nullable

Barcode i.e. UPC

branchIdinteger

The unique Cin7 branch Id.

branchNamestring nullable

The branch name.

productNamestring nullable

The product name

option1string nullable

Product option 1 (example: Red)

option2string nullable

Product option 2 (example: XL)

option3string nullable

Product option 3 (example: Cotton)

sizestring nullable

Size (mainly for clothing when color size grid module is used)

availablenumber double

Available to Sell (StockOnHand - OpenSales)

stockOnHandnumber double

The stock on hand (SOH)

openSalesnumber double

The open sales quantity i.e. The number of stock items on order.

incomingnumber double

Inbound purchase order quantity

virtualnumber double

Virtual stock for Kit products, zero for non-kit products

holdingnumber double

Holding stock.

Changes

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