GET v1/Stock?barcode={barcode}
Get a Stock Unit.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
barcode |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of StockUnitName | 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
[ { "productId": 1, "productOptionId": 0, "modifiedDate": "2024-11-17T02:41:56.1794562+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 } ]