Item PATCH API Documentation

Purpose

This API allows updating detailed information of an existing item in the system. It supports modifying core attributes such as name, display name, description, origin, invoice notes, and item codes. Optional fields such as custom attributes, base unit of measure (UOM), item group, and manager can also be updated. This ensures accurate item configuration for both operational and reporting purposes.

Use Case

This endpoint is typically used when an existing item record requires updating to reflect new product details or corrections, for example, after rebranding, packaging changes, or product information updates.
It can also be used to maintain synchronization between product master data in integrated systems such as ERP, inventory, or eCommerce platforms.

Path Parameters

Parameter	Type	Description
item_id	String	Unique system-generated identifier of the item to be updated.

Query Parameters

This endpoint does not support query parameters.

Request Body

                JSON
              

                      {
  "item": {
    "name": "item_name",
    "display_name": "item_display_name",
    "description": "item_description",
    "invoice_note": "invoice_note",
    "origin": "item_origin",
    "codes": [
      {
        "name": "code_name_1",
        "value": "code_value_1"
      },
      {
        "name": "code_name_2",
        "value": "code_value_2"
      }
    ]
  }
}
                    

Attribute	Type	Description
item	Object	Root object containing all item details to be updated.
name	String	The name of the item.
display_name	String	The display name of the item, shown in UI or customer-facing interfaces.
description	String	Detailed description of the item.
invoice_note	String	Note or message that appears on invoices related to this item.
origin	String	Origin or source of the item.
codes	Array	List of item identification codes such as UPC or SKU.
name	String	The label of the code (example: “UPC-CODE”, “ITEM-NUMBER”).
value	String	The corresponding value for the code.

Response

The response confirms the successful update of the item’s information and returns the latest item object reflecting all attributes, configuration details, codes, UOMs, currencies, and pricing profiles.
It provides a comprehensive snapshot of the item in its current state, including metadata such as creation and modification timestamps, creator/updater details, and all associated sales, purchase, and custom configurations.

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_uom",
      "origin": "item_origin",
      "invoice_note": "invoice_note",
      "created_by": "created_by",
      "created_on": "created_on_timestamp",
      "last_updated_by": "last_updated_by",
      "last_updated_on": "last_updated_on_timestamp",
      "uuid": "item_uuid",
      "version": "version_number",
      "image_uri": "image_uri",
      "group": {},
      "manager": "manager_name",
      "custom_form": {
        "uuid": "custom_form_uuid",
        "name": "custom_form_name"
      },
      "custom_attributes": [
        {
          "name": "custom_attribute_name",
          "value": "custom_attribute_value"
        }
      ],
      "custom_objects": [
        {
          "name": "custom_object_name",
          "link": "custom_object_link"
        }
      ],
      "codes": [
        {
          "name": "code_name_1",
          "value": "code_value_1"
        },
        {
          "name": "code_name_2",
          "value": "code_value_2"
        }
      ],
      "uoms": [
        {
          "name": "uom_name",
          "base_uom": "is_base_uom",
          "sale_conversion_rate": "sale_conversion_rate",
          "purchase_conversion_rate": "purchase_conversion_rate",
          "used_for_sale": "used_for_sale",
          "used_for_purchase": "used_for_purchase"
        }
      ],
      "currencies": [
        {
          "name": "currency_name",
          "used_for_sale": "used_for_sale",
          "default_for_sale": "default_for_sale",
          "used_for_purchase": "used_for_purchase",
          "default_for_purchase": "default_for_purchase",
          "suppliers": []
        }
      ],
      "sale": {
        "enabled": "sale_enabled",
        "enable_back_order": "enable_back_order",
        "invoice_note": "sale_invoice_note",
        "accounting_code": {},
        "default_sale_price": "default_sale_price",
        "tax_exempt_when_sold": "tax_exempt_when_sold"
      },
      "purchase": {
        "enabled": "purchase_enabled",
        "supplier_management_enabled": "supplier_management_enabled",
        "suppliers": [
          {
            "name": "supplier_name",
            "default_purchase_price": "default_purchase_price",
            "tax_exempt_when_purchase": "tax_exempt_when_purchase"
          }
        ]
      },
      "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
item	Object	Root object representing the updated item.
status	String	Current status of the item (example: ACTIVE).
id	String	Unique system-generated identifier of the item.
name	String	Updated name of the item.
display_name	String	Updated display name of the item.
description	String	Updated description.
type	String	Item type (example: STANDARD).
base_uom	String	Base unit of measurement used for the item.
origin	String	Origin or source of the item.
invoice_note	String	Invoice-related note.
created_by	String	User who originally created the item.
created_on	String	Timestamp when the item was created.
last_updated_by	String	User who last updated the item.
last_updated_on	String	Timestamp when the item was last modified.
uuid	String	Universally unique identifier of the item.
version	String	Current version of the item record.
image_uri	String	URI of the item’s associated image.
codes	Array	List of item codes (example: UPC, ITEM-NUMBER).
name	String	Name or label of the code.
value	String	Code value assigned to the item.
custom_attributes	Array	List of custom attributes configured for this item.
custom_objects	Array	List of custom objects linked to this item.
custom_form	Object	Reference to the custom form associated with this item.
uoms	Array	List of available units of measure for this item.
currencies	Array	List of supported currencies for sales or purchase.
sale	Object	Contains sale-related configuration and pricing details.
purchase	Object	Contains purchase-related configuration, pricing, and suppliers.
kpis	Object	Key performance indicators related to the item’s sales and revenue performance.

