GET products/{product_id}/query?session={session}&options={options}
Returns additions for a product
Request
URL parameters
| Name | Description | Type | Additionnal Information | Intro version |
|---|---|---|---|---|
| product_id | bigint | Required | ||
| 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
ProductQueryResult| Name | Description | Type | Additionnal Information | Intro version |
|---|---|---|---|---|
| product | Product structure | ProductQuery | ||
| 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,
"nextarrivals": {
"item": [
{
"sequence": 1,
"qty": 2.1,
"purchaseOrderNo": "sample string 3",
"purchaseOrderDate": "2026-01-18",
"requiredDate": "2026-01-18"
},
{
"sequence": 1,
"qty": 2.1,
"purchaseOrderNo": "sample string 3",
"purchaseOrderDate": "2026-01-18",
"requiredDate": "2026-01-18"
}
]
}
},
"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">
<nextarrivals>
<item sequence="1" qty="2.1" purchaseOrderNo="sample string 3" purchaseOrderDate="2026-01-18T08:06:10.2696182-05:00" requiredDate="2026-01-18T08:06:10.2696182-05:00" />
<item sequence="1" qty="2.1" purchaseOrderNo="sample string 3" purchaseOrderDate="2026-01-18T08:06:10.2696182-05:00" requiredDate="2026-01-18T08:06:10.2696182-05:00" />
</nextarrivals>
</product>
</result>