List products

get

https://api.ecommerceapi.uk/v1/products

Retrieves a list of products with pagination, optionally filtering by active/inactive status, and sorted by creation date if no other sort parameter is provided. By default, the first 50 products (both active and inactive) are returned, sorted by creation date.

Query Params

count

integer

Defaults to 50

The maximum number of results to be returned (default: 50).

offset

integer

The starting position for the returned values.

sort

string

enum

Sorting order for the results. If not included, results are sorted by creation date.

Allowed:

active

integer

enum

Indicates whether to return active or inactive products (1 or 0, respectively). If not included, active and inactive products are returned.

Allowed:

fields

string

Comma-separated list of fields to include in the response.

embed

string

Comma-separated list of related resources to embed in the response. Possible values: 'images', 'brand', 'categories', 'related', 'extras', 'customization_fields', 'ebay_shipping_rates', 'options', 'vat_relief', 'digital_files', 'variations', 'choices', 'custom_fields', 'out_of_stock_settings'.

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of products.