Purpose

This API allows users to update the full configuration of an existing item in the system. Unlike partial updates, which modify only specific fields, this endpoint replaces the entire item body with the new data provided. It updates the item’s sales, purchase, and inventory configurations including pricing, dimensional attributes, warehouse settings, and other related details. This ensures that item records remain consistent and accurately reflect their latest business rules, stock management settings, and commercial data.

Use Case

This API is used when user needs to perform a comprehensive update to an item’s configuration. Common scenarios include:

Migrating or synchronizing item data from external systems (example: ERP or product catalog).
Reconfiguring items to apply new pricing, packaging, or warehouse rules.
Updating both sales and purchase properties in a single operation.

Path Parameters

Parameter	Type	Description
item_id	String	Unique identifier of the item whose full details are being updated.

Query Parameters

This API does not require query parameters.

Request Body

                JSON
              

                      {
  "items": {
    "name": "item_name",
    "sale": {
      "isEnabled": "sale_enabled",
      "default_sale_price": default_sale_price,
      "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"
      },
      "charge": {
        "type": "charge_type"
      },
      "pricing": {
        "type": "pricing_type"
      }
    },
    "purchase": {
      "isEnabled": "purchase_enabled",
      "default_purchase_price": default_purchase_price,
      "pricing": {
        "type": "purchase_pricing_type"
      }
    },
    "inventories": {
      "isEnabled": "inventory_enabled",
      "warehouse_isEnabled": "warehouse_enabled",
      "warehouses": [
        {
          "name": "warehouse_name"
        }
      ],
      "inventory_properties": {
        "quantity_available_for_sale_determination": [
          "quantity_param_1",
          "quantity_param_2"
        ],
        "quantity_available_for_sale": "quantity_setting"
      }
    }
  }
}
                    

Attribute	Type	Description
items	Object	Root object containing the full item configuration to be updated.
name	String	The name of the item.
sale	Object	Contains all sale-related configurations for the item.
isEnabled	Boolean	Indicates whether the item is available for sale.
default_sale_price	Number	Default unit sale price for the item.
width	Object	Item width details with unit of measure and value.
height	Object	Item height details with unit of measure and value.
length	Object	Item length details with unit of measure and value.
weight	Object	Item weight details with unit of measure and value.
charge	Object	Defines the charge type for item sale (example: ONE_OFF).
pricing	Object	Defines pricing strategy for sale (example: PER_UNIT_PRICING).
purchase	Object	Contains purchase-related configurations.
isEnabled	Boolean	Indicates whether the item is enabled for purchase.
default_purchase_price	Number	Default unit purchase price for the item.
pricing	Object	Defines pricing type for purchase.
inventories	Object	Contains inventory-related configuration and warehouse setup.
isEnabled	Boolean	Enables or disables inventory tracking for the item.
warehouse_isEnabled	Boolean	Enables warehouse-level inventory management.
warehouses	Array	List of warehouses where the item is stored.
name	String	Warehouse name.
inventory_properties	Object	Configuration for how inventory quantities are calculated and managed.
quantity_available_for_sale_determination	Array	Defines the parameters used to calculate available quantity (example: QUANTITY_ON_HAND).
quantity_available_for_sale	String	Determines availability rule (example: UNLIMITED).

Response

The response confirms that the item has been successfully updated with the provided full configuration. It returns the complete updated item record, including details of its sale, purchase, and inventory configurations.
The response also includes metadata like item identifiers, version control information, custom attributes, pricing, tax configuration, warehouse stock details, and associated links, ensuring a complete representation of the item in its latest state.

Response Body

                JSON
              

                      {
  "item": {
    "status": "item_status",
    "id": "item_id",
    "name": "item_name",
    "display_name": "display_name",
    "description": "description",
    "type": "item_type",
    "base_uom": "base_uom",
    "origin": "origin",
    "created_by": "created_by",
    "created_on": "created_on_timestamp",
    "last_updated_by": "last_updated_by",
    "last_updated_on": "last_updated_on_timestamp",
    "uuid": "item_uuid",
    "version": "version_number",
    "sale": {
      "isEnabled": "sale_enabled",
      "default_sale_price": "default_sale_price",
      "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"
      },
      "charge": {
        "type": "charge_type"
      },
      "pricing": {
        "type": "pricing_type"
      }
    },
    "purchase": {
      "isEnabled": "purchase_enabled",
      "default_purchase_price": "default_purchase_price",
      "pricing": {
        "type": "purchase_pricing_type"
      }
    },
    "inventories": {
      "isEnabled": "inventory_enabled",
      "warehouse_isEnabled": "warehouse_enabled",
      "warehouses": [
        {
          "name": "warehouse_name",
          "uuid": "warehouse_uuid",
          "link": "warehouse_link",
          "quantity_on_hand": "quantity_on_hand",
          "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": "quantity_available",
          "uom": "warehouse_uom"
        }
      ],
      "inventory_properties": {
        "quantity_available_for_sale_determination": [
          "quantity_param_1",
          "quantity_param_2"
        ],
        "quantity_available_for_sale": "quantity_setting"
      }
    }
  }
}
                    

