GET inventory/{product_id}?location={location}&session={session}&options={options}
Returns inventory for a specific product
Request
URL parameters
| Name | Description | Type | Additionnal Information | Intro version |
|---|---|---|---|---|
| product_id | Identifiant unique du produit | bigint | Required | |
| location | Warehouse | string | ||
| session | Session identification (must be unique for the active session) | string | Length between 0 and 100 | |
| options | Options for custom processing | string | Length between 0 and 100 |
Response
InventoryResult| Name | Description | Type | Additionnal Information | Intro version |
|---|---|---|---|---|
| product | Structure of quantities in inventory | Collection of InventoryProduct | ||
| token | Token of this result's last entry. This token can be passed the next time you call this API to get the rest of the modified data | string | ||
| count | Number of entries in this lot | integer | ||
| queuecount | Number of remaining prices to recover | integer | ||
| returncode | Return code: 0 for success | integer | ||
| returnmsg | Return message | string | ||
| warnings | Warnings (the instruction worked but you need to pay attention to warnings. May cause partial data loss (Truncation)) | Collection of string | ||
| version | API version | string |
Return format
application/json, text/json, application/x-www-form-urlencoded
Sample:
{
"product": [
{
"product_id": 1,
"intstatus": "sample string 2",
"inventory": [
{
"name": "sample string 1",
"description": "sample string 2",
"qty_onhand": 3.1,
"qty_reserved": 4.1,
"qty_avail": 5.1,
"qty_sec": 6.1,
"qty_onorder": 7.1,
"qty_lastrecp": 8.1,
"qry_nextrecp": 9.1,
"nextrecpinfos": {
"recp": [
{
"date": "2024-11-18",
"qty": "sample string 2"
},
{
"date": "2024-11-18",
"qty": "sample string 2"
}
]
},
"uom": "sample string 10",
"entrId": 11,
"divisionId": 12,
"parentDivisionId": 13,
"isDefaultEntrForDivision": 14,
"otherunits": {
"unit": [
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
},
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
}
]
}
},
{
"name": "sample string 1",
"description": "sample string 2",
"qty_onhand": 3.1,
"qty_reserved": 4.1,
"qty_avail": 5.1,
"qty_sec": 6.1,
"qty_onorder": 7.1,
"qty_lastrecp": 8.1,
"qry_nextrecp": 9.1,
"nextrecpinfos": {
"recp": [
{
"date": "2024-11-18",
"qty": "sample string 2"
},
{
"date": "2024-11-18",
"qty": "sample string 2"
}
]
},
"uom": "sample string 10",
"entrId": 11,
"divisionId": 12,
"parentDivisionId": 13,
"isDefaultEntrForDivision": 14,
"otherunits": {
"unit": [
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
},
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
}
]
}
}
]
},
{
"product_id": 1,
"intstatus": "sample string 2",
"inventory": [
{
"name": "sample string 1",
"description": "sample string 2",
"qty_onhand": 3.1,
"qty_reserved": 4.1,
"qty_avail": 5.1,
"qty_sec": 6.1,
"qty_onorder": 7.1,
"qty_lastrecp": 8.1,
"qry_nextrecp": 9.1,
"nextrecpinfos": {
"recp": [
{
"date": "2024-11-18",
"qty": "sample string 2"
},
{
"date": "2024-11-18",
"qty": "sample string 2"
}
]
},
"uom": "sample string 10",
"entrId": 11,
"divisionId": 12,
"parentDivisionId": 13,
"isDefaultEntrForDivision": 14,
"otherunits": {
"unit": [
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
},
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
}
]
}
},
{
"name": "sample string 1",
"description": "sample string 2",
"qty_onhand": 3.1,
"qty_reserved": 4.1,
"qty_avail": 5.1,
"qty_sec": 6.1,
"qty_onorder": 7.1,
"qty_lastrecp": 8.1,
"qry_nextrecp": 9.1,
"nextrecpinfos": {
"recp": [
{
"date": "2024-11-18",
"qty": "sample string 2"
},
{
"date": "2024-11-18",
"qty": "sample string 2"
}
]
},
"uom": "sample string 10",
"entrId": 11,
"divisionId": 12,
"parentDivisionId": 13,
"isDefaultEntrForDivision": 14,
"otherunits": {
"unit": [
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
},
{
"uom": "sample string 1",
"qty_onhand": 2.1,
"qty_reserved": 3.1,
"qty_avail": 4.1,
"qty_sec": 5.1,
"facteurconv": 6.1
}
]
}
}
]
}
],
"token": "sample string 1",
"count": 2,
"queuecount": 3,
"returncode": 4,
"returnmsg": "sample string 5",
"warnings": [
"sample string 1",
"sample string 2"
],
"version": "sample string 6"
}
application/xml, text/xml
Sample:
<result returncode="4" returnmsg="sample string 5" version="sample string 6" token="sample string 1" count="2" queuecount="3">
<warnings>sample string 1</warnings>
<warnings>sample string 2</warnings>
<product product_id="1" intstatus="sample string 2">
<inventory name="sample string 1" description="sample string 2" qty_onhand="3.1" qty_reserved="4.1" qty_avail="5.1" qty_sec="6.1" qty_onorder="7.1" qty_lastrecp="8.1" qry_nextrecp="9.1" uom="sample string 10" entrId="11" divisionId="12" parentDivisionId="13" isDefaultEntrForDivision="14">
<nextrecpinfos>
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
</nextrecpinfos>
<otherunits>
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
</otherunits>
</inventory>
<inventory name="sample string 1" description="sample string 2" qty_onhand="3.1" qty_reserved="4.1" qty_avail="5.1" qty_sec="6.1" qty_onorder="7.1" qty_lastrecp="8.1" qry_nextrecp="9.1" uom="sample string 10" entrId="11" divisionId="12" parentDivisionId="13" isDefaultEntrForDivision="14">
<nextrecpinfos>
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
</nextrecpinfos>
<otherunits>
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
</otherunits>
</inventory>
</product>
<product product_id="1" intstatus="sample string 2">
<inventory name="sample string 1" description="sample string 2" qty_onhand="3.1" qty_reserved="4.1" qty_avail="5.1" qty_sec="6.1" qty_onorder="7.1" qty_lastrecp="8.1" qry_nextrecp="9.1" uom="sample string 10" entrId="11" divisionId="12" parentDivisionId="13" isDefaultEntrForDivision="14">
<nextrecpinfos>
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
</nextrecpinfos>
<otherunits>
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
</otherunits>
</inventory>
<inventory name="sample string 1" description="sample string 2" qty_onhand="3.1" qty_reserved="4.1" qty_avail="5.1" qty_sec="6.1" qty_onorder="7.1" qty_lastrecp="8.1" qry_nextrecp="9.1" uom="sample string 10" entrId="11" divisionId="12" parentDivisionId="13" isDefaultEntrForDivision="14">
<nextrecpinfos>
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
<recp date="2024-11-18T10:22:03.282359-05:00" qty="sample string 2" />
</nextrecpinfos>
<otherunits>
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
<unit uom="sample string 1" qty_onhand="2.1" qty_reserved="3.1" qty_avail="4.1" qty_sec="5.1" facteurconv="6.1" />
</otherunits>
</inventory>
</product>
</result>