Item POST API Documentation

                JSON
              

                      {
  "items": {
    "id": "ITEM_ID",
    "type": "ITEM_TYPE",
    "name": "ITEM_NAME",
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [
      {
        "name": "UOM_NAME",
        "used_for_sale": "BOOLEAN"
      }
    ],
    "sale": {
      "enabled": "BOOLEAN",
      "pricing_method": "PRICING_METHOD",
      "charge": {
        "type": "CHARGE_TYPE"
      },
      "pricing": {
        "type": "PRICING_TYPE"
      },
      "default_sale_price": "DEFAULT_SALE_PRICE"
    },
    "inventories": {
      "enabled": "BOOLEAN",
      "warehouse_isEnabled": "BOOLEAN",
      "warehouses": [
        {
          "name": "WAREHOUSE_NAME",
          "quantity_available": "QUANTITY_AVAILABLE",
          "accounting_code": "ACCOUNTING_CODE"
        }
      ],
      "inventory_properties": {
        "quantity_available_for_sale_determination": "SALE_DETERMINATION_STRATEGY",
        "quantity_available_for_sale": "SALE_AVAILABILITY"
      }
    }
  }
}
                    

Attribute	Type	Description
id	String	Optional unique identifier for the item.
type	String	Type of item to create (STANDARD).
name	String	Name of the item.
codes	Array	List of identifying codes such as UPC.
isEnabled	String	Whether the item is available for sale.
pricing_method	String	Pricing method for sale (STANDARD).
type	String	Charge type (ONE_OFF).
type	String	Sale pricing strategy (PER_UNIT_PRICING).
default_sale_price	Float	Default sale price of the item.
isEnabled	String	Whether inventory tracking is enabled.
warehouse_isEnabled	String	Whether warehouse support is enabled.
name	String	Name of the warehouse.
quantity_available	String	Quantity available in the warehouse.
accounting_code	String	Accounting code for inventory.
quantity_available_for_sale_determination	String	Determination logic for quantity available.
quantity_available_for_sale	String	Quantity available category (UNLIMITED, etc.).

Response

Returns the full details of the newly created item, including system-generated metadata, identifiers, and item-specific properties like codes and KPIs.Item includes essential information such as a unique identifier (id), current status (ACTIVE), display and internal names, and descriptive text outlining the item's purpose or characteristics. The type is defined as STANDARD, and the item is assigned a base_uom (Unit of Measurement) of "UNIT". Metadata fields track its creation and update history, such as created_by, created_on, last_updated_by, and last_updated_on, with version control and a globally unique identifier (uuid). Visual representation is supported through an image_uri, while form configuration and extensibility are handled by linked custom_form, custom_attributes, and custom_objects.Additional item configuration includes codes like UPCs, defined currencies indicating how the item can be transacted (e.g., used for sale or purchase in AUD), and inventory details such as associated warehouses, quantities on hand, and stock control settings. The sale and purchase sections elaborate on the financial setup, including pricing methods (PER_UNIT_PRICING), tax configurations, accounting codes, default pricing, dimensional specifications (width, height, length, weight), and associated profiles (e.g., discount, shipping). Advanced options like back-order support, tax exemption, charge types, and optional pricing variants are also configurable.

