Item GET API Documentation

Purpose

Retrieve a paginated list of items available in the system.

Use Case

Used by frontend or integration systems to list items for display, selection, or reporting purposes.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Name	Type	Description
order_by	string	Field to sort by (e.g., name)
direction	string	asc or desc for sort direction
type	string	Filter by item type (e.g., STANDARD)
limit	int	Number of records to return
offset	int	Record offset for pagination

Response

Returns a list of items and pagination metadata. The response contains a detailed list of items, each representing a product with full configuration. Each item includes key attributes such as id, name, status, type (e.g., STANDARD), and base_uom (e.g., UNIT). Metadata like created_by, timestamps, uuid, and version support auditability. Items may include custom_form, custom_attributes, codes (e.g., UPC), and multiple currencies for sales or purchases. Sales and purchase configurations define pricing methods, tax setups, default prices, charge types, and physical dimensions (length, width, height, weight). Inventory details include stock levels per warehouse, quantity on hand/available, and whether warehouse management or reordering is enabled. KPI data summarizes order counts and financial performance (e.g., revenue, outstanding amounts).Pagination metadata indicates the total number of records (100), current limit (10), and offset (0), with a URL provided for retrieving the next page of results. The response is structured for integration into inventory, sales, or ERP systems.

                JSON
              

                      {
  "items": [
    {
      "status": "ACTIVE",
      "id": "ITEM-XXXX",
      "name": "Item Name",
      "display_name": "Item Display Name",
      "description": "Item description",
      "type": "STANDARD",
      "base_uom": "UNIT",
      "origin": "Origin Info",
      "invoice_note": "Optional note for invoicing",
      "created_by": "Creator Name",
      "created_on": "YYYY-MM-DDTHH:MM:SSZ",
      "last_updated_by": "Updater Name",
      "last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
      "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "version": "X",
      "image_uri": "resources/product/{image_id}.jpg",
      "custom_form": {
        "name": "Form Name",
        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      },
      "custom_attributes": [
        {
          "name": "Attribute Name",
          "value": "Attribute Value"
        }
      ],
      "custom_objects": [],
      "codes": [
        {
          "name": "UPC-CODE",
          "value": "UPC-XXXXXX"
        }
      ],
      "uoms": [],
      "currencies": [
        {
          "name": "AUD",
          "used_for_sale": "true",
          "default_for_sale": "false",
          "used_for_purchase": "true",
          "default_for_purchase": "false"
        }
      ],
      "sale": {
        "enabled": "true",
        "enable_back_order": "false",
        "invoice_note": "",
        "accounting_code": {},
        "default_sale_price": "0.00",
        "shipping_profile": "",
        "width": { "uom": "cm", "value": "0.00" },
        "height": { "uom": "cm", "value": "0.00" },
        "length": { "uom": "cm", "value": "0.00" },
        "weight": { "uom": "kg", "value": "0.00" },
        "tax_exempt_when_sold": "false",
        "pricing_method": "STANDARD",
        "tax_configuration": {
          "sale_price_entered_inclusive_of_tax": "false"
        },
        "charge": {
          "type": "ONE_OFF",
          "properties": [
            {
              "name": "fulfillment_mode",
              "value": ""
            }
          ]
        },
        "payment_properties": [],
        "discount_profile": {},
        "pricing": {
          "type": "PER_UNIT_PRICING",
          "version": "X",
          "latest_used_pricing_version": "",
          "pricing_module": []
        },
        "use_on_sale_price": "false",
        "sale_price_variant": "",
        "sale_price": "",
        "start_date": "",
        "end_date": ""
      },
      "purchase": {
        "enabled": "true",
        "supplier_management_enabled": "false",
        "accounting_code": {},
        "purchase_order_note": "",
        "default_purchase_price": "0.00",
        "tax_configuration": {
          "purchase_price_entered_inclusive_of_tax": "false"
        },
        "purchase_properties": [],
        "pricing": {
          "type": "PER_UNIT_PRICING",
          "version": "X",
          "latest_used_pricing_version": "",
          "pricing_module": []
        }
      },
      "inventories": {
        "enabled": "true",
        "enable_warehouse_management": "false",
        "warehouses": [
          {
            "name": "Default Warehouse",
            "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "link": "https://{base_url}/api/v3/settings/warehouses/{id}",
            "quantity_on_hand": "0",
            "quantity_available": "0",
            "uom": "UNIT"
          }
        ],
        "default_warehouse": "",
        "inventory_properties": {
          "enable_low_stock_notification": "false",
          "enable_reordering": "false"
        }
      },
      "kpis": {
        "total_orders": 0,
        "active_orders": 0,
        "total_revenue": 0,
        "total_collected": 0,
        "total_outstanding": 0,
        "total_overdue": 0
      }
    }
  ],
  "pagination": {
    "records": 100,
    "limit": 10,
    "offset": 0,
    "previous_page": "",
    "next_page": "https://{base_url}/api/v2/items?limit=10&offset=10"
  }
}

                    