Attribute	Type	Description
item	Object	Root object containing updated item details.
status	String	Current status of the item (example: ACTIVE).
id	String	Unique system-generated identifier of the item.
name	String	Updated item name.
display_name	String	Display name of the item.
description	String	Description of the item.
type	String	Type of item (example: STANDARD).
base_uom	String	Base unit of measurement used for the item.
origin	String	Origin or source of the item.
created_by	String	User who created the item.
created_on	String	Creation timestamp.
last_updated_by	String	User who last modified the item.
last_updated_on	String	Last update timestamp.
uuid	String	Universally unique identifier of the item.
version	String	Version number of the item record.
sale	Object	Updated sale configuration details.
isEnabled	Boolean	Indicates if item is enabled for sale.
default_sale_price	String	Default sale price.
width	Object	Width dimension with unit and value.
height	Object	Height dimension with unit and value.
length	Object	Length dimension with unit and value.
weight	Object	Weight dimension with unit and value.
charge	Object	Charge configuration for the item.
pricing	Object	Pricing configuration for the item.
purchase	Object	Updated purchase configuration details.
isEnabled	Boolean	Indicates if item is enabled for purchase.
default_purchase_price	String	Default purchase price.
pricing	Object	Purchase pricing configuration.
inventories	Object	Updated inventory configuration.
isEnabled	Boolean	Enables inventory tracking.
warehouse_isEnabled	Boolean	Enables warehouse management.
warehouses	Array	List of warehouses and related quantities.
name	String	Name of the warehouse.
quantity_on_hand	String	Quantity currently on hand.
quantity_available	String	Quantity available for sale.
inventory_properties	Object	Inventory rules and calculations configuration.
quantity_available_for_sale_determination	Array	Quantity determination rules.
quantity_available_for_sale	String	Availability configuration rule (example: UNLIMITED).

Purpose

This API allows updating the purchase configuration of a specific item within the Exsited platform. It enables users to modify or define details related to purchasing behavior, such as supplier settings, purchase pricing, tax configurations, purchase currencies, and UOMs. Depending on the flag, the request can either update a general purchase profile or detailed supplier-specific configurations.

Use Case

When user wants to enable or update purchase management for an item, including pricing, suppliers, and tax configurations.
When multiple suppliers are linked to a single item and the purchase data must reflect different pricing models.
When enabling or disabling supplier management for items used in procurement workflows.

Path Parameters

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

Query Parameters

This endpoint does not accept any query parameters.

Request Body

                WIth Supplier
              

                Without Supplier
              

                      {
  "item": {
    "currencies": [
      {
        "name": "currency_name_1",
        "default_for_purchase": "boolean",
        "used_for_purchase": "boolean"
      },
      {
        "name": "currency_name_2",
        "default_for_purchase": "boolean",
        "used_for_purchase": "boolean"
      }
    ],
    "purchase": {
      "enabled": "boolean",
      "supplier_management_enabled": "boolean",
      "suppliers": [
        {
          "id": "supplier_id",
          "name": "supplier_name",
          "rate_option": "rate_option",
          "accounting_code": "accounting_code",
          "purchase_order_note": "note",
          "default_purchase_currency": "currency",
          "default_purchase_price": "price",
          "tax_exempt_when_purchase": "boolean",
          "pricing": {
            "type": "pricing_type",
            "pricing_module": [
              {
                "price": "price_value",
                "currency": "currency",
                "price_type": "price_type"
              }
            ]
          }
        }
      ]
    }
  }
}
                    

                      {
  "item": {
    "uoms": [
      {
        "name": "uom_name_1",
        "purchase_conversion_rate": "rate",
        "used_for_purchase": "boolean"
      },
      {
        "name": "uom_name_2",
        "purchase_conversion_rate": "rate",
        "used_for_purchase": "boolean"
      }
    ],
    "currencies": [
      {
        "name": "currency_name_1",
        "default_for_purchase": "boolean",
        "used_for_purchase": "boolean"
      },
      {
        "name": "currency_name_2",
        "default_for_purchase": "boolean",
        "used_for_purchase": "boolean"
      }
    ],
    "purchase": {
      "enabled": "boolean",
      "rate_option": "rate_option",
      "supplier_management_enabled": "boolean",
      "accounting_code": "accounting_code",
      "purchase_order_note": "note",
      "default_purchase_price": "price",
      "tax_exempt_when_purchase": "boolean",
      "pricing_profile": "pricing_profile_name",
      "purchase_properties": [
        {
          "name": "property_name",
          "value": "property_value"
        }
      ],
      "tax_configuration": {
        "purchase_price_entered_inclusive_of_tax": "boolean"
      },
      "pricing": {
        "type": "pricing_type",
        "pricing_module": [
          {
            "price": "price_value",
            "currency": "currency",
            "price_type": "price_type"
          }
        ]
      }
    }
  }
}
                    

