Inventory API
Products

List All Products

This API endpoint (GET) retrieves all your products. The response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests. On successful completion, it returns an array of Product Objects, the number of available results and the flags used for filtering. Permissions: products.view

Query Parameters

page * Fetch the results from a specific page. It defaults to 1.



per_page * The number of results to fetch per page. The maximum is 50 and if it defaults to 10.



from date-format Start date to use for filtering (the date the product was created).



to date-format End date used for filtering (the date the product was created).



sort_by An optional identifier used for sorting results. The available options are price, weight, length, width, height, isbn, upc, sku, ean, gtin, mpn, brand, model, asin, hscode, shown, discount_allowed, exclude_from_feed, on_sale, delivery_type, license_type.



type Optional identified used for filtering results by product type. The available options are physical_services, digital_products, billing_plans, digital_services, whitelabel_plans and physical_products.



filter Optional text used for filtering products by title.



warehouse_id The id of a warehouse to use for filtering. If provided, it will return the products that are associated with this warehouse.



affiliate_program_id The id of an affiliate program to use for filtering. If provided, it will return the products that are associated with this affiliate program.



discount_id The id of a discount to use for filtering. If provided, it will return the products that are associated with this discount.



tax_id The id of a tax rate to use for filtering. If provided, it will return the products that are associated with this tax rate.



teammate_id If provided, it will return the products that are assigned to the teammate.



stock Used to filter products that have stock or are out of stock. The available options are enabled and disabled.



discounts Used to filter products that can or cannot have discounts. The available options are enabled and disabled.



minimum_price It will filter products whose default price is at least the provided value.



maximum_price It will filter products whose default price does not exceed the provided value.



billing_cycle Used to filter billing plans by billing cycle. The available options are day, week, month and year.



trial Used to filter billing plans by their trial availability. The available options are enabled and disabled.



license_type Used to filter digital products by license type. The available options are list, autogenerated and none.



on_sale Used to filter products that are available for sale or are currently hidden. The available options are enabled and disabled.



tax_classification Product Categories Filters product by category.



currency Currency Code Filters products by currency.



order Determines in which order the results are returned. The available options are asc (ascending) and desc (descending). The default value is desc.



related_product_id The id of a product to use for filtering. If provided, it will return the products that are related to this product. Note that the results are not returned in the same order as the one saved on the related product.