Field	Type	Description
status	String	Current status of the item (e.g., ACTIVE)
id	String	Internal identifier of the item
name	String	Item name
display_name	String	Display-friendly item name
description	String	Item description
type	String	Type of item (e.g., STANDARD, FAMILY)
base_uom	String	Base unit of measure
origin	String	Item origin or manufacturer
invoice_note	String	Notes to appear on invoices
created_by	String	User who created the item
created_on	Datetime	Date and time of creation
last_updated_by	String	User who last updated the item
last_updated_on	Datetime	Date and time of last update
uuid	UUID	Universally unique identifier of the item
version	String	Item version
image_uri	String	Path to item's image
custom_form.name	String	Name of the custom form assigned
custom_form.uuid	UUID	UUID of the custom form
custom_attributes	Array	List of custom attribute name-value pairs
codes	Array	List of identifying codes (e.g., UPC, ITEM-NUMBER)
uoms	Array	Available units of measure
currencies	Array	Supported currencies and their usage
sale.default_sale_price	Decimal	Default price for sale
sale.pricing_method	String	Pricing method used for sale
purchase.default_purchase_price	Decimal	Default purchase price
inventories.enabled	Boolean	Whether inventory tracking is enabled
kpis.total_orders	Integer	Total number of orders for the item
kpis.active_orders	Integer	Number of active orders
kpis.total_revenue	Decimal	Total revenue from item sales
kpis.total_collected	Decimal	Total amount collected from sales
kpis.total_outstanding	Decimal	Amount yet to be collected
kpis.total_overdue	Decimal	Amount that is overdue

Purpose

This endpoint retrieves complete details of a specific item based on its unique ID. The structure of the response varies depending on the type of item—such as standard,variation-based (parent or child) or gift certificate—providing metadata, configuration, pricing, custom attribute details, inventory configuration, purchase and sale setup, custom attributes, and metrics.

Use Case

Standard

This endpoint is used when displaying or editing item details in catalogs, order forms, pricing engines, inventory modules, or reporting dashboards.

Variation-Based Item (Child)

This response structure applies when fetching a variation child item, which is part of a parent-child relationship. Variation children inherit configuration context from a parent item but have their own sale, purchase, and inventory records. This is useful for items that differ only by specific attributes such as size or color.

Variation-Based Item (Parent)

This response structure applies when querying a variation parent item, which acts as a container or catalog for multiple variations (children). These items help organize variations such as different sizes or colors under a single root entity.

Gift Certificate Item

This response structure applies to gift certificate items, which are typically non-tangible products that can be purchased and redeemed later. These do not have variations or inventory units but do include sale-related financial data and payment properties.

Path Parameters

Parameter	Type	Description
id	String	Unique identifier of the item to retrieve.

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

Standard

Returns detailed information about the item identified by its ID. This includes basic data, configuration for sale and purchase, inventory rules, custom forms, pricing setup, and other metadata.

Variation-Based Item (Child)

The response returns a child item associated with a variation-based parent. It includes fields such as is_child, parent_item_id, and its unique pricing, inventory, tax, and fulfillment configuration. This allows granular control and tracking of each variation unit under a common parent SKU.

Variation-Based Item (Parent)

The API returns the metadata for a parent variation item, including the type as VARIATION_BASED, is_parent as true, and a list of associated variation configuration options. This helps in identifying available options and managing product structures in systems with variant product capabilities.

Gift Certificate Item