Response Body

                JSON
              

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "ITEM_ID",
    "name": "ITEM_NAME",
    "display_name": "DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "ITEM_TYPE",
    "base_uom": "BASE_UOM",
    "origin": "ITEM_ORIGIN",
    "invoice_note": "INVOICE_NOTE",
    "created_by": "CREATED_BY",
    "created_on": "CREATED_TIMESTAMP",
    "last_updated_by": "LAST_UPDATED_BY",
    "last_updated_on": "LAST_UPDATED_TIMESTAMP",
    "uuid": "ITEM_UUID",
    "version": "ITEM_VERSION",
    "image_uri": "IMAGE_URI",
    "group": {},
    "manager": "ITEM_MANAGER",
    "custom_form": {
      "uuid": "CUSTOM_FORM_UUID",
      "name": "CUSTOM_FORM_NAME"
    },
    "custom_attributes": [],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      },
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [],
    "currencies": [
      {
        "name": "CURRENCY_NAME",
        "used_for_sale": "BOOLEAN",
        "default_for_sale": "BOOLEAN",
        "used_for_purchase": "BOOLEAN",
        "default_for_purchase": "BOOLEAN"
      }
    ],
    "sale": {
      "enabled": "BOOLEAN",
      "enable_back_order": "BOOLEAN",
      "invoice_note": "SALE_INVOICE_NOTE",
      "accounting_code": {},
      "default_sale_price": "DEFAULT_SALE_PRICE",
      "shipping_profile": "SHIPPING_PROFILE",
      "width": {
        "uom": "WIDTH_UOM",
        "value": "WIDTH_VALUE"
      },
      "height": {
        "uom": "HEIGHT_UOM",
        "value": "HEIGHT_VALUE"
      },
      "length": {
        "uom": "LENGTH_UOM",
        "value": "LENGTH_VALUE"
      },
      "weight": {
        "uom": "WEIGHT_UOM",
        "value": "WEIGHT_VALUE"
      },
      "tax_exempt_when_sold": "BOOLEAN",
      "pricing_method": "PRICING_METHOD",
      "tax_configuration": {
        "sale_price_entered_inclusive_of_tax": "BOOLEAN"
      },
      "charge": {
        "type": "CHARGE_TYPE",
        "properties": [
          {
            "name": "CHARGE_PROPERTY_NAME",
            "value": "CHARGE_PROPERTY_VALUE"
          },
          {
            "name": "CHARGE_PROPERTY_NAME",
            "value": "CHARGE_PROPERTY_VALUE"
          }
        ]
      },
      "payment_properties": [
        {
          "name": "PAYMENT_PROPERTY_NAME",
          "value": "PAYMENT_PROPERTY_VALUE"
        },
        {
          "name": "PAYMENT_PROPERTY_NAME",
          "value": "PAYMENT_PROPERTY_VALUE"
        },
        {
          "name": "PAYMENT_PROPERTY_NAME",
          "value": "PAYMENT_PROPERTY_VALUE"
        },
        {
          "name": "PAYMENT_PROPERTY_NAME",
          "value": "PAYMENT_PROPERTY_VALUE"
        }
      ],
      "discount_profile": {},
      "pricing": {
        "type": "PRICING_TYPE",
        "version": "PRICING_VERSION",
        "latest_used_pricing_version": "LATEST_USED_VERSION",
        "pricing_module": []
      },
      "use_on_sale_price": "BOOLEAN",
      "sale_price_variant": "SALE_PRICE_VARIANT",
      "sale_price": "SALE_PRICE",
      "start_date": "SALE_START_DATE",
      "end_date": "SALE_END_DATE"
    },
    "inventories": {
      "enabled": "BOOLEAN",
      "enable_warehouse_management": "BOOLEAN",
      "warehouses": [],
      "default_warehouse": "DEFAULT_WAREHOUSE",
      "inventory_properties": {
        "enable_low_stock_notification": "BOOLEAN",
        "low_stock_threshold_based_on": "LOW_STOCK_THRESHOLD",
        "enable_reordering": "BOOLEAN",
        "reordering_threshold_based_on": "REORDERING_THRESHOLD",
        "quantity_available_for_sale_determination": [
          "SALE_QUANTITY_STRATEGY"
        ],
        "quantity_available_for_sale": "SALE_QUANTITY",
        "enable_preorder": "BOOLEAN",
        "enable_serialization": "BOOLEAN",
        "enable_batch_tracking": "BOOLEAN",
        "enable_inventory_costing": "BOOLEAN",
        "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN",
        "default_cost_per_unit": "DEFAULT_COST"
      }
    },
    "kpis": {
      "total_orders": "TOTAL_ORDERS",
      "active_orders": "ACTIVE_ORDERS",
      "total_revenue": "TOTAL_REVENUE",
      "total_collected": "TOTAL_COLLECTED",
      "total_outstanding": "TOTAL_OUTSTANDING",
      "total_overdue": "TOTAL_OVERDUE"
    }
  }
}
                    

Attribute	Type	Description
status	String	Status of the item
id	String	Unique item identifier
name	String	Name of the item
display_name	String	Display name of the item
description	String	Description of the item
type	String	Type of the item (e.g., STANDARD)
base_uom	String	Base unit of measure
origin	String	Origin or source of the item
invoice_note	String	Invoice note for the item
created_by	String	Creator of the item
created_on	String	Timestamp when the item was created
last_updated_by	String	Last user who updated the item
last_updated_on	String	Timestamp of last update
uuid	String	Unique UUID of the item
version	String	Version number
image_uri	String	URI of the item's image
group	Object	Group information (empty object)
manager	String	Manager of the item
custom_form	Object	Custom form associated with the item
custom_attributes	Array	List of custom attributes (empty array)
custom_objects	Array	List of custom objects (empty array)
codes	Array	List of item codes (e.g., UPC-CODE, ITEM-NUMBER)
uoms	Array	List of unit of measures (empty array)
currencies	Array	Currency usage and defaults for sale/purchase
sale	Object	Sale configuration and pricing details
inventories	Object	Inventory settings and properties
kpis	Object	Key performance indicators for the item

Purpose

This API sets or updates the standard sale configuration of a specific item. It allows defining pricing, tax settings, charge method, and sale duration for an item, ensuring that it is properly configured for transactions in different currencies.

Use Case

Use this endpoint when creating or updating an item’s sale configuration, especially for enabling its availability in a catalog with specific tax rules, pricing models, and charge properties. For instance, an administrator may use this to assign a fixed sale price with GST applied and define the item's validity period for promotional pricing.

Path Parameters

Parameter	Type	Description
item_id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

                JSON
              

                      {
  "items": {
    "uoms": [],
    "currencies": [
      {
        "name": "CURRENCY_CODE",
        "default_for_sale": "BOOLEAN_STRING",
        "used_for_sale": "BOOLEAN_STRING"
      }
    ],
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "invoice_note": "INVOICE_NOTE_TEXT",
      "accounting_code": "ACCOUNTING_CODE_NAME",
      "default_sale_currency": "CURRENCY_CODE",
      "default_sale_price": "DEFAULT_SALE_PRICE",
      "isTaxExemptWhenSold": "BOOLEAN_STRING",
      "pricing_method": "PRICING_METHOD",
      "tax_configuration": {
        "sale_price_entered_is_inclusive_of_tax": "BOOLEAN_STRING",
        "sale_price_is_based_on": "TAX_BASIS_TYPE", 
        "tax_code": {
          "uuid": "TAX_CODE_UUID",
          "code": "TAX_CODE_NAME",
          "rate": "TAX_RATE_PERCENTAGE"
        }
      },
      "charge": {
        "type": "CHARGE_TYPE"
      },
      "pricing": {
        "type": "PRICING_TYPE",
        "pricing_module": [
          {
            "price": "UNIT_PRICE",
            "currency": "CURRENCY_CODE"
          }
        ]
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "PRICE_VARIANT_TYPE",
      "sale_price": "SALE_PRICE_VALUE",
      "start_date": "START_DATE_YYYY-MM-DD",
      "end_date": "END_DATE_YYYY-MM-DD"
    }
  }
}


                    