Attribute	Type	Description
item	Object	Root object containing all item-related purchase data.
currencies	Array	List of currencies applicable for item purchase.
name	String	Name of the currency (example: AUD, USD).
default_for_purchase	Boolean	Marks the default currency for purchase transactions.
used_for_purchase	Boolean	Indicates if the currency is available for purchase.
purchase	Object	Contains purchase configuration settings for the item.
enabled	Boolean	Enables or disables purchase management for the item.
supplier_management_enabled	Boolean	Determines if multiple supplier management is enabled.
suppliers	Array	List of suppliers linked to the item (if supplier management is enabled).
id	String	Unique identifier of the supplier account.
name	String	Supplier name.
rate_option	String	Defines how supplier pricing is calculated (example: PER_UNIT).
accounting_code	String	Accounting code for the supplier transactions.
purchase_order_note	String	Purchase order note for supplier transactions.
default_purchase_currency	String	Default currency used for purchase from this supplier.
default_purchase_price	Number	Default purchase price for the supplier in specified currency.
tax_exempt_when_purchase	Boolean	Indicates whether the item is tax-exempt when purchased.
pricing	Object	Pricing configuration object for supplier.
type	String	Pricing type (example: PER_UNIT_PRICING).
pricing_module	Array	List of pricing modules defining price per currency or UOM.
price	Number	Purchase price value.
currency	String	Currency of the purchase price.
price_type	String	Type of the price (example: PRICE).

Response

When the request is successful, the API returns a 200 OK response with the full updated item object reflecting the new purchase configurations. The response structure includes comprehensive item details such as identifiers, UOMs, currencies, sales and purchase configurations, suppliers (if enabled), inventory information, and KPI metrics. If supplier management is enabled, the response includes supplier-specific purchase and pricing data. If supplier management is disabled, it includes only general purchase configuration without supplier details.

Response Body

                JSON
              

                      [
  {
    "item": {
      "id": "item_id",
      "name": "item_name",
      "type": "item_type",
      "status": "status",
      "currencies": [
        {
          "name": "currency_name",
          "used_for_purchase": "boolean",
          "default_for_purchase": "boolean"
        }
      ],
      "purchase": {
        "enabled": "boolean",
        "supplier_management_enabled": "boolean",
        "accounting_code": "accounting_code",
        "default_purchase_price": "price",
        "suppliers": [
          {
            "name": "supplier_name",
            "default_purchase_price": "price",
            "default_purchase_currency": "currency",
            "pricing": {
              "type": "pricing_type",
              "pricing_module": [
                {
                  "price": "price_value",
                  "currency": "currency",
                  "price_type": "price_type"
                }
              ]
            }
          }
        ]
      },
      "inventories": {
        "enabled": "boolean",
        "warehouses": [
          {
            "name": "warehouse_name",
            "quantity_on_hand": "quantity",
            "quantity_available": "quantity"
          }
        ]
      }
    }
  }
]
                    

Attribute	Type	Description
item	Object	Contains complete details of the updated item.
id	String	Unique identifier of the updated item.
name	String	Name of the item.
type	String	Item type (example: STANDARD).
status	String	Current status of the item (example: ACTIVE).
currencies	Array	Currencies available for purchase and sale.
name	String	Currency name (example: AUD, USD).
used_for_purchase	Boolean	Indicates if currency is active for purchase.
default_for_purchase	Boolean	Marks the default purchase currency.
purchase	Object	Contains purchase configuration details.
enabled	Boolean	Purchase management enabled flag.
supplier_management_enabled	Boolean	Indicates if multiple supplier management is active.
accounting_code	Object/String	Accounting code assigned to purchase transactions.
default_purchase_price	Number	Default purchase price for the item.
suppliers	Array	List of supplier objects (if enabled).
name	String	Supplier name.
default_purchase_currency	String	Default purchase currency of the supplier.
default_purchase_price	Number	Supplier-specific purchase price.
pricing	Object	Pricing configuration for the supplier.
type	String	Pricing type (example: PER_UNIT_PRICING).
pricing_module	Array	Pricing module data.
price	Number	Price value.
currency	String	Currency of the price.
price_type	String	Type of price (example: PRICE).
inventories	Object	Inventory configuration details for the item.
enabled	Boolean	Indicates whether inventory tracking is active.
warehouses	Array	List of warehouses linked to the item.
name	String	Warehouse name.
quantity_on_hand	Number	Quantity on hand in the warehouse.
quantity_available	Number	Quantity available for sale or purchase.

Purpose

This API updates the sale-related configuration of an item. It allows modification of currencies, pricing structure, sale settings, tax rules, charge configuration, and sale-period metadata such as start and end dates. This endpoint is used to maintain how an item behaves when sold, including pricing logic, charge structures, tax exemptions, and availability settings.

Use Case

Use this API when you need to:

Enable or disable an item for sale
Configure item pricing (per unit pricing, volume pricing, fixed pricing, or profile-based pricing)
Define sale currencies and defaults
Apply charge configurations such as one-off or recurring billing
Set tax-related behavior for sale transactions
Provide date-bound sale pricing such as promotional periods
Update sale price variants and sale price rules