The response provides metadata and sale configuration for an item of type GIFT_CERTIFICATE. It includes sale pricing, payment properties, and accounting configurations used during order placement. Gift certificates are special-use items, commonly used in promotions and loyalty programs.

                Standard
              

                Variation-Based Item (Child)
              

                Variation-Based Item (Parent)
              

                Gift Certificate Item
              

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "ITEM_ID",
    "name": "ITEM_NAME",
    "display_name": "ITEM_DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "STANDARD",
    "base_uom": "BASE_UOM",
    "origin": "ITEM_ORIGIN",
    "invoice_note": "INVOICE_NOTE",
    "created_by": "CREATED_BY",
    "created_on": "CREATED_ON",
    "last_updated_by": "LAST_UPDATED_BY",
    "last_updated_on": "LAST_UPDATED_ON",
    "uuid": "ITEM_UUID",
    "version": "VERSION",
    "image_uri": "IMAGE_URI",
    "custom_form": {
      "name": "FORM_NAME",
      "uuid": "FORM_UUID"
    },
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [],
    "currencies": [
      {
        "name": "CURRENCY_NAME",
        "used_for_sale": "BOOLEAN_STRING",
        "default_for_sale": "BOOLEAN_STRING",
        "used_for_purchase": "BOOLEAN_STRING",
        "default_for_purchase": "BOOLEAN_STRING"
      }
    ],
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "enable_back_order": "BOOLEAN_STRING",
      "invoice_note": "INVOICE_NOTE",
      "accounting_code": {},
      "default_sale_price": "DEFAULT_SALE_PRICE",
      "shipping_profile": "SHIPPING_PROFILE",
      "tax_exempt_when_sold": "BOOLEAN_STRING",
      "pricing_method": "PRICING_METHOD",
      "tax_configuration": {
        "sale_price_entered_inclusive_of_tax": "BOOLEAN_STRING"
      },
      "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": "LATEST_VERSION",
        "pricing_module": []
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "SALE_PRICE_VARIANT",
      "sale_price": "SALE_PRICE",
      "start_date": "START_DATE",
      "end_date": "END_DATE"
    },
    "purchase": {
      "enabled": "BOOLEAN_STRING",
      "supplier_management_enabled": "BOOLEAN_STRING",
      "accounting_code": {},
      "purchase_order_note": "PO_NOTE",
      "default_purchase_price": "PURCHASE_PRICE",
      "tax_configuration": {
        "purchase_price_entered_inclusive_of_tax": "BOOLEAN_STRING"
      },
      "purchase_properties": [
        {
          "name": "PURCHASE_PROPERTY_NAME",
          "value": "PURCHASE_PROPERTY_VALUE"
        }
      ],
      "pricing": {
        "type": "PRICING_TYPE",
        "version": "VERSION",
        "latest_used_pricing_version": "LATEST_VERSION",
        "pricing_module": []
      }
    },
    "inventories": {
      "enabled": "BOOLEAN_STRING",
      "enable_warehouse_management": "BOOLEAN_STRING",
      "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": "UOM"
        }
      ],
      "default_warehouse": "DEFAULT_WAREHOUSE",
      "inventory_properties": {
        "enable_low_stock_notification": "BOOLEAN_STRING",
        "low_stock_threshold_based_on": "THRESHOLD_TYPE",
        "enable_reordering": "BOOLEAN_STRING",
        "reordering_threshold_based_on": "THRESHOLD_TYPE",
        "quantity_available_for_sale_determination": [
          "CRITERIA"
        ],
        "quantity_available_for_sale": "VALUE",
        "enable_preorder": "BOOLEAN_STRING",
        "enable_serialization": "BOOLEAN_STRING",
        "enable_batch_tracking": "BOOLEAN_STRING",
        "enable_inventory_costing": "BOOLEAN_STRING",
        "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN_STRING",
        "default_cost_per_unit": "COST"
      }
    },
    "kpis": {
      "total_orders": 0,
      "active_orders": 0,
      "total_revenue": 0,
      "total_collected": "AMOUNT",
      "total_outstanding": 0,
      "total_overdue": 0
    }
  }
}

                    

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "ITEM_CHILD_ID",
    "name": "ITEM_NAME",
    "display_name": "ITEM_DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "STANDARD",
    "is_parent": "false",
    "is_child": "true",
    "parent_item_id": "PARENT_ITEM_ID",
    "base_uom": "UNIT_OF_MEASURE",
    "origin": "ITEM_ORIGIN",
    "invoice_note": "INVOICE_NOTE_TEXT",
    "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": "ITEM_IMAGE_URI",
    "manager": "ITEM_MANAGER",
    "custom_form": {
      "name": "FORM_NAME",
      "uuid": "FORM_UUID"
    },
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [
      {
        "name": "UNIT_NAME",
        "base_uom": "BOOLEAN_STRING",
        "sale_conversion_rate": "SALE_CONVERSION",
        "purchase_conversion_rate": "PURCHASE_CONVERSION",
        "used_for_sale": "BOOLEAN_STRING",
        "used_for_purchase": "BOOLEAN_STRING"
      }
    ],
    "currencies": [
      {
        "name": "CURRENCY_NAME",
        "used_for_sale": "BOOLEAN_STRING",
        "default_for_sale": "BOOLEAN_STRING",
        "used_for_purchase": "BOOLEAN_STRING",
        "default_for_purchase": "BOOLEAN_STRING"
      }
    ],
    "use_variations": [],
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "enable_back_order": "BOOLEAN_STRING",
      "invoice_note": "INVOICE_NOTE_TEXT",
      "accounting_code": {},
      "default_sale_price": "SALE_PRICE_VALUE",
      "shipping_profile": "",
      "tax_exempt_when_sold": "BOOLEAN_STRING",
      "pricing_method": "PRICING_METHOD",
      "tax_configuration": {
        "sale_price_entered_inclusive_of_tax": "BOOLEAN_STRING",
        "sale_price_based_on": "TAX_BASIS",
        "tax_code": {}
      },
      "pricing_profile": {},
      "charge": {
        "type": "CHARGE_TYPE",
        "properties": [
          {
            "name": "FULFILLMENT_MODE",
            "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": []
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "",
      "sale_price": "",
      "start_date": "",
      "end_date": ""
    },
    "purchase": {
      "enabled": "BOOLEAN_STRING",
      "supplier_management_enabled": "BOOLEAN_STRING",
      "accounting_code": {},
      "purchase_order_note": "",
      "default_purchase_price": "",
      "tax_configuration": {
        "purchase_price_entered_inclusive_of_tax": "BOOLEAN_STRING"
      },
      "pricing_profile": {},
      "purchase_properties": [
        {
          "name": "RECEIVE_PROPERTY_NAME",
          "value": "RECEIVE_PROPERTY_VALUE"
        }
      ],
      "pricing": {
        "type": "PRICING_TYPE",
        "version": "PRICING_VERSION",
        "latest_used_pricing_version": "",
        "pricing_module": []
      }
    },
    "inventories": {
      "enabled": "BOOLEAN_STRING",
      "enable_warehouse_management": "BOOLEAN_STRING",
      "warehouses": [
        {
          "name": "WAREHOUSE_NAME",
          "uuid": "WAREHOUSE_UUID",
          "link": "WAREHOUSE_LINK",
          "quantity_on_hand": "QUANTITY_ON_HAND",
          "quantity_on_hand_value": "VALUE_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",
          "quantity_available_value": "VALUE_AVAILABLE",
          "uom": "UNIT_OF_MEASURE"
        }
      ],
      "default_warehouse": "",
      "inventory_properties": {
        "enable_low_stock_notification": "BOOLEAN_STRING",
        "low_stock_threshold_based_on": "",
        "enable_reordering": "BOOLEAN_STRING",
        "reordering_threshold_based_on": "",
        "quantity_available_for_sale_determination": [
          "QUANTITY_METRIC"
        ],
        "quantity_available_for_sale": "SALE_POLICY",
        "enable_preorder": "BOOLEAN_STRING",
        "enable_serialization": "BOOLEAN_STRING",
        "enable_batch_tracking": "BOOLEAN_STRING",
        "enable_inventory_costing": "BOOLEAN_STRING",
        "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN_STRING",
        "default_cost_per_unit": ""
      }
    },
    "kpis": {
      "total_orders": 0,
      "active_orders": 0,
      "total_revenue": 0,
      "total_collected": 0,
      "total_outstanding": 0,
      "total_overdue": 0
    }
  }
}

                    

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "PARENT_ITEM_ID",
    "name": "ITEM_NAME",
    "display_name": "DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "VARIATION_BASED",
    "is_parent": "true",
    "is_child": "false",
    "origin": "ITEM_ORIGIN",
    "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": "ITEM_IMAGE_URI",
    "manager": "ITEM_MANAGER",
    "custom_form": {
      "name": "FORM_NAME",
      "uuid": "FORM_UUID"
    },
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "configure_variations": [
      {
        "uuid": "VARIATION_UUID",
        "name": "VARIATION_NAME",
        "link": "VARIATION_LINK",
        "values": [
          {
            "uuid": "OPTION_UUID",
            "name": "OPTION_NAME"
          }
        ]
      }
    ]
  }
}

                    

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "ITEM_ID",
    "name": "ITEM_NAME",
    "display_name": "DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "GIFT_CERTIFICATE",
    "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": "ITEM_IMAGE_URI",
    "manager": "ITEM_MANAGER",
    "custom_form": {
      "name": "FORM_NAME",
      "uuid": "FORM_UUID"
    },
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [],
    "currencies": [
      {
        "name": "CURRENCY_NAME",
        "used_for_sale": "BOOLEAN_STRING",
        "default_for_sale": "BOOLEAN_STRING",
        "used_for_purchase": "BOOLEAN_STRING",
        "default_for_purchase": "BOOLEAN_STRING"
      }
    ],
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "enable_back_order": "BOOLEAN_STRING",
      "invoice_note": "INVOICE_NOTE",
      "accounting_code": {
        "sales_revenue": "ACCOUNT_NAME"
      },
      "default_sale_price": "SALE_PRICE",
      "shipping_profile": "",
      "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_MODE",
            "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": []
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "",
      "sale_price": "",
      "start_date": "",
      "end_date": ""
    },
    "kpis": {
      "total_orders": 0,
      "active_orders": 0,
      "total_revenue": 0,
      "total_collected": 0,
      "total_outstanding": 0,
      "total_overdue": 0
    }
  }
}

                    

