Working with Items

Overview

The Item APIs allow external systems to create, retrieve and delete items in Leanafy. Items must be created before they can be added to an order. This ensures that inventory and order management processes function correctly.

Authentication

All API requests must be authenticated. Follow the Authentication Guide to securely access the API.

Handling SKUs

SKUs

The SKUs need to be unique and consistent in both Leanafy and the integrating system. SKUs will be used to fetch Item Info, Inventory and also in Delete Item operation. If the SKUs don't uniquely identify specific items, it may lead to unexpected behaviour.

Handling Unit of Measurement (UoM)

The Create Item and Bulk Create Items APIs also support creation and assignment of Units of Measurement (UoM) to items.

The uom field is mandatory. It should contain a name that represents common name for units of a particular item.

The base_unit field is mandatory. It should contain the unit that represents one single piece of a particular item.

The receiving_unit field is optional. It can contain the unit in which an item can be received. receiving_unit_base_conversion contains a number which can be used by our system to convert the receiving unit into base unit.

Same logic also applies to shipping_unit and shipping_unit_base_conversion fields.

Item Quantity

The item inventory quantity will always be in base unit

Overview

Authentication

Handling SKUs

Handling Unit of Measurement (UoM)

Available APIs

1. Create Item

2. Bulk Create Item

3. Get Item

4. Get All Items

5. Delete Item

Working with Items

Overview#

Authentication#

Handling SKUs#

Handling Unit of Measurement (UoM)#

Available APIs#

1. Create Item#

2. Bulk Create Item#

3. Get Item#

4. Get All Items#

5. Delete Item#

Overview

Authentication

Handling SKUs

Handling Unit of Measurement (UoM)

Available APIs

1. Create Item

2. Bulk Create Item

3. Get Item

4. Get All Items

5. Delete Item