Item Reference API

Overview

The WMS Item Reference API is a Business Central API page designed to manage item reference data. This API allows external systems to interact with item reference records, providing functionality for creating, reading, and updating item reference information.

API Details

  • Publisher: smart
  • API Group: wms
  • API Version: v2.0
  • Entity Name: itemReference
  • Entity Set Name: itemReferences
  • Source Table: Item Reference
  • ODataKeyFields: Item No., Variant Code, Unit of Measure, Reference Type, Reference Type No., Reference No.

Fields

The following fields are exposed in the API:

Field Name Source Field Required Description
ItemNo Item Reference."Item No." Yes Unique identifier for the item.
ReferenceType Item Reference."Reference Type" Yes Type of the reference.
ReferenceTypeNo Item Reference."Reference Type No." Yes Number associated with the reference type.
ReferenceNo Item Reference."Reference No." Yes Reference number.
VariantCode Item Reference."Variant Code" No Variant code for the item.
UnitOfMeasure Item Reference."Unit of Measure" No Unit of measure for the item.
StartingDate Item Reference."Starting Date" No Starting date for the reference.
EndingDate Item Reference."Ending Date" No Ending date for the reference.
DefaultBarcode Item Reference."SMA Default Barcode" No Default barcode for the item.

Example Usage

Create a New Item Reference

POST host/instance/api/smart/wms/v2.0/companies(companyId)/itemReferences
Content-Type: application/json

{
    "ItemNo": "ITEM001",
    "ReferenceType": "Vendor",
    "ReferenceTypeNo": "VEND001",
    "ReferenceNo": "REF001",
    "VariantCode": "VAR001",
    "UnitOfMeasure": "PCS",
    "StartingDate": "2023-01-01",
    "EndingDate": "2023-12-31",
    "DefaultBarcode": "1234567890123"
}

Retrieve an Item Reference

GET host/instance/api/smart/wms/v2.0/companies(companyId)/itemReferences('ITEM001', 'VAR001', 'PCS', 'Vendor', 'VEND001', 'REF001')

Update an Item Reference

PATCH host/instance/api/smart/wms/v2.0/companies(companyId)/itemReferences('ITEM001', 'VAR001', 'PCS', 'Vendor', 'VEND001', 'REF001')
Content-Type: application/json

{
    "DefaultBarcode": "9876543210987"
}
Edit this page