Field	Type	Description
status	String	Status of the item.
id	String	Unique item identifier.
name	String	Item name.
type	String	Type of item (e.g., STANDARD).
base_uom	String	Base unit of measure.
custom_form.name	String	Name of the associated form.
custom_attributes	Array	Custom field definitions and values.
currencies	Array	Currencies used for sale and purchase.
sale.default_sale_price	String	Default sale price.
sale.pricing_method	String	Method used for pricing.
purchase.default_purchase_price	String	Default purchase price.
inventories.enabled	String	Indicates if inventory is enabled for the item.
inventories.warehouses	Array	List of warehouses containing stock information.
kpis.total_collected	String	Total amount collected for this item.
uuid	UUID	Unique universal identifier for the item.
created_by	String	Creator of the item.
created_on	String	Timestamp of item creation.
last_updated_by	String	Last user who updated the item.
last_updated_on	String	Timestamp of the last update.

Purpose

This API retrieves detailed information about a specific item using its unique identifier. It provides metadata, status, relationships, configurations, and performance indicators associated with the item.

Use Case

Use this endpoint when you need to display or review a single item's full configuration and historical metadata, including custom attributes, codes, currencies, and performance KPIs. This is typically used in inventory systems, reporting dashboards, or product configuration interfaces.

Path Parameters

Parameter	Type	Description
id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required

Response