Path Parameters

Parameter	Type	Description
item_id	string	Unique identifier of the item to be updated.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "item": {
        "currencies": [
            {
                "name": "CURRENCY_NAME",
                "default_for_sale": "BOOLEAN_VALUE",
                "used_for_sale": "BOOLEAN_VALUE"
            }
        ],
        "sale": {
            "enabled": "BOOLEAN_VALUE",
            "tax_exempt_when_sold": "BOOLEAN_VALUE",
            "charge": {
                "type": "CHARGE_TYPE"
            },
            "pricing": {
                "type": "PRICING_TYPE",
                "pricing_module": [
                    {
                        "price": "PRICE_VALUE",
                        "currency": "CURRENCY_NAME"
                    }
                ]
            },
            "use_on_sale_price": "BOOLEAN_VALUE",
            "sale_price_variant": "SALE_PRICE_VARIANT",
            "sale_price": "SALE_PRICE_VALUE",
            "start_date": "START_DATE_VALUE",
            "end_date": "END_DATE_VALUE"
        }
    }
}

                    

Attribute	Type	Description
item	object	Main wrapper containing all sale-related configuration fields.
currencies	array	List of currencies configured for the item.
name	string	Currency name (example: AUD).
default_for_sale	string	Indicates if this is the default sale currency.
used_for_sale	string	Indicates whether this currency can be used for sale pricing.
sale	object	Sale configuration settings of the item.
enabled	string	Enables or disables the item for sale.
tax_exempt_when_sold	string	Indicates whether tax is exempt when the item is sold.
charge	object	Defines the charge type for sale billing.
type	string	Type of charge (example: ONE_OFF).
pricing	object	Pricing configuration for the item.
type	string	Pricing method used for the item.
pricing_module	array	List of pricing entries specifying price and currency.
price	string	Unit price in the specified currency.
currency	string	Currency associated with the price.
use_on_sale_price	string	Indicates whether on-sale price rules apply.
sale_price_variant	string	Variant used to determine sale price.
sale_price	string	Sale price value.
start_date	string	Start date of the sale period.
end_date	string	End date of the sale period.

Response

The response returns an array containing the fully updated item object, reflecting the modified sale configuration along with all other item properties. It provides complete visibility into the updated state, including metadata, pricing information, sale configuration, purchase configuration, inventory details, and KPIs. This allows clients to confirm changes, display updated item data immediately in user interfaces, and maintain item consistency across dependent modules.

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_UOM",
            "origin": "ITEM_ORIGIN",
            "invoice_note": "INVOICE_NOTE",
            "created_by": "CREATED_BY",
            "created_on": "CREATED_TIMESTAMP",
            "last_updated_by": "UPDATED_BY",
            "last_updated_on": "UPDATED_TIMESTAMP",
            "uuid": "ITEM_UUID",
            "version": "ITEM_VERSION",
            "image_uri": "IMAGE_URI",
            "group": {},
            "manager": "ITEM_MANAGER",
            "custom_form": {
                "uuid": "FORM_UUID",
                "name": "FORM_NAME"
            },
            "custom_attributes": [],
            "custom_objects": [],
            "codes": [
                {
                    "name": "CODE_NAME",
                    "value": "CODE_VALUE"
                }
            ],
            "uoms": [],
            "currencies": [
                {
                    "name": "CURRENCY_NAME",
                    "used_for_sale": "BOOLEAN_VALUE",
                    "default_for_sale": "BOOLEAN_VALUE",
                    "used_for_purchase": "BOOLEAN_VALUE",
                    "default_for_purchase": "BOOLEAN_VALUE"
                }
            ],
            "sale": {
                "enabled": "BOOLEAN_VALUE",
                "enable_back_order": "BOOLEAN_VALUE",
                "invoice_note": "INVOICE_NOTE_VALUE",
                "accounting_code": {},
                "default_sale_price": "DEFAULT_SALE_PRICE",
                "shipping_profile": "SHIPPING_PROFILE",
                "tax_exempt_when_sold": "BOOLEAN_VALUE",
                "pricing_method": "PRICING_METHOD",
                "tax_configuration": {
                    "sale_price_entered_inclusive_of_tax": "BOOLEAN_VALUE"
                },
                "charge": {
                    "type": "CHARGE_TYPE",
                    "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": 0,
                    "pricing_module": [
                        {
                            "price": "PRICE_VALUE",
                            "currency": "CURRENCY_NAME",
                            "last_purchase_price": "LAST_PURCHASE_PRICE",
                            "average_purchase_price": "AVERAGE_PURCHASE_PRICE"
                        }
                    ]
                },
                "use_on_sale_price": "BOOLEAN_VALUE",
                "sale_price_variant": "SALE_PRICE_VARIANT",
                "sale_price": "SALE_PRICE_VALUE",
                "start_date": "START_DATE_VALUE",
                "end_date": "END_DATE_VALUE"
            },
            "purchase": {
                "enabled": "BOOLEAN_VALUE",
                "supplier_management_enabled": "BOOLEAN_VALUE",
                "accounting_code": {},
                "purchase_order_note": "PURCHASE_ORDER_NOTE",
                "default_purchase_price": "DEFAULT_PURCHASE_PRICE",
                "tax_configuration": {
                    "purchase_price_entered_inclusive_of_tax": "BOOLEAN_VALUE",
                    "tax_code": {}
                },
                "purchase_properties": [
                    {
                        "name": "PURCHASE_PROPERTY_NAME",
                        "value": "PURCHASE_PROPERTY_VALUE"
                    }
                ],
                "pricing": {
                    "type": "PRICING_TYPE",
                    "version": "PRICING_VERSION",
                    "latest_used_pricing_version": 0,
                    "pricing_module": []
                }
            },
            "inventories": {
                "enabled": "BOOLEAN_VALUE",
                "enable_warehouse_management": "BOOLEAN_VALUE",
                "warehouses": [
                    {
                        "name": "WAREHOUSE_NAME",
                        "uuid": "WAREHOUSE_UUID",
                        "link": "WAREHOUSE_LINK",
                        "quantity_on_hand": "QUANTITY_ON_HAND",
                        "quantity_on_hand_value": "QUANTITY_ON_HAND_VALUE",
                        "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": "QUANTITY_AVAILABLE",
                        "quantity_available_value": "QUANTITY_AVAILABLE_VALUE",
                        "uom": "WAREHOUSE_UOM"
                    }
                ],
                "default_warehouse": "DEFAULT_WAREHOUSE",
                "inventory_properties": {
                    "enable_low_stock_notification": "BOOLEAN_VALUE",
                    "low_stock_threshold_based_on": "THRESHOLD_TYPE",
                    "enable_reordering": "BOOLEAN_VALUE",
                    "reordering_threshold_based_on": "REORDER_TYPE",
                    "quantity_available_for_sale_determination": [
                        "QUANTITY_RULE"
                    ],
                    "quantity_available_for_sale": "QUANTITY_AVAILABLE_TYPE",
                    "enable_preorder": "BOOLEAN_VALUE",
                    "preorder_period": "PREORDER_PERIOD",
                    "preorder_configuration": [],
                    "enable_serialization": "BOOLEAN_VALUE",
                    "enable_batch_tracking": "BOOLEAN_VALUE",
                    "enable_inventory_costing": "BOOLEAN_VALUE",
                    "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN_VALUE",
                    "default_cost_per_unit": "DEFAULT_UNIT_COST"
                }
            },
            "kpis": {
                "total_orders": 0,
                "active_orders": 0,
                "total_revenue": 0,
                "total_collected": 0,
                "total_outstanding": 0,
                "total_overdue": 0
            }
        }
    }
]

                    

