TRANXACT.AI Help

Supply Chain · Items & Suppliers

Items

Open an item and everything about it is there: its organizations, sales, purchasing, planning, work definition, revisions, stocking, quality, costing and lot control, each one dated so you can read it as it stood on any day.

Type REST15 operationsBase path /api/scm/itemsPublished as /api/v1/items

Download specification (OpenAPI 3.1) Screen: Items

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Items on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.items · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

15 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/itemsList items

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_no": "ITE-000001",
      "name": "Example",
      "description": "text",
      "item_type": "raw",
      "uom": "text",
      "standard_cost": "1250.00",
      "list_price": "1250.00",
      "lot_controlled": true,
      "serial_controlled": true,
      "shelf_life_days": 10,
      "hazardous": true,
      "safety_stock": "1250.00",
      "reorder_point": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/items?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/items/{id}Read one items

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_no": "ITE-000001",
  "name": "Example",
  "description": "text",
  "item_type": "raw",
  "uom": "text",
  "standard_cost": "1250.00",
  "list_price": "1250.00",
  "lot_controlled": true,
  "serial_controlled": true,
  "shelf_life_days": 10,
  "hazardous": true,
  "safety_stock": "1250.00",
  "reorder_point": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/itemsCreate a items

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_notextYesItem number — Left blank, the platform allocates the next one from the number range.
nametextYesName
descriptiontextNoDescription
item_typetextNoType
Allowed: raw component semi_finished finished service mro
uomtextNoUnit of measure — The unit the item is stocked in. Units are kept under Supply Chain › Units of Measure.
standard_costnumericNoStandard cost
list_pricenumericNoList price
lot_controlledbooleanNoLot controlled
serial_controlledbooleanNoSerial controlled
shelf_life_daysintegerNoShelf life (days)
hazardousbooleanNoHazardous
safety_stocknumericNoSafety stock
reorder_pointnumericNoReorder point
is_activebooleanNoIs active
serial_prefixtextNoSerial prefix — Used when the platform allocates numbers, e.g. PUMP gives PUMP-SN-000001.
serialization_modetextNoSerialization — Turning this on makes every individual unit traceable: receiving asks for one serial number per unit, and shipping records which unit went to which customer.
hsn_codetextNoHSN/SAC code — India: the HSN code of goods or the SAC (99...) of a service, 4 to 8 digits. Printed on every invoice line.
uqctextNoUnit quantity code (UQC) — India: the GST unit, e.g. NOS, KGS, MTR.
is_servicebooleanNoA service (SAC)
cess_ratenumericNoCess rate
gst_tax_codetextNoGST tax code (sales) — India: the GST rate a sale of this item carries. Left empty, the rate of its HSN/SAC is used.

Sample body

{
  "item_no": "ITE-000001",
  "name": "Example",
  "description": "text",
  "item_type": "raw",
  "uom": "text",
  "standard_cost": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_no": "ITE-000001",
  "name": "Example",
  "description": "text",
  "item_type": "raw",
  "uom": "text",
  "standard_cost": "1250.00",
  "list_price": "1250.00",
  "lot_controlled": true,
  "serial_controlled": true,
  "shelf_life_days": 10,
  "hazardous": true,
  "safety_stock": "1250.00",
  "reorder_point": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/items" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_no":"ITE-000001","name":"Example","description":"text","item_type":"raw","uom":"text","standard_cost":"1250.00"}'