The response includes detailed metadata about a single item such as its unique ID, name, status, type, custom attributes, codes, currencies, and related KPIs. This allows systems and users to analyze item-specific configurations, performance, and usage context.

                JSON
              

                      {
  "item": {
    "status": "ITEM_STATUS",
    "id": "ITEM_ID",
    "name": "ITEM_NAME",
    "display_name": "ITEM_DISPLAY_NAME",
    "description": "ITEM_DESCRIPTION",
    "type": "ITEM_TYPE",
    "parent_item_id": "PARENT_ITEM_ID",
    "base_uom": "UNIT_OF_MEASURE",
    "origin": "ITEM_ORIGIN",
    "invoice_note": "ITEM_INVOICE_NOTE",
    "created_by": "CREATOR_NAME",
    "created_on": "CREATED_TIMESTAMP",
    "last_updated_by": "UPDATER_NAME",
    "last_updated_on": "UPDATED_TIMESTAMP",
    "uuid": "ITEM_UUID",
    "version": "ITEM_VERSION",
    "image_uri": "ITEM_IMAGE_URI",
    "manager": "ITEM_MANAGER",
    "custom_form": {
      "name": "FORM_NAME",
      "uuid": "FORM_UUID"
    },
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "custom_objects": [],
    "codes": [
      {
        "name": "CODE_NAME",
        "value": "CODE_VALUE"
      }
    ],
    "uoms": [],
    "currencies": [
      {
        "name": "CURRENCY_NAME",
        "used_for_sale": "BOOLEAN_STRING",
        "default_for_sale": "BOOLEAN_STRING",
        "used_for_purchase": "BOOLEAN_STRING",
        "default_for_purchase": "BOOLEAN_STRING"
      }
    ],
    "kpis": {
      "total_orders": 0,
      "active_orders": 0,
      "total_revenue": 0,
      "total_collected": 0,
      "total_outstanding": 0,
      "total_overdue": 0
    }
  }
}

                    

Field	Type	Description
status	string	Current status of the item (e.g., ACTIVE, INACTIVE).
id	string	Unique ID of the item.
name	string	Name of the item.
display_name	string	Display name of the item.
description	string	Textual description of the item.
type	string	Type/category of the item.
parent_item_id	string	ID of the parent item, if applicable.
base_uom	string	Base unit of measurement.
origin	string	Origin or source of the item.
invoice_note	string	Notes to be printed on invoices for this item.
created_by	string	Name of the user who created the item.
created_on	string	Timestamp of item creation (ISO format).
last_updated_by	string	Name of the user who last updated the item.
last_updated_on	string	Timestamp of last update (ISO format).
uuid	string	UUID for internal system identification.
version	string	Version number of the item.
image_uri	string	URI to the item image.
manager	string	Assigned manager for the item (if any).
custom_form.name	string	Name of the custom form associated with the item.
custom_form.uuid	string	UUID of the custom form.
custom_attributes	array	List of name-value pairs for custom attributes.
custom_objects	array	List of related custom objects (empty if none).
codes	array	List of item codes with name and value (e.g., UPC, SKU).
uoms	array	List of unit-of-measure definitions (empty in this case).
currencies.name	string	Name of the currency (e.g., AUD).
currencies.used_for_sale	string	Whether currency is enabled for sales (true/false).
currencies.default_for_sale	string	Whether it's the default currency for sales (true/false).
currencies.used_for_purchase	string	Whether currency is enabled for purchase (true/false).
currencies.default_for_purchase	string	Whether it's the default currency for purchases (true/false).
kpis.total_orders	integer	Total number of orders for this item.
kpis.active_orders	integer	Number of currently active orders.
kpis.total_revenue	integer	Total revenue generated by this item.
kpis.total_collected	integer	Total amount collected.
kpis.total_outstanding	integer	Total outstanding amount.
kpis.total_overdue	integer	Total overdue amount.

Purpose

This API retrieves the sales configuration details of a specific item, including pricing, tax settings, payment options, dimensions, and fulfillment-related properties. It enables systems to understand how an item behaves in sales transactions.

Use Case

Use this endpoint when displaying or managing item sale-specific configurations such as pricing method, availability for backorder, dimensions, charge model, and payment options in an e-commerce or ERP system. This information is crucial for checkout, billing, and inventory workflows.

Path Parameters

Parameter	Type	Description
id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required.

Response Description

The response provides a detailed structure of the sales configuration for a specific item. This includes whether sales are enabled, sale pricing strategy, tax settings, physical dimensions, and charge/payment profiles. It helps businesses define how items are sold and under what conditions.

                JSON
              

                      {
  "item": {
    "sale": {
      "enabled": "BOOLEAN_STRING",
      "enable_back_order": "BOOLEAN_STRING",
      "invoice_note": "SALE_INVOICE_NOTE",
      "accounting_code": {},
      "default_sale_price": "DEFAULT_SALE_PRICE",
      "shipping_profile": "SHIPPING_PROFILE_ID",
      "width": {
        "uom": "UNIT_OF_MEASURE",
        "value": "WIDTH_VALUE"
      },
      "height": {
        "uom": "UNIT_OF_MEASURE",
        "value": "HEIGHT_VALUE"
      },
      "length": {
        "uom": "UNIT_OF_MEASURE",
        "value": "LENGTH_VALUE"
      },
      "weight": {
        "uom": "UNIT_OF_MEASURE",
        "value": "WEIGHT_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": "PROPERTY_NAME",
            "value": "PROPERTY_VALUE"
          }
        ]
      },
      "payment_properties": [
        {
          "name": "PROPERTY_NAME",
          "value": "PROPERTY_VALUE"
        }
      ],
      "discount_profile": {},
      "pricing": {
        "type": "PRICING_TYPE",
        "version": "PRICING_VERSION",
        "latest_used_pricing_version": "LATEST_VERSION",
        "pricing_module": []
      },
      "use_on_sale_price": "BOOLEAN_STRING",
      "sale_price_variant": "VARIANT_ID",
      "sale_price": "SALE_PRICE_VALUE",
      "start_date": "START_DATE_TIMESTAMP",
      "end_date": "END_DATE_TIMESTAMP"
    }
  }
}

                    

