List Products

get

https://marketplace-integrations.nelo.co/v1/admin/products

Retrieve a list of products. The products can be filtered by fields such as q or status. The products can also be sorted or paginated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

term to search products' title, description, variants' title and sku, and collections' title.

discount_condition_id

string

Filter by the ID of a discount condition. Only products that this discount condition is applied to will be retrieved.

Filter by product IDs.

ID of the product.

status

array of strings

Filter by status.

status

Allowed:

collection_id

array of strings

Filter by product collection IDs. Only products that are associated with the specified collections will be retrieved.

collection_id

tags

price_list_id

array of strings

Filter by IDs of price lists. Only products that these price lists are applied to will be retrieved.

price_list_id

sales_channel_id

array of strings

Filter by sales channel IDs. Only products that are available in the specified sales channels will be retrieved.

sales_channel_id

type_id

array of strings

Filter by product type IDs. Only products that are associated with the specified types will be retrieved.

type_id

category_id

array of strings

Filter by product category IDs. Only products that are associated with the specified categories will be retrieved.

category_id

include_category_children

boolean

whether to include product category children when filtering by category_id

title

string

Filter by title.

description

string

Filter by description.

handle

string

Filter by handle.

is_giftcard

boolean

Whether to retrieve gift cards or regular products.

created_at

object

Filter by a creation date range.

updated_at

object

Filter by an update date range.

deleted_at

object

Filter by a deletion date range.

offset

integer

Defaults to 0

The number of products to skip when retrieving the products.

limit

integer

Defaults to 50

Limit the number of products returned.

expand

string

Comma-separated relations that should be expanded in the returned products.

fields

string

Comma-separated fields that should be included in the returned products.

order

string

A product field to sort-order the retrieved products by.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Client Error or Multiple Errors

401User is not authorized. Must log in first

404Not Found Error

409Invalid State Error

422Invalid Request Error

500Server Error