Attribute	Type	Description
item_id	String	Optional unique identifier for the item.
item_type	String	Type of item to create (STANDARD).
item_name	String	Name of the item.
item_codes	Array	List of identifying codes such as UPC.
sale_is_enabled	String	Whether the item is available for sale.
sale_pricing_method	String	Pricing method for sale (STANDARD).
sale_charge_type	String	Charge type (ONE_OFF).
sale_pricing_type	String	Sale pricing strategy (PER_UNIT_PRICING).
sale_default_price	Float	Default sale price of the item.
inventory_is_enabled	String	Whether inventory tracking is enabled.
warehouse_is_enabled	String	Whether warehouse support is enabled.
warehouse_name	String	Name of the warehouse.
warehouse_quantity_available	String	Quantity available in the warehouse.
warehouse_accounting_code	String	Accounting code for inventory.
inventory_quantity_available_for_sale_determination	String	Determination logic for quantity available.
inventory_quantity_available_for_sale	String	Quantity available category (UNLIMITED, etc.).

Response

The response confirms the item's updated sale configuration, including validated accounting information, pricing breakdown, tax configuration, and status flags. This structure ensures that pricing rules and fiscal compliance are correctly applied to the item across relevant modules like invoicing and order management.

Response Body

                JSON
              

                      {
  "item": {
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "enable_back_order": "BOOLEAN_STRING",
      "invoice_note": "INVOICE_NOTE_TEXT",
      "accounting_code": {
        "sales_revenue": "ACCOUNTING_CODE_NAME"
      },
      "default_sale_price": "DEFAULT_SALE_PRICE",
      "shipping_profile": "",
      "width": {
        "uom": "",
        "value": ""
      },
      "height": {
        "uom": "",
        "value": ""
      },
      "length": {
        "uom": "",
        "value": ""
      },
      "weight": {
        "uom": "",
        "value": ""
      },
      "tax_exempt_when_sold": "BOOLEAN_STRING",
      "pricing_method": "PRICING_METHOD",
      "tax_configuration": {
        "sale_price_entered_inclusive_of_tax": "BOOLEAN_STRING"
      },
      "pricing_profile": {},
      "charge": {
        "type": "CHARGE_TYPE",
        "properties": [
          {
            "name": "FULFILLMENT_PROPERTY_NAME",
            "value": "FULFILLMENT_PROPERTY_VALUE"
          }
        ]
      },
      "payment_properties": [
        {
          "name": "PAYMENT_PROPERTY_NAME",
          "value": "PAYMENT_PROPERTY_VALUE"
        }
      ],
      "discount_profile": {},
      "pricing": {
        "type": "PRICING_TYPE",
        "version": "PRICING_VERSION",
        "latest_used_pricing_version": "",
        "pricing_module": [
          {
            "price": "UNIT_PRICE",
            "currency": "CURRENCY_CODE",
            "last_purchase_price": "",
            "average_purchase_price": ""
          }
        ]
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "",
      "sale_price": "",
      "start_date": "",
      "end_date": ""
    }
  }
}


                    

Attribute	Type	Description
enabled	string (boolean)	Indicates if the item is active for sale.
enable_back_order	string (boolean)	Indicates if back orders are allowed.
invoice_note	string	Note to include on the invoice.
sales_revenue	string	Revenue category assigned.
default_sale_price	string	Default sale price configured.
shipping_profile	string	Shipping profile (empty if not set).
width, height, length, weight	object	Dimensional attributes with uom and value.
tax_exempt_when_sold	string (boolean)	Indicates if tax exemption is applied.
pricing_method	string	Pricing strategy used.
sale_price_entered_inclusive_of_tax	string (boolean)	Whether the sale price includes tax.
type	string	Type of charge (e.g., ONE_OFF).
name	string	Additional charge property name.
value	string	Additional charge property value.
name	string	Payment property name.
value	string	Payment property value.
discount_profile	object	Discount rules, if defined.
type	string	Type of pricing model (e.g., PER_UNIT_PRICING).
version	string	Version of the pricing configuration.
price	string	Defined unit price.
currency	string	Currency used in pricing.
use_on_sale_price	string (boolean)	If custom sale price is applied.
sale_price_variant	string	Variant method used for pricing.
sale_price	string	Sale-specific price (empty if not active).
start_date	string (date)	Start date of special pricing (empty if not set).
end_date	string (date)	End date of special pricing (empty if not set).

Purpose

This API allows you to configure or update purchase-related settings for a specific item. It enables defining supplier relationships, unit of measurement (UOM) conversions, currency usage, pricing modules, and tax configurations used during the procurement process. By using this API, you can automate how items are purchased, priced, taxed, and managed across multiple suppliers and currencies.

