[POST] .../v1/item/match
Performs bulk item matching by one of the keys: code, name, article number or barcode. Returns the matched item ID for each request. Use this method to match up to 250 external item keys to REGOS item IDs in a single batch request. It requires a matching type and a non-empty data array, checks item select permission and returns an ItemMatchingResponse array where each row corresponds to the submitted matching value. Business errors such as a missing request body, default matching type, missing data, batch-size violations, null data rows, denied access or persistent matching errors are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| data | Array of ItemMatchingRequestData | Required | Data array. |
| type | String | Required | Matching type: Code - by code, Name - by name, Articul - by article number, Barcode - by barcode. Allowed values: Default, Code, Name, Articul, Barcode, ICPS, ICPSBarcode. |
Request Example
{
"data": [
{
"index": "string",
"value": "string"
}
],
"type": "Code"
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of ItemMatchingResponse | Result object. |
Response Example
{
"ok": true,
"result": [
{
"index": "string",
"item_id": 1,
"value": "string"
}
]
}