Field	Type	Description
enabled	string (boolean)	Indicates if the item is enabled for sale.
enable_back_order	string (boolean)	Indicates if back orders are allowed.
invoice_note	string	Note to be printed on invoices during sale.
accounting_code	object	Accounting-related configuration (empty if not set).
default_sale_price	string	Default price of the item used in standard sale.
shipping_profile	string	Shipping profile ID associated with this item.
width, height, length, weight	object	Physical dimensions and weight of the item with unit and value.
→ uom	string	Unit of measure (e.g., cm, kg).
→ value	string	Value for the dimension or weight.
tax_exempt_when_sold	string (boolean)	Indicates if the item is exempt from tax when sold.
pricing_method	string	Pricing strategy used (e.g., STANDARD).
tax_configuration.sale_price_entered_inclusive_of_tax	string (boolean)	Whether the sale price includes tax.
pricing_profile	object	Object defining advanced pricing profiles (empty if not set).
charge.type	string	Type of charge (e.g., ONE_OFF, RECURRING).
charge.properties[].name	string	Name of the charge property (e.g., fulfillment_mode).
charge.properties[].value	string	Value of the charge property.
payment_properties[].name	string	Name of the payment property (e.g., payment_processor).
payment_properties[].value	string	Value assigned to the payment property.
discount_profile	object	Discount rules (empty if not defined).
pricing.type	string	Type of pricing method (e.g., PER_UNIT_PRICING).
pricing.version	string	Version of the pricing structure.
pricing.latest_used_pricing_version	string	Last used pricing version (if available).
pricing.pricing_module	array	List of modules used in pricing (empty array here).
use_on_sale_price	string (boolean)	Indicates if the item uses the sale-specific price.
sale_price_variant	string	Variant ID used for pricing (if applicable).
sale_price	string	Sale-specific price value (if used).
start_date	string (ISO)	Start date for the sale price to be effective.
end_date	string (ISO)	End date for the sale price to expire.

Purpose

This API retrieves the inventory management settings for a specific item, including warehouse availability, stock levels, inventory tracking, and control policies. It provides both current quantity metrics and configuration options related to warehouse and inventory control.

Use Case

Use this endpoint when viewing or managing inventory settings for an item in a warehouse management or ERP system. It is essential for logistics planning, fulfillment automation, inventory alerts, and purchase restocking decisions.

Path Parameters

Parameter	Type	Description
id	string	Unique identifier of the item.

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required.

Response

The response contains the inventory configuration for a specific item, including whether inventory and warehouse management are enabled, stock quantities across all warehouses, unit of measure, and system behavior on low stock, reordering, and costing. This helps businesses manage supply chains and inventory visibility efficiently.

                JSON
              

                      {
  "item": {
    "inventories": {
      "enabled": "BOOLEAN_STRING",
      "enable_warehouse_management": "BOOLEAN_STRING",
      "warehouses": [
        {
          "name": "WAREHOUSE_NAME",
          "uuid": "WAREHOUSE_UUID",
          "link": "WAREHOUSE_API_LINK",
          "quantity_on_hand": "QUANTITY_ON_HAND",
          "quantity_on_hand_value": "CURRENCY_FORMATTED_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": "CURRENCY_FORMATTED_VALUE",
          "uom": "UNIT_OF_MEASURE"
        }
      ],
      "default_warehouse": "DEFAULT_WAREHOUSE_ID",
      "inventory_properties": {
        "enable_low_stock_notification": "BOOLEAN_STRING",
        "low_stock_threshold_based_on": "THRESHOLD_TYPE",
        "enable_reordering": "BOOLEAN_STRING",
        "reordering_threshold_based_on": "THRESHOLD_TYPE",
        "quantity_available_for_sale_determination": [
          "QUANTITY_METRIC"
        ],
        "quantity_available_for_sale": "QUANTITY_POLICY",
        "enable_preorder": "BOOLEAN_STRING",
        "enable_serialization": "BOOLEAN_STRING",
        "enable_batch_tracking": "BOOLEAN_STRING",
        "enable_inventory_costing": "BOOLEAN_STRING",
        "use_atp_value_as_quantity_available_for_webhook": "BOOLEAN_STRING",
        "default_cost_per_unit": "UNIT_COST_VALUE"
      }
    }
  }
}

                    