PUT/api/scm/items/{id}Change a items

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
item_notextYesItem number — Left blank, the platform allocates the next one from the number range.
nametextYesName
descriptiontextNoDescription
item_typetextNoType
Allowed: raw component semi_finished finished service mro
uomtextNoUnit of measure — The unit the item is stocked in. Units are kept under Supply Chain › Units of Measure.
standard_costnumericNoStandard cost
list_pricenumericNoList price
lot_controlledbooleanNoLot controlled
serial_controlledbooleanNoSerial controlled
shelf_life_daysintegerNoShelf life (days)
hazardousbooleanNoHazardous
safety_stocknumericNoSafety stock
reorder_pointnumericNoReorder point
is_activebooleanNoIs active
serial_prefixtextNoSerial prefix — Used when the platform allocates numbers, e.g. PUMP gives PUMP-SN-000001.
serialization_modetextNoSerialization — Turning this on makes every individual unit traceable: receiving asks for one serial number per unit, and shipping records which unit went to which customer.
hsn_codetextNoHSN/SAC code — India: the HSN code of goods or the SAC (99...) of a service, 4 to 8 digits. Printed on every invoice line.
uqctextNoUnit quantity code (UQC) — India: the GST unit, e.g. NOS, KGS, MTR.
is_servicebooleanNoA service (SAC)
cess_ratenumericNoCess rate
gst_tax_codetextNoGST tax code (sales) — India: the GST rate a sale of this item carries. Left empty, the rate of its HSN/SAC is used.

Sample body

{
  "item_no": "ITE-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_no": "ITE-000001",
  "name": "Example",
  "description": "text",
  "item_type": "raw",
  "uom": "text",
  "standard_cost": "1250.00",
  "list_price": "1250.00",
  "lot_controlled": true,
  "serial_controlled": true,
  "shelf_life_days": 10,
  "hazardous": true,
  "safety_stock": "1250.00",
  "reorder_point": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_no":"ITE-000001","name":"Example"}'
DELETE/api/scm/items/{id}Delete a items

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/items/{id}/profileProfile

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/profile" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/items/{id}/where-usedWhere used

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/where-used" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/items/{id}/assign-orgAssign org

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

orgUnitId*, effectiveFrom, copyFrom

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign-org" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgUnitId":"value","effectiveFrom":"value","copyFrom":"value"}'
GET/api/scm/items/{id}/base-unitBase unit

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/base-unit" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/items/{id}/unitsUnits

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/units" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/items/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/items/{parentId}/uomsUoms

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/uoms" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/items/{parentId}/uomsUoms

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/uoms" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/items/{parentId}/uoms/{lineId}Uoms

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/uoms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/items/{parentId}/uoms/{lineId}Uoms

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/uoms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a items, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
item_notextread, writeItem number — Left blank, the platform allocates the next one from the number range.
nametextread, writeName
descriptiontextread, writeDescription
item_typetextread, writeType
Allowed: raw component semi_finished finished service mro
uomtextread, writeUnit of measure — The unit the item is stocked in. Units are kept under Supply Chain › Units of Measure.
standard_costnumericread, writeStandard cost
list_pricenumericread, writeList price
lot_controlledbooleanread, writeLot controlled
serial_controlledbooleanread, writeSerial controlled
shelf_life_daysintegerread, writeShelf life (days)
hazardousbooleanread, writeHazardous
safety_stocknumericread, writeSafety stock
reorder_pointnumericread, writeReorder point
is_activebooleanread, writeIs active
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
serial_prefixtextread, writeSerial prefix — Used when the platform allocates numbers, e.g. PUMP gives PUMP-SN-000001.
serialization_modetextread, writeSerialization — Turning this on makes every individual unit traceable: receiving asks for one serial number per unit, and shipping records which unit went to which customer.
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
hsn_codetextread, writeHSN/SAC code — India: the HSN code of goods or the SAC (99...) of a service, 4 to 8 digits. Printed on every invoice line.
uqctextread, writeUnit quantity code (UQC) — India: the GST unit, e.g. NOS, KGS, MTR.
is_servicebooleanread, writeA service (SAC)
cess_ratenumericread, writeCess rate
tax_classification_iduuidread onlyTax classification id
drop_ship_defaultbooleanread onlyDrop ship default
drop_ship_supplier_iduuidread onlyDrop ship supplier id
merged_into_iduuidread onlyMerged into id
gst_tax_codetextread, writeGST tax code (sales) — India: the GST rate a sale of this item carries. Left empty, the rate of its HSN/SAC is used.

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Items for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.