Attribute	Type	Description
item	object	The complete updated item record.
status	string	Status of the item.
id	string	Human-readable item ID.
name	string	Internal name of the item.
display_name	string	Public-facing name of the item.
description	string	Description of the item.
type	string	Item classification type.
base_uom	string	Base unit of measure.
origin	string	Item origin identifier.
invoice_note	string	Default invoice note.
created_by	string	User who created the item.
created_on	string	Timestamp when the item was created.
last_updated_by	string	User who last updated the item.
last_updated_on	string	Timestamp of the last update.
uuid	string	Unique identifier for the item.
version	string	Version of the item object.
image_uri	string	Image link of the item.
group	object	Item group information.
manager	string	Item manager.
custom_form	object	Metadata of associated custom form.
codes	array	List of item codes.
currencies	array	Currency configuration of the item.
sale	object	Sale configuration after update.
purchase	object	Purchase configuration.
inventories	object	Inventory details.
kpis	object	KPIs associated with the item.

Purpose

This API updates the inventory configuration settings of an item. It allows modifying warehouse settings, enabling inventory tracking, configuring stock thresholds, controlling preordering rules, managing reordering logic, and updating warehouse lists. This endpoint synchronizes how an item behaves within the inventory management module, ensuring accurate stock tracking, replenishment, and availability rules.

Use Case

Use this API when you need to:

Enable/disable inventory management for an item
Add, remove, or update warehouses for the item
Set default warehouse
Configure low stock notifications and thresholds (global or per warehouse)
Configure reordering logic and preferred suppliers
Define how quantity available for sale is calculated
Configure preorder periods and schedules

Path Parameters

Parameter	Type	Description
item_id	string	Unique identifier of the item whose inventory configuration is being updated.

Query Parameters

This API does not accept query parameters.