Field	Type	Description
enabled	string (boolean)	Indicates if inventory tracking is enabled for the item.
enable_warehouse_management	string (boolean)	Indicates if warehouse-level management is active.
warehouses[].name	string	Name of the warehouse.
warehouses[].uuid	string	UUID of the warehouse.
warehouses[].link	string (URL)	API link to the warehouse details.
warehouses[].quantity_on_hand	string	Total stock physically on hand.
warehouses[].quantity_on_hand_value	string (currency)	Financial value of the stock on hand.
warehouses[].quantity_promised	string	Quantity promised to customers.
warehouses[].quantity_on_order	string	Quantity currently on purchase order.
warehouses[].quantity_on_return	string	Quantity expected to return from customers.
warehouses[].quantity_on_purchase_return	string	Quantity expected to return to suppliers.
warehouses[].quantity_available	string	Quantity currently available for new orders.
warehouses[].quantity_available_value	string (currency)	Value of available stock.
warehouses[].uom	string	Unit of measurement for inventory (e.g., Megabyte, Kg).
default_warehouse	string	ID or reference of the default warehouse (if any).
inventory_properties.enable_low_stock_notification	string (boolean)	Whether system notifies on low stock.
inventory_properties.low_stock_threshold_based_on	string	Criteria used for low stock threshold.
inventory_properties.enable_reordering	string (boolean)	Whether automatic reordering is enabled.
inventory_properties.reordering_threshold_based_on	string	Metric used to trigger reorder point.
inventory_properties.quantity_available_for_sale_determination[]	array	Method(s) used to calculate availability (e.g., QUANTITY_ON_HAND).
inventory_properties.quantity_available_for_sale	string	Inventory sale policy (e.g., UNLIMITED, FIXED).
inventory_properties.enable_preorder	string (boolean)	Whether customers can preorder out-of-stock items.
inventory_properties.enable_serialization	string (boolean)	Whether inventory serialization is enabled.
inventory_properties.enable_batch_tracking	string (boolean)	Whether batch tracking is used.
inventory_properties.enable_inventory_costing	string (boolean)	Whether inventory costing is tracked.
inventory_properties.use_atp_value_as_quantity_available_for_webhook	string (boolean)	Whether ATP (Available to Promise) value is exposed via webhooks.
inventory_properties.default_cost_per_unit	string	Default unit cost of the item (if configured).

Purpose

This endpoint retrieves all notes associated with a specific item. Each note may include text content, optional file attachments, metadata about creation and updates, and custom attributes. Pagination is supported to handle large sets of notes efficiently.

Use Case

View all notes attached to an item for audit trails, documentation, or collaboration.
Fetch additional context or comments related to an item.
Retrieve metadata (who created/updated, when) for compliance or history tracking.
Support systems that display item-related discussions or annotations.

Path Parameters

Parameter	Type	Required	Description
item_id	string	Yes	Unique identifier of the item for which notes are being retrieved.

Query Parameters

Parameter	Type	Required	Description
limit	int	No	Number of records to return per page. Default: 20.
offset	int	No	Number of records to skip for pagination. Default: 0.

Request Body

No request body is required for this endpoint.

Response

On success, the response returns an item object containing a list of notes, where each note includes unique identifiers, HTML-supported content, optional attached files, and audit metadata.

Response Body

                JSON
              

                      {
    "item": {
        "notes": [
            {
                "uuid": "NOTE_UUID",
                "version": "NOTE_VERSION",
                "content": "NOTE_CONTENT",
                "files": [],
                "created_by": "CREATED_BY",
                "created_on": "CREATED_ON",
                "last_updated_by": "LAST_UPDATED_BY",
                "last_updated_on": "LAST_UPDATED_ON",
                "custom_attributes": []
            }
        ],
        "pagination": {
            "records": RECORDS_COUNT,
            "limit": LIMIT,
            "offset": OFFSET,
            "previous_page": "PREVIOUS_PAGE",
            "next_page": "NEXT_PAGE"
        }
    }
}
                    

Attribute	Type	Description
item	object	Container object holding item notes and pagination details.
item.notes	array	List of note objects associated with the item.
item.notes[].uuid	string (UUID)	Unique identifier of the note.
item.notes[].version	string	Version number of the note (for concurrency control).
item.notes[].content	string (HTML)	Content of the note (supports HTML formatting).
item.notes[].files	array	List of files attached to the note. Empty if none.
item.notes[].created_by	string	Name/identifier of the user who created the note.
item.notes[].created_on	string (ISO 8601)	Timestamp when the note was created.
item.notes[].last_updated_by	string	User who last updated the note (empty if never updated).
item.notes[].last_updated_on	string (ISO 8601)	Timestamp of the last update (empty if never updated).
item.notes[].custom_attributes	array	List of custom attributes (name/value pairs) defined for the note.
item.pagination	object	Pagination metadata for navigating through multiple pages of notes.
item.pagination.records	integer	Total number of records available.
item.pagination.limit	integer	Number of records per page.
item.pagination.offset	integer	Number of records skipped for the current page.
item.pagination.previous_page	string	URL of the previous page, if available.
item.pagination.next_page	string	URL of the next page, if available.

Purpose

This endpoint retrieves the details of a single note associated with a specific item. It returns metadata such as the note’s unique identifier, version, content, optional file attachments, creator information, timestamps, and any custom attributes defined.

Use Case

Fetch details of a specific note for display in an item’s history or activity log.
Retrieve audit information (created by, created on, updated by, updated on).
Access the note content (supports HTML formatting) for rendering in applications.
Check file associations and custom attributes tied to the note.

Path Parameters

Parameter	Type	Required	Description
item_id	string	Yes	Unique identifier of the item the note belongs to.
NOTE_UUID	string (UUID)	Yes	Unique identifier of the note to retrieve.

Query Parameters

This endpoint does not support query parameters.

Request Body

No request body is required for this endpoint.

Response

On success, the response returns an item object containing a single note object. The note includes its unique identifier, version number, note content (HTML-supported), file list (if attached), creator information, creation and update timestamps, and any custom attributes associated with the note.

Response Body

                JSON
              

                      {
    "item": {
        "note": {
            "uuid": "NOTE_UUID",
            "version": "NOTE_VERSION",
            "content": "NOTE_CONTENT",
            "files": [],
            "created_by": "CREATED_BY",
            "created_on": "CREATED_ON",
            "last_updated_by": "LAST_UPDATED_BY",
            "last_updated_on": "LAST_UPDATED_ON",
            "custom_attributes": []
        }
    }
}
                    