Use Case

This endpoint is primarily used by procurement or inventory management systems to set up item purchase configurations at the time of item creation or update. For example, a procurement manager can enable supplier management, define preferred suppliers, specify purchase pricing in multiple currencies, and establish tax settings for each supplier. It is particularly useful for organizations that manage global purchasing operations where multiple currencies and tax configurations are involved.

Path Parameters

Parameter	Type	Description
item_id	String	Unique identifier of the item whose purchase configuration is being created or updated.

Query Parameters

This API does not accept query parameters.

Request Body

                JSON
              

                      {
  "items": {
    "currencies": [
      {
        "name": "currency_name",
        "default_for_purchase": "boolean_value",
        "used_for_purchase": "boolean_value"
      }
    ],
    "purchase": {
      "enabled": "boolean_value",
      "supplier_management_enabled": "boolean_value",
      "suppliers": [
        {
          "id": "supplier_id",
          "name": "supplier_name",
          "rate_option": "rate_option_type",
          "accounting_code": "accounting_code_name",
          "purchase_order_note": "purchase_note",
          "default_purchase_currency": "currency_code",
          "default_purchase_price": "numeric_value",
          "tax_exempt_when_purchase": "boolean_value",
          "tax_configuration": {
            "purchase_price_entered_inclusive_of_tax": "boolean_value"
          },
          "pricing": {
            "type": "pricing_type",
            "pricing_module": [
              {
                "price": "numeric_value",
                "currency": "currency_code",
                "price_type": "price_type"
              }
            ]
          }
        }
      ]
    }
  }
}
                    

Attribute	Type	Description
items	Object	Root object containing purchase configuration details for the item.
currencies	Array	List of currencies supported for purchasing the item.
name	String	Name or code of the currency (example: AUD, USD).
default_for_purchase	Boolean	Indicates if this currency is the default for purchases.
used_for_purchase	Boolean	Indicates whether this currency can be used for purchases.
purchase	Object	Container for all purchase configuration settings.
enabled	Boolean	Enables or disables purchasing for this item.
supplier_management_enabled	Boolean	Determines if supplier management is enabled.
suppliers	Array	List of suppliers linked to the item for purchasing.
id	String	Unique identifier of the supplier. Leave blank for default.
suppliers.name	String	Supplier name.
rate_option	String	Defines how pricing is applied (example: PER_UNIT).
accounting_code	String	Accounting code associated with the supplier’s purchases.
purchase_order_note	String	Default note to include in purchase orders.
default_purchase_currency	String	Default currency code for purchases from this supplier.
default_purchase_price	String	Default purchase price for the item.
tax_exempt_when_purchase	Boolean	Indicates if the item is tax exempt when purchased.
tax_configuration	Object	Contains tax-related settings for purchases.
purchase_price_entered_inclusive_of_tax	Boolean	Specifies whether purchase prices include tax.
pricing	Object	Defines the pricing model used for supplier purchases.
type	String	Pricing type (example: PER_UNIT_PRICING).
pricing_module	Array	Collection of pricing rules and configurations.
price	String	Price value associated with the rule.
currency	String	Currency for the specified price.
price_type	String	Type of price (example: PRICE, DISCOUNT_PERCENTAGE).

Response

On successful request, the API returns the updated purchase configuration for the specified item, including supplier details, tax configurations, and pricing modules. The response confirms that purchasing has been enabled for the item and reflects all active supplier settings. It provides computed and system-mapped fields such as pricing versions, accounting code mappings, and validated tax structures. A successful response means the item is now ready for procurement operations using the configured parameters.

Response Body

                JSON
              

                      {
  "item": {
    "purchase": {
      "enabled": "boolean_value",
      "supplier_management_enabled": "boolean_value",
      "pricing_profile": {},
      "purchase_properties": [
        {
          "name": "property_name",
          "value": "property_value"
        }
      ],
      "suppliers": [
        {
          "id": "supplier_id",
          "name": "supplier_name",
          "accounting_code": {
            "sales_revenue": "accounting_category"
          },
          "purchase_order_note": "purchase_note",
          "default_purchase_currency": "currency_id",
          "default_purchase_price": "numeric_value",
          "tax_exempt_when_purchase": "boolean_value",
          "tax_configuration": {
            "purchase_price_entered_inclusive_of_tax": "boolean_value",
            "tax_code": {}
          },
          "pricing": {
            "type": "pricing_type",
            "version": "version_number",
            "latest_used_pricing_version": "version_reference",
            "pricing_module": [
              {
                "price": "numeric_value",
                "price_type": "price_type",
                "currency": "currency_code"
              }
            ]
          }
        }
      ]
    }
  }
}
                    