Request Body

                JSON
              

                      {
    "item": {
        "inventories": {
            "enabled": "BOOLEAN_VALUE",
            "warehouse_enabled": "BOOLEAN_VALUE",
            "warehouses": [
                {
                    "name": "WAREHOUSE_NAME_1"
                },
                {
                    "name": "WAREHOUSE_NAME_2"
                }
            ],
            "default_warehouse": "DEFAULT_WAREHOUSE_NAME",
            "inventory_properties": {
                "enable_low_stock_notification": "BOOLEAN_VALUE",
                "low_stock_threshold_based_on": "THRESHOLD_TYPE",
                "low_stock_threshold_for_individual_warehouses": [
                    {
                        "warehouse": "WAREHOUSE_NAME",
                        "low_stock_threshold": "THRESHOLD_VALUE"
                    }
                ],
                "enable_reordering": "BOOLEAN_VALUE",
                "reordering_threshold_based_on": "REORDER_TYPE",
                "reordering_threshold_for_individual_warehouses": [
                    {
                        "warehouse": "WAREHOUSE_NAME",
                        "use_last_purchase_price": "BOOLEAN_VALUE",
                        "preferred_supplier": "SUPPLIER_CODE",
                        "reordering_threshold": "THRESHOLD_VALUE"
                    }
                ],
                "quantity_available_for_sale_determination": "QUANTITY_RULE",
                "quantity_available_for_sale": "AVAILABILITY_TYPE",
                "enable_preordering": "BOOLEAN_VALUE",
                "preorder_period": "PERIOD_TYPE",
                "preorder_configuration": [
                    {
                        "name": "PREORDER_NAME",
                        "start_date": "START_DATE",
                        "end_date": "END_DATE"
                    }
                ],
                "use_last_purchase_price": "BOOLEAN_VALUE",
                "enable_serialization": "BOOLEAN_VALUE",
                "enable_batch_tracking": "BOOLEAN_VALUE",
                "use_atp_as_quantity_available_for_webhook": "BOOLEAN_VALUE",
                "enable_inventory_costing": "BOOLEAN_VALUE"
            }
        }
    }
}

                    

Attribute	Type	Description
item	object	The complete updated item record.
status	string	Status of the item.
id	string	Human-readable item ID.
name	string	Internal name of the item.
display_name	string	Public-facing name of the item.
description	string	Description of the item.
type	string	Item classification type.
base_uom	string	Base unit of measure.
origin	string	Item origin identifier.
invoice_note	string	Default invoice note.
created_by	string	User who created the item.
created_on	string	Timestamp when the item was created.
last_updated_by	string	User who last updated the item.
last_updated_on	string	Timestamp of the last update.
uuid	string	Unique identifier for the item.
version	string	Version of the item object.
image_uri	string	Image link of the item.
group	object	Item group information.
manager	string	Item manager.
custom_form	object	Metadata of associated custom form.
codes	array	List of item codes.
currencies	array	Currency configuration of the item.
sale	object	Sale configuration after update.
purchase	object	Purchase configuration.
inventories	object	Inventory details.
kpis	object	KPIs associated with the item.

Response

