TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Organizations

Which plants and business units an item is defined in. An item not assigned to an organization cannot be transacted there — that is the control.

Type REST6 operationsBase path /api/scm/item-orgsPublished as /api/v1/item-orgs

Download specification (OpenAPI 3.1) Screen: Item · Organizations

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 › Item · Organizations 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.item_orgs · 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

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

GET/api/scm/item-orgsList item · organizations

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "local_item_no": "LOC-000001",
      "local_name": "Example",
      "is_stockable": true,
      "is_transactable": true,
      "is_purchasable": true,
      "is_sellable": true,
      "is_manufacturable": true,
      "is_returnable": true,
      "lifecycle_phase": "concept",
      "default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "default_subinventory_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "local_item_no": "LOC-000001",
  "local_name": "Example",
  "is_stockable": true,
  "is_transactable": true,
  "is_purchasable": true,
  "is_sellable": true,
  "is_manufacturable": true,
  "is_returnable": true,
  "lifecycle_phase": "concept",
  "default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_subinventory_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidYesOrganization
local_item_notextNoLocal item number — What this plant calls it, when that differs from the master.
local_nametextNoLocal name
is_stockablebooleanNoStockable here
is_transactablebooleanNoTransactable here
is_purchasablebooleanNoPurchasable here
is_sellablebooleanNoSellable here
is_manufacturablebooleanNoManufacturable here
is_returnablebooleanNoIs returnable
lifecycle_phasetextNoLifecycle phase
Allowed: concept design prototype pilot production mature phase_out obsolete withdrawn
default_warehouse_iduuidNoDefault warehouse
default_subinventory_iduuidNoDefault subinventory id
planner_iduuidNoPlanner
buyer_iduuidNoBuyer
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "local_item_no": "LOC-000001",
  "local_name": "Example",
  "is_stockable": true,
  "is_transactable": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "local_item_no": "LOC-000001",
  "local_name": "Example",
  "is_stockable": true,
  "is_transactable": true,
  "is_purchasable": true,
  "is_sellable": true,
  "is_manufacturable": true,
  "is_returnable": true,
  "lifecycle_phase": "concept",
  "default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_subinventory_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/item-orgs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","local_item_no":"LOC-000001","local_name":"Example","is_stockable":true,"is_transactable":true}'
PUT/api/scm/item-orgs/{id}Change a item orgs

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_iduuidYesItem
org_unit_iduuidYesOrganization
local_item_notextNoLocal item number — What this plant calls it, when that differs from the master.
local_nametextNoLocal name
is_stockablebooleanNoStockable here
is_transactablebooleanNoTransactable here
is_purchasablebooleanNoPurchasable here
is_sellablebooleanNoSellable here
is_manufacturablebooleanNoManufacturable here
is_returnablebooleanNoIs returnable
lifecycle_phasetextNoLifecycle phase
Allowed: concept design prototype pilot production mature phase_out obsolete withdrawn
default_warehouse_iduuidNoDefault warehouse
default_subinventory_iduuidNoDefault subinventory id
planner_iduuidNoPlanner
buyer_iduuidNoBuyer
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "local_item_no": "LOC-000001",
  "local_name": "Example",
  "is_stockable": true,
  "is_transactable": true,
  "is_purchasable": true,
  "is_sellable": true,
  "is_manufacturable": true,
  "is_returnable": true,
  "lifecycle_phase": "concept",
  "default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_subinventory_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/item-orgs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-orgs/{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/item-orgs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a item orgs, 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_iduuidread, writeItem
org_unit_iduuidread, writeOrganization
local_item_notextread, writeLocal item number — What this plant calls it, when that differs from the master.
local_nametextread, writeLocal name
is_stockablebooleanread, writeStockable here
is_transactablebooleanread, writeTransactable here
is_purchasablebooleanread, writePurchasable here
is_sellablebooleanread, writeSellable here
is_manufacturablebooleanread, writeManufacturable here
is_returnablebooleanread, writeIs returnable
lifecycle_phasetextread, writeLifecycle phase
Allowed: concept design prototype pilot production mature phase_out obsolete withdrawn
default_warehouse_iduuidread, writeDefault warehouse
default_subinventory_iduuidread, writeDefault subinventory id
planner_iduuidread, writePlanner
buyer_iduuidread, writeBuyer
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
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_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Item · Organizations 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.