iotoms Docs

Get items by item codes

POST
/api/v1/catalog/items/list

Returns the items matching a list of item codes (itemIds) in one call. Codes that do not exist are simply left out.

How to use it

  1. Collect the item codes you need, e.g. from an order or a sync queue.
  2. Send them as itemIds; the matching items are returned as a plain list, and unknown codes are simply missing from it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
itemIds*array<string>

Item codes to fetch, e.g. ["SKU-001", "SKU-002"]. Required. Codes that do not exist are left out of the result.

Response Body

OK

*/*
  1. response
[index: integer]?
Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/catalog/items/list' \  -H 'Content-Type: application/json' \  -d '{  "itemIds": [    "string"  ]}'
Example Response
[  {    "id": 0,    "itemId": "string",    "upc": "string",    "productId": "string",    "itemName": "string",    "sellingPrice": 0.1,    "costPrice": 0.1,    "department": {      "id": 0,      "name": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "category": {      "id": 0,      "name": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "subcategory": {      "id": 0,      "name": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "description": "string",    "imageGallery": {      "id": 0,      "imageUrl": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "style": {      "id": 0,      "name": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "size": {      "id": 0,      "name": "string",      "status": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "color": {      "id": 0,      "name": "string",      "status": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "brand": {      "id": 0,      "name": "string",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "season": "string",    "type": "MODIFIER_ITEM",    "tax": {      "id": 0,      "name": "string",      "taxRate1": 0,      "taxRate2": 0,      "modifiedTime": "2019-08-24T14:15:22Z",      "status": "string"    },    "discount": {      "id": 0,      "name": "string",      "discountType": 0,      "rate": 0,      "modifiedTime": "2019-08-24T14:15:22Z",      "status": "string",      "buyQuantity": 0,      "getQuantity": 0,      "getDiscountPercent": 0,      "tierMinQuantity": 0    },    "status": "ACTIVE",    "modifiedTime": "2019-08-24T14:15:22Z",    "itemType": "string",    "unitCost": 0,    "baseUomId": "0c43b7c4-22c4-4b37-9c1a-485778bd5b04",    "catchWeight": true,    "hsnCode": "string",    "gstRatePercent": 0,    "igstRatePercent": 0,    "cgstRatePercent": 0,    "sgstRatePercent": 0,    "commodityCode": "string",    "netMassKg": 0,    "countryOfOrigin": "string"  }]