Attribute	Type	Description
item	Object	Root object containing the item’s purchase configuration details.
purchase	Object	Purchase configuration object containing supplier and pricing data.
enabled	Boolean	Indicates whether purchasing is active for this item.
supplier_management_enabled	Boolean	Indicates whether supplier management is active.
pricing_profile	Object	Placeholder object for pricing profile details.
purchase_properties	Array	List of key-value properties that define purchase behavior (example: receive mode, term).
name	String	Name of the purchase property.
value	String	Value assigned to the purchase property.
suppliers	Array	List of supplier configurations associated with this item.
id	String	Supplier identifier.
name	String	Supplier name.
accounting_code	Object	Accounting mappings for supplier-related transactions.
sales_revenue	String	Accounting category used for cost of goods sold.
purchase_order_note	String	Default note attached to purchase orders for the supplier.
default_purchase_currency	String	System identifier for the default currency.
default_purchase_price	String	Default purchase price defined for this supplier.
tax_exempt_when_purchase	Boolean	Indicates if purchases from this supplier are tax exempt.
tax_configuration	Object	Tax configuration for purchases.
purchase_price_entered_inclusive_of_tax	Boolean	Indicates if purchase prices include tax.
tax_code	Object	Tax code details applied to the supplier’s purchases.
pricing	Object	Pricing configuration for the supplier.
type	String	Type of pricing model used (example: PER_UNIT_PRICING).
version	String	Version of the pricing model.
latest_used_pricing_version	String	Reference to the latest applied pricing version.
pricing_module	Array	List of detailed pricing entries.
pricing_module.price	String	The actual price or discount value.
price_type	String	Defines if the entry is a base price or discount percentage.
currency	String	Currency used for this pricing entry.

Purpose

This API is used to deactivate an existing item in the system. Once deactivated, the item becomes unavailable for ordering, and it is visually marked on the user interface with a red dot to indicate its inactive status.

Use Case

Use this endpoint in scenarios where an item must be discontinued, made temporarily unavailable, or archived from the sales catalog. For example, if a product is out of stock indefinitely or no longer part of the business offering, it can be deactivated to prevent accidental ordering and reflect its status clearly in the UI.

Path Parameters

Parameter	Type	Description
item_id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

This endpoint does not require a request body.

Response

Returns a 204 No Content response indicating that the item was successfully deactivated. No response body is returned. Once deactivated, the item will no longer be available for new orders, and its status will be visibly reflected in the UI with a red dot for clear identification.

Response Body

This endpoint does not require a response body.

Purpose

This API reactivates a previously deactivated item, making it eligible for use in sales transactions and removing the visual indicator of deactivation from the UI. It restores the item's active state in the catalog.

Use Case

Use this endpoint when an item that was previously disabled or removed from sale needs to be reinstated. For example, a product that was out of stock or discontinued can be brought back into circulation through reactivation. Once reactivated, it can again be used in order processing and will no longer display the red dot indicator in the user interface.

Path Parameters

Parameter	Type	Description
item_id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

This endpoint does not require a request body.

Response

Returns a 204 No Content response upon successful reactivation. The item becomes active again, available for order placement, and the red dot deactivation indicator is removed from the user interface.

Response Body

This endpoint does not require a response body.

Purpose

This endpoint allows you to create a new note for a specific item, with the option to attach a file. It is used to record additional information, comments, or documentation against an item, while also supporting file attachments for richer context.

Use Case

Add textual notes for better documentation of an item.
Attach files such as receipts, certificates, manuals, or images to an item.
Facilitate collaboration by maintaining notes with associated documents.
Enhance audit trails by logging note content with supporting files.

Path Parameters

Parameter	Type	Required	Description
item_id	string	Yes	Unique identifier of the item to which the note is being added.

Query Parameters

This endpoint does not support query parameters.

Request Body

The request body must be sent as multipart/form-data because it includes both text and file fields.

Attribute	Type	Description
note	string	Content of the note.
file	file	File to attach with the note. Accepts common document and image formats.

Response

On success, the API returns an item object containing the newly created note object with its unique identifier (uuid). This confirms that the note has been successfully created and linked to the specified item. If a file was attached, it is also linked internally to the note, though the response only returns the note’s UUID for reference.

Response Body

                JSON
              

                      {
    "item": {
        "notes": {
            "uuid": "{{note_uuid}}"
        }
    }
}

                    

Attribute	Type	Description
item	object	Container object holding the created note.
itemnotes	object	Object representing the created note.
uuid	string (UUID)	Unique identifier of the newly created note.

Purpose

This API is used to add inventory quantities for a specific item in one or more warehouses. It supports both standard and advanced inventory configurations, including serial or batch tracking, expiry date management, and warehouse-level accounting codes. This operation increases the item’s available stock and updates warehouse level inventory data accordingly.

Use Case

Use this API when you want to record incoming stock for an item. For example, when new stock is received from a supplier, or when manual stock adjustments are needed. It supports inventory addition across multiple warehouses and can handle items with or without serial/batch tracking enabled. This ensures accurate real-time inventory management across the system.

Path Parameters

