Products
Products API.
List Products
List Products.
Products can be of 2 types which is determined by the field bundle_type:
- BUNDLE
- NONE (NORMAL)
Inventory for bundle products is calculated based on the inventory of its components. Components are always normal products. The results include only the non-archived products.
query Parameters
barcodeProduct barcode
bundle_typeCan be either BUNDLE or NONE
categoriesProduct category names separated by comma. A product type name also matches. Case insensitive.
contactcreated_range_afterCreated at range filter.
created_range_beforeCreated at range filter.
limitNumber of results to return per page.
nameProduct name
notesProduct notes
oOrdering
id- Id-id- Id (descending)name- Name-name- Name (descending)variant_name- Variant name-variant_name- Variant name (descending)sku- Sku-sku- Sku (descending)
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.
skuProduct SKU
tagsMultiple values may be separated by commas.
updated_range_afterUpdated at range filter.
updated_range_beforeUpdated at range filter.
variant_nameProduct variant name
List Products › Responses
countnextpreviousList Bundle Components
List Bundle Components.
- Filter components of a bundle using
productfilter. - Filter bundles of a product using
componentfilter.
query Parameters
componentlimitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.
productList Bundle Components › Responses
countnextprevious