Get Products Lists

Use this method to get Products lists. See our HTTP GET documentation for complete queries method.

The following elements are returned in the get Products lists methods response :

Body Response

Element Description
id Unique code for identifier Product String Automatically.
code Product code. String maximum 255 characters.
name Product name String maximum 255 characters.
is_active Boolean true if active false if not active.
is_salable Boolean true if salable false if not salable.
is_purchasable Boolean true if purchasable false if not purchasable.
is_tracked_as_inventory Boolean true if tracked_as_inventory false if not tracked_as_inventory.
length Product length Number default = 1.
width Product width Number default = 1.
height Product height Number default = 1.
weight Product weight Number default = 1.
unit_cost Product cost Number default = 1.
unit_price Product price Number default = 1.
unit_cogs Product cogs Number default = 1.
quantity* Element for quantity.
quantity.on_hand Quantity product on hand Number.
quantity.on_hold Quantity product on hold Number.
quantity.available Quantity product available Number.
category* Element for category.
category.id Unique code for identifier Product category String.
category.name Category name String maximum 255 characters.
unit Element for unit.
unit.id Unique code for identifier product unit String.
unit.code Unit code String maximum 255 characters.
unit.name Unit name String maximum 255 characters.
default_account* default_account.
sales* Element for Sales account.
sales.id Unique code for identifier sales account String.
sales.code Sales account code String maximum 255 characters.
sales.name Sales account name String maximum 255 characters.
cogs Element for Cogs account.
cogs.id Unique code for identifier cogs account String.
cogs.code Cogs account code String maximum 255 characters.
cogs.name Cogs account name String maximum 255 characters.
inventory* Element for Inventory account.
inventory.id Unique code for identifier inventory account String.
inventory.code Inventory account code String maximum 255 characters.
inventory.name Inventory account name String maximum 255 characters.
partial_delivery* Element for partial_delivery.
partial_delivery.id Unique code for identifier partial_delivery account String.
partial_delivery.code partial_delivery account code String maximum 255 characters.
partial_delivery.name partial_delivery account name String maximum 255 characters.
partial_receipt* Element for partial_receipt.
partial_receipt.id Unique code for identifier partial_receipt account String.
partial_receipt.code partial_receipt account code String maximum 255 characters.
partial_receipt.name partial_receipt account name String maximum 255 characters.
other_fields* Element of other fields.
other_fields.id other_fields id String.
other_fields.key other_fields key String.
other_fields.type other_fields data type Ex: string or integer or number
other_fields.value value of other_fields String.
created* Created.
created.user* Created User.
created.user.id User id String Automaticaly.
created.user.name User name String.
created.user.email User email String.
created.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
update* Update.
update.user* Update user.
update.user.id User id String Automaticaly.
update.user.name User name String.
update.user.email User email String.
update.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.