Skip to content

API Usage Inventory

Jump to bottom
simitben edited this page Apr 11, 2026 · 6 revisions

Purpose

This page explains how third-party systems should call Inventory APIs in SimBiz 6 API V3.

Base URL

  • https://<host>/api/v3

Authentication

All inventory endpoints are protected.

Required headers:

  • Authorization: Bearer <token>

How to get token:

Date-Time Format

For filter parameters such as updated_from and updated_to, use:

  • YYYY-MM-DD HH:MM:SS

Endpoint Summary

No. Endpoint Method Purpose Required Permission Scope
1 /api/v3/inventory/items GET List inventory items inventory.item.read
2 /api/v3/inventory/items/{id} GET Get item by id inventory.item.read
3 /api/v3/inventory/items/by-code/{itemCode} GET Get item by code inventory.item.read
4 /api/v3/inventory/items/by-barcode/{barcode} GET Get item by barcode inventory.item.read
5 /api/v3/inventory/reference-data/{resource} GET Get reference lists inventory.reference.read
6 /api/v3/inventory/items POST Create item inventory.item.write
7 /api/v3/inventory/items/{id} PATCH Update item inventory.item.write

1) List Inventory Items

Request

GET /api/v3/inventory/items

Required Permission Scope

  • inventory.item.read

Query Parameters

Parameter Type Required Notes
page int No default 1
per_page int No default 50, max 200
all string No
paginate string No
q string No search by code/name/barcode
item_id string No exact item id
item_code string No exact item code
item_name string No partial item name
item_barcode string No exact barcode
category_id string No
category_code string No
brand_id string No
brand_code string No
type_id string No
type_code string No
uom_id string No
uom_code string No
is_active string No 1/0/true/false/yes/no
is_stock string No 1/0/true/false/yes/no
is_purchase string No 1/0/true/false/yes/no
is_sold string No 1/0/true/false/yes/no
updated_from datetime No updated range start
updated_to datetime No updated range end
organization_id string No
org_id string No
organization_code string No
org_code string No

Response Fields

Field Type Notes
data[] array list of item rows
data[].item_id string item id
data[].item_code string item code
data[].item_name string item name
data[].item_barcode string item barcode
data[].category_id string category id
data[].category_code string category code
data[].category_name string category name
data[].brand_id string brand id
data[].brand_code string brand code
data[].brand_name string brand name
data[].type_id string type id
data[].type_code string type code
data[].type_name string type name
data[].uom_id string base uom id
data[].uom_code string base uom code
data[].uom_name string base uom name
data[].base_uom_id string base uom id
data[].base_uom_code string base uom code
data[].base_uom_name string base uom name
data[].sales_uom_id string sales uom id
data[].sales_uom_code string sales uom code
data[].sales_uom_name string sales uom name
data[].purchase_uom_id string purchase uom id
data[].purchase_uom_code string purchase uom code
data[].purchase_uom_name string purchase uom name
data[].balanceqty string/number balance quantity
data[].isstock string stock flag (1/0)
data[].ispurchase string purchase flag (1/0)
data[].issold string sold flag (1/0)
data[].purchaseprice string/number default purchase price
data[].sellprice string/number default selling price
data[].costingmethod_code string costing method
data[].uom_conversions[] array item UOM conversion rows
data[].uom_conversions[].itemuom_id string item-uom row id
data[].uom_conversions[].uom_id string uom id
data[].uom_conversions[].uom_code string uom code
data[].uom_conversions[].uom_name string uom name
data[].uom_conversions[].uom_barcode string uom barcode
data[].uom_conversions[].rate string/number conversion rate to base UOM
data[].uom_conversions[].isactive string active flag (1/0)
data[].uom_conversions[].updated datetime string conversion row updated datetime
data[].isactive string active flag (1/0)
data[].created datetime string created datetime
data[].createdby string created by
data[].updated datetime string updated datetime
data[].updatedby string updated by
data[].organization_id string organization id
data[].organization_code string organization code
data[].organization_name string organization name
meta.filters object applied filters
meta.pagination object/null pagination object or null for all=1
meta.execute_time_ms int execution time in ms
meta.request_time datetime string request timestamp
meta.response_time datetime string response timestamp