Attribute	Type	Description
item	object	Container object holding the note details.
item.note	object	A single note object associated with the item.
item.note.uuid	string (UUID)	Unique identifier of the note.
item.note.version	string	Version number of the note (used for concurrency control).
item.note.content	string (HTML)	Content of the note, supports HTML formatting.
item.note.files	array	List of files attached to the note. Empty if no files.
item.note.created_by	string	Identifier or name of the user who created the note.
item.note.created_on	string (ISO 8601)	Timestamp when the note was created.
item.note.last_updated_by	string	Identifier of the user who last updated the note (empty if never updated).
item.note.last_updated_on	string (ISO 8601)	Timestamp of the last update (empty if never updated).
item.note.custom_attributes	array	List of custom attributes (name/value pairs) defined for the note.

Purpose

This API endpoint retrieves the list of files attached to a specific note of an item. It provides metadata for each file, including unique identifiers, file names, versions, and any associated custom attributes.

Use Case

Use this endpoint when you need to display, download, or manage files attached to a particular note for an item. For example, in a field service inspection system, each inspection note may have associated images or documents, which can be fetched using this API.

Path Parameters

Parameter	Type	Description
`item_id`	string	Unique identifier of the item to which the note belongs.
`NOTE_UUID`	string	Unique identifier (UUID) of the note whose files are being retrieved.

Query Parameters

This endpoint does not require any query parameters.

Request Body

No request body is required for this endpoint.

Response

On success, the API returns a JSON object containing the requested note's file metadata. Each file object includes its UUID, name, and version. The response also contains any custom attributes associated with the note, if defined. This allows clients to retrieve and display note-related files with their corresponding details and track versions.

Response Body

                JSON
              

                      {
    "item": {
        "note": {
            "files": [
                {
                    "uuid": "FILE_UUID",
                    "name": "FILE_NAME",
                    "version": "FILE_VERSION"
                }
            ],
            "custom_attributes": []
        }
    }
}

                    

Attribute	Type	Description
`item`	object	Container object for the note and its related data.
`item.note`	object	Represents the note object containing files and custom attributes.
`item.note.files`	array	List of files attached to the note.
`item.note.files[].uuid`	string	Unique identifier (UUID) of the file.
`item.note.files[].name`	string	Name of the file including extension.
`item.note.files[].version`	string	Version number of the file (useful for tracking updates).
`item.note.custom_attributes`	array	List of custom attributes associated with the note (if any, otherwise empty).

Purpose

This endpoint retrieves detailed information about a specific file attached to a note of a given item. It allows you to fetch metadata such as the file’s unique identifier, name, version, and any associated custom attributes.

Use Case

Fetch file metadata (example: file name, version, UUID) for an item’s note.
Display available file information in a user interface before download.
Validate the correct file association with a note for auditing or compliance.
Integrate with systems where file tracking and version management is required.

Path Parameters

Parameter	Type	Required	Description
item_id	string	Yes	Unique identifier of the item the note belongs to.
NOTE_UUID	string (UUID)	Yes	Unique identifier of the note that contains the file.
FILE_UUID	string (UUID)	Yes	Unique identifier of the file attached to the note.

Query Parameters

This endpoint does not support query parameters.

Request Body

This is a GET request. No request body is required.

Response

On success, the API returns an item object containing the requested note object. The note object includes a single file object with metadata such as UUID, file name, and version, along with a custom_attributes array. The response is useful for identifying the file and its properties but does not return the actual file content; it only provides metadata for retrieval or validation purposes.

Response Body

                JSON
              

                      {
    "item": {
        "note": {
            "file": {
                "uuid": "{{file_uuid}}",
                "name": "{{file_name}}",
                "version": "{{file_version}}"
            },
            "custom_attributes": []
        }
    }
}
                    

Attribute	Type	Description
item	object	Container object holding the note and file details.
item.note	object	Object representing the note associated with the file.
item.note.file	object	Object containing metadata of the requested file.
item.note.file.uuid	string (UUID)	Unique identifier of the file attached to the note.
item.note.file.name	string	Name of the file (including extension).
item.note.file.version	string	Version number of the file.
item.note.custom_attributes	array	List of custom attributes defined for the note (if any).

Get Items List:/items

Purpose

Use Case

Path Parameters

Query Parameters

Response

Retrieve Item Details: /items/{id}

Purpose

Use Case

Standard

Variation-Based Item (Child)

Variation-Based Item (Parent)

Gift Certificate Item

Path Parameters

Query Parameters

Request Body

Response

Standard

Variation-Based Item (Child)

Variation-Based Item (Parent)

Gift Certificate Item

Get Item Information by ID:/items/{id}/information

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Get Item Sale Configuration by ID:/items/{id}/sale

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response Description

Get Item Inventory Configuration by ID:/items/{id}/inventories

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Retrieve All Item Notes: /items/{item_id}/notes

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Specific Note for a Specific Item: /items/{item_id}/notes/{NOTE_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve All Note Files of a Specific Item: /items/{item_id}/notes/{NOTE_UUID}/files

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Item Note File Details: /items/{item_id}/notes/{NOTE_UUID}/files/{FILE_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body