Parameter	Type	Description
item_id	String	Unique identifier of the item to which inventory is being added.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "item": {
        "inventories": {
            "warehouses": [
                {
                    "name": "WAREHOUSE_NAME",
                    "quantity": "QUANTITY_TO_ADD",
                    "serial_number": "SERIAL_NUMBERS", 
                    "batch_number": "BATCH_NUMBER",
                    "expiry_date": "EXPIRY_DATE",
                    "accounting_code": "ACCOUNTING_CODE"
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
item	Object	Root object containing item inventory information.
inventories	Object	Object containing inventory details to be added.
warehouses	Array	List of warehouse-level inventory entries.
name	String	Name of the warehouse where inventory is added.
quantity	String	Quantity of the item being added.
serial_number	String	Comma-separated list of serial numbers (if serial tracking is enabled).
batch_number	String	Batch identifier for the stock (if batch tracking is enabled).
expiry_date	String	Expiry date of the batch (if applicable).
accounting_code	String	Accounting code used for inventory tracking and ledger mapping.

Response

On success, the API returns the complete updated item record, reflecting the new inventory quantities in the relevant warehouse(s). It includes all item-level metadata such as item status, type, pricing, purchase and sale configurations, and full inventory structure. The inventories object details updated quantities and provides a real-time snapshot of the item’s stock state after addition.

Response Body

                JSON
              

                      {
    "item": {
        "status": "ITEM_STATUS",
        "id": "ITEM_ID",
        "name": "ITEM_NAME",
        "display_name": "ITEM_DISPLAY_NAME",
        "description": "ITEM_DESCRIPTION",
        "type": "ITEM_TYPE",
        "base_uom": "BASE_UNIT_OF_MEASURE",
        "origin": "ITEM_ORIGIN",
        "created_by": "CREATED_BY",
        "created_on": "CREATED_TIMESTAMP",
        "last_updated_by": "LAST_UPDATED_BY",
        "last_updated_on": "LAST_UPDATED_TIMESTAMP",
        "uuid": "ITEM_UUID",
        "version": "ITEM_VERSION",
        "image_uri": "IMAGE_URL",
        "group": {},
        "manager": "ITEM_MANAGER",
        "custom_form": {
            "uuid": "CUSTOM_FORM_UUID",
            "name": "CUSTOM_FORM_NAME"
        },
        "custom_attributes": [],
        "custom_objects": [],
        "codes": [
            {
                "name": "CODE_NAME",
                "value": "CODE_VALUE"
            }
        ],
        "uoms": [],
        "currencies": [
            {
                "name": "CURRENCY_NAME",
                "isUsedForSale": "true",
                "isDefaultForSale": "true",
                "isUsedForPurchase": "true",
                "isDefaultForPurchase": "true"
            }
        ],
        "sale": {
            "isEnabled": "true",
            "invoice_note": "INVOICE_NOTE",
            "accounting_code": {},
            "default_sale_price": "SALE_PRICE",
            "shipping_profile": "SHIPPING_PROFILE",
            "isTaxExemptWhenSold": "false",
            "pricing_method": "STANDARD",
            "tax_configuration": {
                "sale_price_entered_is_inclusive_of_tax": "false"
            },
            "charge": {
                "type": "CHARGE_TYPE",
                "price_period": "PRICE_PERIOD",
                "properties": [
                    {
                        "name": "PROPERTY_NAME",
                        "value": "PROPERTY_VALUE"
                    }
                ]
            },
            "payment_properties": [
                {
                    "name": "PAYMENT_PROPERTY_NAME",
                    "value": "PAYMENT_PROPERTY_VALUE"
                }
            ],
            "discount_profile": {},
            "pricing": {
                "type": "PRICING_TYPE",
                "version": "PRICING_VERSION",
                "latest_used_pricing_version": "LATEST_PRICING_VERSION",
                "pricing_module": []
            }
        },
        "purchase": {
            "isEnabled": "true",
            "supplier_management_isEnabled": "false",
            "purchase_properties": [
                {
                    "name": "PURCHASE_PROPERTY_NAME",
                    "value": "PURCHASE_PROPERTY_VALUE"
                }
            ],
            "suppliers": [
                {
                    "id": "SUPPLIER_ID",
                    "name": "SUPPLIER_NAME",
                    "accounting_code": {},
                    "purchase_order_note": "PURCHASE_NOTE",
                    "default_purchase_currency": "CURRENCY",
                    "default_purchase_price": "PURCHASE_PRICE",
                    "isTaxExemptWhenPurchase": "false",
                    "tax_configuration": {
                        "purchase_price_entered_is_inclusive_of_tax": "true",
                        "tax_code": {}
                    },
                    "pricing": {
                        "type": "PRICING_TYPE",
                        "version": "PRICING_VERSION",
                        "latest_used_pricing_version": "LATEST_PRICING_VERSION",
                        "pricing_module": []
                    }
                }
            ]
        },
        "inventories": {
            "isEnabled": "true",
            "warehouse_isEnabled": "true",
            "warehouses": [
                {
                    "name": "WAREHOUSE_NAME",
                    "uuid": "WAREHOUSE_UUID",
                    "link": "WAREHOUSE_LINK",
                    "quantity_on_hand": "CURRENT_QUANTITY",
                    "quantity_promised": "QUANTITY_PROMISED",
                    "quantity_on_order": "QUANTITY_ON_ORDER",
                    "quantity_on_return": "QUANTITY_ON_RETURN",
                    "quantity_on_purchase_return": "QUANTITY_ON_PURCHASE_RETURN",
                    "quantity_available": "AVAILABLE_QUANTITY",
                    "uom": "UNIT_OF_MEASURE"
                }
            ],
            "inventory_properties": {
                "quantity_available_for_sale_determination": [
                    "QUANTITY_ON_HAND",
                    "QUANTITY_PROMISED",
                    "QUANTITY_ON_ORDER"
                ],
                "quantity_available_for_sale": "QTY_AVAILABLE",
                "enable_low_stock_notification": "false",
                "low_stock_threshold_is_based_on": "",
                "enable_reordering": "false",
                "reordering_threshold_is_based_on": ""
            }
        }
    }
}

                    

Attribute	Type	Description
item	Object	Root object containing item details and updated inventory data.
status	String	Current status of the item (example: ACTIVE).
id	String	Unique system-generated identifier for the item.
name	String	Internal name of the item.
display_name	String	Display name for the item used in UI and invoices.
description	String	Text description of the item.
type	String	Type of item (example: STANDARD, RECURRING).
base_uom	String	Base unit of measure for the item.
uuid	String	Unique universal identifier of the item.
version	String	Version number of the item record.
sale	Object	Contains sale-related configuration and pricing settings.
purchase	Object	Contains purchase-related settings including supplier details.
inventories	Object	Contains current inventory state for the item.
warehouses	Array	List of warehouses with stock quantities and related details.
quantity_on_hand	String	Total quantity physically available in stock.
quantity_available	String	Net available quantity after considering orders and returns.
quantity_on_order	String	Quantity currently on order but not yet received.
inventory_properties	Object	Inventory configuration properties such as low stock and reorder settings.

Purpose

This API is used to configure and enable inventory management for a specific item. It allows users to define warehouse associations, inventory control options (such as low stock and reordering thresholds), serialization, batch tracking, preorder configurations, and other inventory-related properties. By setting these configurations, the platform ensures accurate tracking of item quantities across warehouses, supports proactive inventory management, and aligns stock control with purchasing and sales operations.

Use Case

To enable inventory management for an item and associate it with one or more warehouses.
To configure thresholds for low stock notifications and automatic reordering per warehouse.
To define preorder configurations for upcoming periods (example: months, quarters).
To enable or disable inventory control features like serialization, batch tracking, and inventory costing.
To synchronize available quantities for webhooks and automate reordering logic in warehouse operations.

Path Parameters

Parameter	Type	Description
item_id	String	Unique identifier of the item for which inventory configuration is being set.

Query Parameters

This API does not require any query parameters.

Request Body

                JSON
              

                      {
  "item": {
    "inventories": {
      "isEnabled": "true",
      "warehouse_isEnabled": "true",
      "warehouses": [
        {
          "name": "WAREHOUSE_NAME_1"
        },
        {
          "name": "WAREHOUSE_NAME_2"
        }
      ],
      "default_warehouse": "DEFAULT_WAREHOUSE_NAME",
      "inventory_properties": {
        "enable_low_stock_notification": "true",
        "low_stock_threshold_is_based_on": "THRESHOLD_TYPE",
        "low_stock_threshold_for_individual_warehouses": [
          {
            "warehouse": "WAREHOUSE_NAME_1",
            "low_stock_threshold": "LOW_STOCK_LIMIT"
          },
          {
            "warehouse": "WAREHOUSE_NAME_2",
            "low_stock_threshold": "LOW_STOCK_LIMIT"
          }
        ],
        "enable_reordering": "true",
        "reordering_threshold_is_based_on": "THRESHOLD_TYPE",
        "reordering_threshold_for_individual_warehouses": [
          {
            "warehouse": "WAREHOUSE_NAME_1",
            "use_last_purchase_price": "true",
            "preferred_supplier": "SUPPLIER_ID",
            "reordering_threshold": "REORDER_LIMIT"
          }
        ],
        "enable_preordering": "true",
        "preorder_period": "PERIOD_TYPE",
        "preorder_configuration": [
          {
            "name": "PERIOD_NAME",
            "start_date": "START_DATE",
            "end_date": "END_DATE"
          }
        ],
        "use_last_purchase_price": "true",
        "enable_serialization": "true",
        "enable_batch_tracking": "false",
        "use_atp_as_quantity_available_for_webhook": "true",
        "enable_inventory_costing": "true"
      }
    }
  }
}

                    

Attribute	Type	Description
item	Object	Root object representing the item.
inventories	Object	Contains all inventory configuration settings for the item.
isEnabled	String	Indicates whether inventory management is enabled for the item (true/false).
warehouse_isEnabled	String	Specifies whether warehouse-level tracking is enabled (true/false).
warehouses	Array	List of warehouses associated with the item.
name	String	Name of the warehouse.
default_warehouse	String	Name of the default warehouse for the item.
inventory_properties	Object	Holds detailed configuration for inventory control and behavior.
enable_low_stock_notification	String	Enables notifications when stock reaches a defined threshold (true/false).
low_stock_threshold_is_based_on	String	Defines whether the threshold is applied per warehouse or globally.
low_stock_threshold_for_individual_warehouses	Array	Lists warehouse-specific low stock thresholds.
warehouse	String	Warehouse name for which threshold applies.
low_stock_threshold	String	Numeric value defining the low stock limit.
enable_reordering	String	Enables automatic reordering based on defined thresholds (true/false).
reordering_threshold_is_based_on	String	Determines whether reordering thresholds are warehouse-specific or global.
reordering_threshold_for_individual_warehouses	Array	Lists reordering thresholds per warehouse.
warehouse	String	Warehouse name where reordering threshold applies.
use_last_purchase_price	String	Uses the last purchase price for reorder calculation (true/false).
preferred_supplier	String	Supplier identifier to be used for reorder.
reordering_threshold	String	Quantity threshold to trigger reordering.
enable_preordering	String	Enables preorder functionality for upcoming periods (true/false).
preorder_period	String	Defines how preorder periods are categorized (example: MONTHLY, QUARTERLY).
preorder_configuration	Array	List of preorder period configurations with names and date ranges.
name	String	Descriptive name of the preorder period.
start_date	String	Start date of the preorder period (YYYY-MM-DD).
end_date	String	End date of the preorder period (YYYY-MM-DD).
use_last_purchase_price	String	Enables the system to use the last purchase price for cost valuation.
enable_serialization	String	Enables unique serial number tracking for inventory items (true/false).
enable_batch_tracking	String	Enables batch tracking for grouped inventory units (true/false).
use_atp_as_quantity_available_for_webhook	String	Determines if Available-to-Promise quantity is used in webhook data.
enable_inventory_costing	String	Enables calculation of inventory cost based on item movements (true/false).

Response

Upon successful configuration, the API returns the updated inventory settings for the specified item. The response confirms the warehouses linked to the item, their corresponding UUIDs and stock quantities, as well as applied thresholds for stock alerts and reordering. It also reflects the applied inventory control settings such as low-stock notifications, serialization, and batch tracking preferences. This ensures that the inventory setup is now active and aligned with warehouse-level controls for accurate stock visibility and proactive inventory management.

Response Body

                JSON
              

                      {
  "item": {
    "inventories": {
      "isEnabled": "true",
      "warehouse_isEnabled": "true",
      "warehouses": [
        {
          "name": "WAREHOUSE_NAME_1",
          "uuid": "WAREHOUSE_UUID_1",
          "link": "WAREHOUSE_LINK_1",
          "quantity_on_hand": "0",
          "quantity_promised": "0",
          "quantity_on_order": "0",
          "quantity_on_return": "0",
          "quantity_on_purchase_return": "0",
          "quantity_available": "0",
          "uom": "UNIT_OF_MEASURE"
        },
        {
          "name": "WAREHOUSE_NAME_2",
          "uuid": "WAREHOUSE_UUID_2",
          "link": "WAREHOUSE_LINK_2",
          "quantity_on_hand": "0",
          "quantity_promised": "0",
          "quantity_on_order": "0",
          "quantity_on_return": "0",
          "quantity_on_purchase_return": "0",
          "quantity_available": "0",
          "uom": "UNIT_OF_MEASURE"
        }
      ],
      "inventory_properties": {
        "quantity_available_for_sale_determination": [
          "QUANTITY_ON_HAND",
          "QUANTITY_PROMISED",
          "QUANTITY_ON_ORDER",
          "QUANTITY_ON_RETURN",
          "QUANTITY_ON_PURCHASE_RETURN"
        ],
        "quantity_available_for_sale": "QTY_AVAILABLE",
        "enable_low_stock_notification": "true",
        "low_stock_threshold_is_based_on": "THRESHOLD_TYPE",
        "low_stock_threshold_for_individual_warehouses": [
          {
            "warehouse": "WAREHOUSE_NAME_1",
            "low_stock_threshold": "LOW_STOCK_LIMIT"
          },
          {
            "warehouse": "WAREHOUSE_NAME_2",
            "low_stock_threshold": "LOW_STOCK_LIMIT"
          }
        ],
        "enable_reordering": "true",
        "reordering_threshold_is_based_on": "THRESHOLD_TYPE",
        "reordering_threshold_for_individual_warehouses": [
          {
            "warehouse": "WAREHOUSE_NAME_1",
            "use_last_purchase_price": "true",
            "preferred_supplier": "SUPPLIER_ID",
            "reordering_threshold": "REORDER_LIMIT"
          }
        ]
      }
    }
  }
}

                    

Attribute	Type	Description
item	Object	Root object representing the item.
item.inventories	Object	Contains updated inventory configuration.
warehouses	Array	List of warehouses linked to the item.
warehouses.name	String	Warehouse name.
warehouses.uuid	String	Unique identifier for the warehouse.
warehouses.link	String	API link to the warehouse resource.
quantity_on_hand	String	Quantity physically available in the warehouse.
quantity_promised	String	Quantity committed to orders but not yet fulfilled.
quantity_on_order	String	Quantity expected from suppliers.
quantity_on_return	String	Quantity currently under return processing.
quantity_on_purchase_return	String	Quantity being returned to suppliers.
quantity_available	String	Total available quantity for sale or allocation.
uom	String	Unit of measure used for the item in the warehouse.
inventory_properties	Object	Contains applied configuration for inventory management.
quantity_available_for_sale_determination	Array	Parameters considered to determine available quantity for sale.
quantity_available_for_sale	String	Method used to calculate sale-available stock.
enable_low_stock_notification	String	Indicates if low stock alerts are enabled (true/false).
low_stock_threshold_is_based_on	String	Defines if thresholds are applied globally or per warehouse.
low_stock_threshold_for_individual_warehouses	Array	Lists warehouse-specific low stock limits.
enable_reordering	String	Indicates if automatic reordering is active.
reordering_threshold_is_based_on	String	Defines whether reorder limits are applied globally or individually.
reordering_threshold_for_individual_warehouses	Array	Contains reordering configuration for each warehouse.

Create a New Standard Item: /items

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Configure Standard Sale Information for an Item: /items/{item_id}/sale

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Configure Item Purchase Details: /items/{item_id}/purchase

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Deactivate an Item by ID:/items/{item_id}/deactivate

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Reactivate an Item by ID:/items/{item_id}/reactivate

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Create Item Note: items/{item_id}/notes

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Add Inventory to Item: /items/{item_id}/inventory/add

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Configure Item Inventory: /items/{item_id}/inventory

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body