Example cURL

curl -G "https://<host>/api/v3/inventory/items" \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "organization_code=BHH" \
  --data-urlencode "q=ITEM" \
  --data-urlencode "is_stock=1" \
  --data-urlencode "uom_code=PCS" \
  --data-urlencode "all=1"

Success Response Example

{
  "status": "OK",
  "data": [
    {
      "item_id": "1-1-10",
      "item_code": "ITEM001",
      "item_name": "Sample Item",
      "item_barcode": "9551234567890",
      "category_id": "1-1-100",
      "category_code": "CAT001",
      "category_name": "General",
      "brand_id": "1-1-200",
      "brand_code": "BRAND001",
      "brand_name": "SimBiz",
      "type_id": "1-1-300",
      "type_code": "TYPE001",
      "type_name": "Stock Item",
      "uom_id": "1-1-400",
      "uom_code": "PCS",
      "uom_name": "Pieces",
      "base_uom_id": "1-1-400",
      "base_uom_code": "PCS",
      "base_uom_name": "Pieces",
      "sales_uom_id": "1-1-401",
      "sales_uom_code": "BOX",
      "sales_uom_name": "Box",
      "purchase_uom_id": "1-1-402",
      "purchase_uom_code": "CTN",
      "purchase_uom_name": "Carton",
      "balanceqty": "120.0000",
      "isstock": "1",
      "ispurchase": "1",
      "issold": "1",
      "purchaseprice": "12.5000",
      "sellprice": "18.0000",
      "costingmethod_code": "AVG",
      "uom_conversions": [
        {
          "itemuom_id": "IU001",
          "item_id": "1-1-10",
          "uom_id": "1-1-400",
          "uom_code": "PCS",
          "uom_name": "Pieces",
          "uom_barcode": "",
          "rate": "1.000000",
          "isactive": "1",
          "updated": "2026-04-09 09:30:00"
        },
        {
          "itemuom_id": "IU002",
          "item_id": "1-1-10",
          "uom_id": "1-1-401",
          "uom_code": "BOX",
          "uom_name": "Box",
          "uom_barcode": "",
          "rate": "12.000000",
          "isactive": "1",
          "updated": "2026-04-09 09:30:00"
        }
      ],
      "organization_id": "1",
      "organization_code": "BHH",
      "organization_name": "BHH",
      "isactive": "1",
      "created": "2026-04-01 08:00:00",
      "createdby": "support",
      "updated": "2026-04-09 09:30:00",
      "updatedby": "support"
    }
  ],
  "meta": {
    "filters": {
      "organization_id": "1",
      "organization_code": "BHH",
      "q": "ITEM",
      "uom_code": "PCS",
      "is_active": "1",
      "is_stock": "1"
    },
    "pagination": null,
    "execute_time_ms": 15,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

2) Get Item by ID

Request

GET /api/v3/inventory/items/{id}

Required Permission Scope

  • inventory.item.read

Query Parameters

None.

Response Fields

Field Type Notes
data object single item row
data.item_id string item id
data.item_code string item code
data.item_name string item name
data.item_barcode string item barcode
data.category_id string
data.category_code string
data.category_name string
data.brand_id string
data.brand_code string
data.brand_name string
data.type_id string
data.type_code string
data.type_name string
data.uom_id string
data.uom_code string
data.uom_name string
data.base_uom_id string base uom id
data.base_uom_code string base uom code
data.base_uom_name string base uom name
data.sales_uom_id string sales uom id
data.sales_uom_code string sales uom code
data.sales_uom_name string sales uom name
data.purchase_uom_id string purchase uom id
data.purchase_uom_code string purchase uom code
data.purchase_uom_name string purchase uom name
data.balanceqty string/number balance quantity
data.isstock string
data.ispurchase string
data.issold string
data.purchaseprice string/number
data.sellprice string/number
data.costingmethod_code string costing method
data.uom_conversions[] array item UOM conversion rows
data.uom_conversions[].itemuom_id string item-uom row id
data.uom_conversions[].uom_id string uom id
data.uom_conversions[].uom_code string uom code
data.uom_conversions[].uom_name string uom name
data.uom_conversions[].uom_barcode string uom barcode
data.uom_conversions[].rate string/number conversion rate to base UOM
data.uom_conversions[].isactive string active flag (1/0)
data.uom_conversions[].updated datetime string row updated datetime
data.isactive string active flag (1/0)
data.created datetime string / string
data.createdby datetime string / string
data.updated datetime string / string
data.updatedby datetime string / string
data.organization_id string
data.organization_code string
data.organization_name string
meta.execute_time_ms int execution time in ms
meta.request_time datetime string request timestamp
meta.response_time datetime string response timestamp

Example cURL

curl -X GET "https://<host>/api/v3/inventory/items/1-1-10" \
  -H "Authorization: Bearer <token>" \

Success Response Example

{
  "status": "OK",
  "data": {
    "item_id": "1-1-10",
    "item_code": "ITEM001",
    "item_name": "Sample Item",
    "item_barcode": "9551234567890",
    "category_id": "1-1-100",
    "category_code": "CAT001",
    "category_name": "General",
    "brand_id": "1-1-200",
    "brand_code": "BRAND001",
    "brand_name": "SimBiz",
    "type_id": "1-1-300",
    "type_code": "TYPE001",
    "type_name": "Stock Item",
    "uom_id": "1-1-400",
    "uom_code": "PCS",
    "uom_name": "Pieces",
    "base_uom_id": "1-1-400",
    "base_uom_code": "PCS",
    "base_uom_name": "Pieces",
    "sales_uom_id": "1-1-401",
    "sales_uom_code": "BOX",
    "sales_uom_name": "Box",
    "purchase_uom_id": "1-1-402",
    "purchase_uom_code": "CTN",
    "purchase_uom_name": "Carton",
    "balanceqty": "120.0000",
    "isstock": "1",
    "ispurchase": "1",
    "issold": "1",
    "purchaseprice": "12.5000",
    "sellprice": "18.0000",
    "costingmethod_code": "AVG",
    "uom_conversions": [
      {
        "itemuom_id": "IU001",
        "item_id": "1-1-10",
        "uom_id": "1-1-400",
        "uom_code": "PCS",
        "uom_name": "Pieces",
        "uom_barcode": "",
        "rate": "1.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      },
      {
        "itemuom_id": "IU002",
        "item_id": "1-1-10",
        "uom_id": "1-1-401",
        "uom_code": "BOX",
        "uom_name": "Box",
        "uom_barcode": "",
        "rate": "12.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      }
    ],
    "organization_id": "1",
    "organization_code": "BHH",
    "organization_name": "BHH",
    "isactive": "1",
    "created": "2026-04-01 08:00:00",
    "createdby": "support",
    "updated": "2026-04-09 09:30:00",
    "updatedby": "support"
  },
  "meta": {
    "execute_time_ms": 9,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

3) Get Item by Code

Request

GET /api/v3/inventory/items/by-code/{itemCode}

Required Permission Scope

  • inventory.item.read

Query Parameters

None.

Response Fields

Field Type Notes
data object same complete field set as get-by-id
meta.execute_time_ms int execution time in ms
meta.request_time datetime string request timestamp
meta.response_time datetime string response timestamp

Example cURL

curl -X GET "https://<host>/api/v3/inventory/items/by-code/ITEM001" \
  -H "Authorization: Bearer <token>" \

Success Response Example

{
  "status": "OK",
  "data": {
    "item_id": "1-1-10",
    "item_code": "ITEM001",
    "item_name": "Sample Item",
    "item_barcode": "9551234567890",
    "category_id": "1-1-100",
    "category_code": "CAT001",
    "category_name": "General",
    "brand_id": "1-1-200",
    "brand_code": "BRAND001",
    "brand_name": "SimBiz",
    "type_id": "1-1-300",
    "type_code": "TYPE001",
    "type_name": "Stock Item",
    "uom_id": "1-1-400",
    "uom_code": "PCS",
    "uom_name": "Pieces",
    "base_uom_id": "1-1-400",
    "base_uom_code": "PCS",
    "base_uom_name": "Pieces",
    "sales_uom_id": "1-1-401",
    "sales_uom_code": "BOX",
    "sales_uom_name": "Box",
    "purchase_uom_id": "1-1-402",
    "purchase_uom_code": "CTN",
    "purchase_uom_name": "Carton",
    "balanceqty": "120.0000",
    "isstock": "1",
    "ispurchase": "1",
    "issold": "1",
    "purchaseprice": "12.5000",
    "sellprice": "18.0000",
    "costingmethod_code": "AVG",
    "uom_conversions": [
      {
        "itemuom_id": "IU001",
        "item_id": "1-1-10",
        "uom_id": "1-1-400",
        "uom_code": "PCS",
        "uom_name": "Pieces",
        "uom_barcode": "",
        "rate": "1.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      },
      {
        "itemuom_id": "IU002",
        "item_id": "1-1-10",
        "uom_id": "1-1-401",
        "uom_code": "BOX",
        "uom_name": "Box",
        "uom_barcode": "",
        "rate": "12.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      }
    ],
    "organization_id": "1",
    "organization_code": "BHH",
    "organization_name": "BHH",
    "isactive": "1",
    "created": "2026-04-01 08:00:00",
    "createdby": "support",
    "updated": "2026-04-09 09:30:00",
    "updatedby": "support"
  },
  "meta": {
    "execute_time_ms": 9,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

4) Get Item by Barcode

Request

GET /api/v3/inventory/items/by-barcode/{barcode}

Required Permission Scope

  • inventory.item.read

Query Parameters

None.

Response Fields

Field Type Notes
data object same complete field set as get-by-id
meta.execute_time_ms int execution time in ms
meta.request_time datetime string request timestamp
meta.response_time datetime string response timestamp

Example cURL

curl -X GET "https://<host>/api/v3/inventory/items/by-barcode/9551234567890" \
  -H "Authorization: Bearer <token>" \

Success Response Example

{
  "status": "OK",
  "data": {
    "item_id": "1-1-10",
    "item_code": "ITEM001",
    "item_name": "Sample Item",
    "item_barcode": "9551234567890",
    "category_id": "1-1-100",
    "category_code": "CAT001",
    "category_name": "General",
    "brand_id": "1-1-200",
    "brand_code": "BRAND001",
    "brand_name": "SimBiz",
    "type_id": "1-1-300",
    "type_code": "TYPE001",
    "type_name": "Stock Item",
    "uom_id": "1-1-400",
    "uom_code": "PCS",
    "uom_name": "Pieces",
    "base_uom_id": "1-1-400",
    "base_uom_code": "PCS",
    "base_uom_name": "Pieces",
    "sales_uom_id": "1-1-401",
    "sales_uom_code": "BOX",
    "sales_uom_name": "Box",
    "purchase_uom_id": "1-1-402",
    "purchase_uom_code": "CTN",
    "purchase_uom_name": "Carton",
    "balanceqty": "120.0000",
    "isstock": "1",
    "ispurchase": "1",
    "issold": "1",
    "purchaseprice": "12.5000",
    "sellprice": "18.0000",
    "costingmethod_code": "AVG",
    "uom_conversions": [
      {
        "itemuom_id": "IU001",
        "item_id": "1-1-10",
        "uom_id": "1-1-400",
        "uom_code": "PCS",
        "uom_name": "Pieces",
        "uom_barcode": "",
        "rate": "1.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      },
      {
        "itemuom_id": "IU002",
        "item_id": "1-1-10",
        "uom_id": "1-1-401",
        "uom_code": "BOX",
        "uom_name": "Box",
        "uom_barcode": "",
        "rate": "12.000000",
        "isactive": "1",
        "updated": "2026-04-09 09:30:00"
      }
    ],
    "organization_id": "1",
    "organization_code": "BHH",
    "organization_name": "BHH",
    "isactive": "1",
    "created": "2026-04-01 08:00:00",
    "createdby": "support",
    "updated": "2026-04-09 09:30:00",
    "updatedby": "support"
  },
  "meta": {
    "execute_time_ms": 9,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

5) Reference Data

Request

GET /api/v3/inventory/reference-data/{resource}

Required Permission Scope

  • inventory.reference.read

Allowed Resource Values

  • categories
  • brands
  • types
  • uoms
  • locations

Query Parameters

Parameter Type Required Notes
organization_id string No
org_id string No
organization_code string No
org_code string No

Response Fields

Field Type Notes
data object/array Endpoint payload. See success response example for exact fields.
meta object Standard metadata including timing fields.
  • id, code, name, updated

Example cURL

curl -G "https://<host>/api/v3/inventory/reference-data/categories" \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "organization_code=BHH"

Success Response Example

{
  "status": "OK",
  "data": [
    { "id": "1-1-100", "code": "CAT001", "name": "General", "updated": "" }
  ],
  "meta": {
    "execute_time_ms": 5,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

6) Create Item

Request

POST /api/v3/inventory/items

Required Permission Scope

  • inventory.item.write

Body is required (JSON).

Body Parameters:

Field Required Accepted Value / Format Notes
organization_id No valid org id/code
organization_code No valid org id/code
data Yes object root payload object
data.header.item_code Yes non-empty string item code
data.header.item_name Yes non-empty string item name
data.header.category_id No valid id/code
data.header.category_code No valid id/code
data.header.brand_id No valid id/code
data.header.brand_code No valid id/code
data.header.type_id No valid id/code
data.header.type_code No valid id/code
data.line.baseuom_code Yes valid uom code base UOM
data.line.isstock No 1 or 0
data.line.issold No 1 or 0
data.line.ispurchase No 1 or 0

Query Parameters

None.

Response Fields

Field Type Notes
data object/array Endpoint payload. See success response example for exact fields.
meta object Standard metadata including timing fields.
  • item_id, item_code, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/inventory/items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_code": "BHH",
    "data": {
      "header": {
        "item_code": "ITEM-API-001",
        "item_name": "API Created Item",
        "category_code": "CAT001",
        "type_code": "TYPE001",
        "brand_code": "BRAND001"
      },
      "line": {
        "baseuom_code": "PCS",
        "isstock": "1",
        "issold": "1",
        "ispurchase": "1"
      }
    }
  }'

Success Response Example

{
  "status": "OK",
  "data": {
    "item_id": "1-1-10",
    "item_code": "ITEM-API-001",
    "msg": "Item saved successfully",
    "updated": ""
  },
  "meta": {
    "execute_time_ms": 25,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

7) Update Item

Request

PATCH /api/v3/inventory/items/{id}

Required Permission Scope

  • inventory.item.write

{id} is the target item id.
Body is required (JSON) and carries changed values.

Body Parameters:

Field Required Accepted Value / Format Notes
organization_id No valid org id/code
organization_code No valid org id/code
data Yes object root payload object
data.header.item_name No non-empty string update name
data.header.category_id No valid id/code
data.header.category_code No valid id/code
data.header.brand_id No valid id/code
data.header.brand_code No valid id/code
data.header.type_id No valid id/code
data.header.type_code No valid id/code
data.line.baseuom_code No valid uom code update UOM
data.line.isstock No 1 or 0
data.line.issold No 1 or 0
data.line.ispurchase No 1 or 0

Query Parameters

None.

Response Fields

Field Type Notes
data object/array Endpoint payload. See success response example for exact fields.
meta object Standard metadata including timing fields.
  • item_id, item_code, msg, updated

Example cURL

curl -X PATCH "https://<host>/api/v3/inventory/items/1-1-10" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_code": "BHH",
    "data": {
      "header": {
        "item_name": "API Updated Item"
      }
    }
  }'

Success Response Example

{
  "status": "OK",
  "data": {
    "item_id": "1-1-10",
    "item_code": "ITEM-API-001",
    "msg": "Item updated successfully",
    "updated": ""
  },
  "meta": {
    "execute_time_ms": 19,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

Clone this wiki locally