Skip to content

External Item Master

GET    /api/external-item-master
GET    /api/external-item-master/{id}
GET    /api/external-item-master-details/{id}
POST   /api/external-item-master
PUT    /api/external-item-master/{id}
DELETE /api/external-item-master/{id}

Required privilege: External Item Master / View (read) ยท External Item Master / Edit (write)

The External Item Master stores mappings between internal Knosc items and external identifiers from third-party systems (ERPs, marketplaces, partner systems). This enables cross-system item reconciliation without modifying the primary Item Master.


External Item Object

{
  "id": 801,
  "Item Id": 55,
  "Item Number": "ITEM-A",
  "External Item Number": "EXT-ACME-001",
  "External System": "SAP",
  "External Description": "Widget Type A (SAP)",
  "Status": "Active"
}
Field Type Description
id integer Internal identifier
Item Id integer Linked internal item
Item Number string Internal item reference
External Item Number string Identifier in the external system
External System string Source system name (e.g., SAP, Oracle, Shopify)
External Description string | null Item name as it appears in the external system

GET - Get External Item with Details

GET /api/external-item-master-details/{id}

Returns the external item record along with all its mapping details and any associated metadata from the external system.


POST - Create External Item Mapping

POST /api/external-item-master HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Item Number": "ITEM-A",
  "External Item Number": "EXT-ACME-001",
  "External System": "SAP",
  "Status": "Active"
}