The API returns an array containing the fully updated item object with complete inventory configuration, warehouse data, stock quantities, and system properties. The response also includes all other item-level metadata such as sale configuration, purchase configuration, pricing, KPIs, and custom attributes. This allows clients to instantly see the updated inventory structure, stock figures for each warehouse, and all applied rules related to notifications, reordering, costing, and tracking.

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_UOM",
            "origin": "ITEM_ORIGIN",
            "invoice_note": "INVOICE_NOTE",
            "created_by": "CREATED_BY",
            "created_on": "CREATED_TIMESTAMP",
            "last_updated_by": "UPDATED_BY",
            "last_updated_on": "UPDATED_TIMESTAMP",
            "uuid": "ITEM_UUID",
            "version": "ITEM_VERSION",
            "image_uri": "IMAGE_URI",
            "group": {},
            "manager": "ITEM_MANAGER",
            "custom_form": {
                "uuid": "FORM_UUID",
                "name": "FORM_NAME"
            },
            "custom_attributes": [],
            "custom_objects": [],
            "codes": [
                {
                    "name": "CODE_NAME_1",
                    "value": "CODE_VALUE_1"
                },
                {
                    "name": "CODE_NAME_2",
                    "value": "CODE_VALUE_2"
                }
            ],
            "uoms": [],
            "currencies": [
                {
                    "name": "CURRENCY_NAME",
                    "used_for_sale": "BOOLEAN_VALUE",
                    "default_for_sale": "BOOLEAN_VALUE",
                    "used_for_purchase": "BOOLEAN_VALUE",
                    "default_for_purchase": "BOOLEAN_VALUE"
                }
            ],
            "sale": {
                "enabled": "BOOLEAN_VALUE",
                "enable_back_order": "BOOLEAN_VALUE",
                "invoice_note": "SALE_INVOICE_NOTE",
                "accounting_code": {},
                "default_sale_price": "SALE_PRICE_VALUE",
                "shipping_profile": "SHIPPING_PROFILE",
                "tax_exempt_when_sold": "BOOLEAN_VALUE",
                "pricing_method": "PRICING_METHOD",
                "tax_configuration": {
                    "sale_price_entered_inclusive_of_tax": "BOOLEAN_VALUE"
                },
                "charge": {
                    "type": "CHARGE_TYPE",
                    "properties": [
                        {
                            "name": "CHARGE_PROPERTY_NAME",
                            "value": "CHARGE_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": 0,
                    "pricing_module": [
                        {
                            "price": "PRICE_VALUE",
                            "currency": "CURRENCY_NAME",
                            "last_purchase_price": "LAST_PURCHASE_PRICE",
                            "average_purchase_price": "AVERAGE_PURCHASE_PRICE"
                        }
                    ]
                },
                "use_on_sale_price": "BOOLEAN_VALUE",
                "sale_price_variant": "SALE_PRICE_VARIANT",
                "sale_price": "SALE_PRICE_VALUE",
                "start_date": "START_DATE",
                "end_date": "END_DATE"
            },
            "purchase": {
                "enabled": "BOOLEAN_VALUE",
                "supplier_management_enabled": "BOOLEAN_VALUE",
                "accounting_code": {},
                "purchase_order_note": "PURCHASE_ORDER_NOTE",
                "default_purchase_price": "PURCHASE_PRICE_VALUE",
                "tax_configuration": {
                    "purchase_price_entered_inclusive_of_tax": "BOOLEAN_VALUE",
                    "tax_code": {}
                },
                "purchase_properties": [
                    {
                        "name": "PURCHASE_PROPERTY_NAME",
                        "value": "PURCHASE_PROPERTY_VALUE"
                    }
                ],
                "pricing": {
                    "type": "PRICING_TYPE",
                    "version": "PRICING_VERSION",
                    "latest_used_pricing_version": 0,
                    "pricing_module": []
                }
            },
            "inventories": {
                "enabled": "BOOLEAN_VALUE",
                "enable_warehouse_management": "BOOLEAN_VALUE",
                "warehouses": [
                    {
                        "name": "WAREHOUSE_NAME",
                        "uuid": "WAREHOUSE_UUID",
                        "link": "WAREHOUSE_LINK",
                        "quantity_on_hand": "QTY_ON_HAND",
                        "quantity_on_hand_value": "QTY_ON_HAND_VALUE",
                        "quantity_promised": "QTY_PROMISED",
                        "quantity_on_order": "QTY_ON_ORDER",
                        "quantity_on_return": "QTY_ON_RETURN",
                        "quantity_on_purchase_return": "QTY_ON_PURCHASE_RETURN",
                        "quantity_available": "QTY_AVAILABLE",
                        "quantity_available_value": "QTY_AVAILABLE_VALUE",
                        "uom": "WAREHOUSE_UOM"
                    }
                ],
                "default_warehouse": "DEFAULT_WAREHOUSE_NAME",
                "inventory_properties": {
                    "enable_low_stock_notification": "BOOLEAN_VALUE",
                    "low_stock_threshold_based_on": "THRESHOLD_TYPE",
                    "low_stock_threshold_for_individual_warehouses": [
                        {
                            "warehouse": "WAREHOUSE_NAME",
                            "low_stock_threshold": "THRESHOLD_VALUE"
                        }
                    ],
                    "enable_reordering": "BOOLEAN_VALUE",
                    "reordering_threshold_based_on": "REORDER_TYPE",
                    "reordering_threshold_for_individual_warehouses": [
                        {
                            "warehouse": "WAREHOUSE_NAME",
                            "use_last_purchase_price": "BOOLEAN_VALUE",
                            "preferred_supplier": "SUPPLIER_CODE",
                            "reordering_threshold": "THRESHOLD_VALUE"
                        }
                    ],
                    "quantity_available_for_sale_determination": [
                        "QUANTITY_RULE"
                    ],
                    "quantity_available_for_sale": "AVAILABILITY_TYPE",
                    "enable_preorder": "BOOLEAN_VALUE",
                    "preorder_period": "PERIOD_TYPE",
                    "preorder_configuration": [],
                    "enable_serialization": "BOOLEAN_VALUE",
                    "enable_batch_tracking": "BOOLEAN_VALUE",
                    "enable_inventory_costing": "BOOLEAN_VALUE",
                    "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN_VALUE",
                    "default_cost_per_unit": "COST_VALUE"
                }
            },
            "kpis": {
                "total_orders": 0,
                "active_orders": 0,
                "total_revenue": 0,
                "total_collected": 0,
                "total_outstanding": 0,
                "total_overdue": 0
            }
        }
    }
]

                    

Attribute	Type	Description
item	object	Complete updated item record.
status	string	Current status of the item.
id	string	Display ID of the item.
name	string	Item name.
display_name	string	Public-facing display name.
description	string	Detailed item description.
type	string	Type/classification of the item.
base_uom	string	Base unit of measure.
origin	string	Item origin info.
created_by	string	Creator of the item.
created_on	string	Item creation timestamp.
last_updated_by	string	User who last updated the record.
last_updated_on	string	Timestamp of last update.
uuid	string	System-level UUID of the item.
version	string	Version counter.
custom_form	object	Associated custom form metadata.
codes	array	Item codes such as SKU, UPC.
currencies	array	Currency configuration.
sale	object	Sale configuration of the item.
purchase	object	Purchase configuration.
inventories	object	Inventory configuration and warehouse data.
enabled	string	Whether inventory is enabled.
enable_warehouse_management	string	Whether warehouse features are enabled.
warehouses	array	List of warehouses with stock details.
inventory_properties	object	Full inventory settings including thresholds and tracking.
kpis	object	Operational KPIs of the item.

Update Item Information: /items/{item_id}/information

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update Complete Item Details: /items/{item_id}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

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

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update Item Sale Configuration: /items/{item_id}/sale

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update Item Inventory Configuration: /items/{item_id}/inventories

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body