Export Products

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

tags

object

Filter products by their tags.

Show child attributes

tags.id

string[]

Filter by tag IDs.

A tag ID.

variants

object

Filter the products' variants.

Show child attributes

variants.options

object

Filter the variants by their options.

Show child attributes

variants.options.value

string

The option's value.

variants.options.option_id

string

The option's ID.

variants.options.option

object

The option's details.

title

Filter products by their title.

status

Filter products by their status.

Available options:

draft,

proposed,

published,

rejected

Filter products by their ID.

sales_channel_id

Filter products by their sales channel ID.

created_at

object

Filter by a product's creation date.

Show child attributes

created_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

created_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

created_at.$eq

Filter by an exact match.

created_at.$ne

string

Filter by values not equal to this parameter.

created_at.$in

string[]

Filter by values in this array.

created_at.$nin

string[]

Filter by values not in this array.

created_at.$not

Filter by values not matching the conditions in this parameter.

created_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

created_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

created_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

created_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

created_at.$like

string

Apply a like filter. Useful for strings only.

created_at.$re

string

Apply a regex filter. Useful for strings only.

created_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

created_at.$fulltext

string

Filter to apply on full-text properties.

created_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

created_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

created_at.$contained

string[]

Filter arrays that contain all values of this parameter.

created_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

updated_at

object

Filter by a product's update date.

Show child attributes

updated_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

updated_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

updated_at.$eq

Filter by an exact match.

updated_at.$ne

string

Filter by values not equal to this parameter.

updated_at.$in

string[]

Filter by values in this array.

updated_at.$nin

string[]

Filter by values not in this array.

updated_at.$not

Filter by values not matching the conditions in this parameter.

updated_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

updated_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

updated_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

updated_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

updated_at.$like

string

Apply a like filter. Useful for strings only.

updated_at.$re

string

Apply a regex filter. Useful for strings only.

updated_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

updated_at.$fulltext

string

Filter to apply on full-text properties.

updated_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

updated_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

updated_at.$contained

string[]

Filter arrays that contain all values of this parameter.

updated_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

handle

Filter products by their handle.

is_giftcard

boolean

Filter products by whether they are gift cards. Whether the product is a gift card.

collection_id

Filter products by their collection ID.

type_id

Filter products by their type ID.

deleted_at

object

Filter by a product's deletion date.

Show child attributes

deleted_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

deleted_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

deleted_at.$eq

Filter by an exact match.

deleted_at.$ne

string

Filter by values not equal to this parameter.

deleted_at.$in

string[]

Filter by values in this array.

deleted_at.$nin

string[]

Filter by values not in this array.

deleted_at.$not

Filter by values not matching the conditions in this parameter.

deleted_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

deleted_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

deleted_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

deleted_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

deleted_at.$like

string

Apply a like filter. Useful for strings only.

deleted_at.$re

string

Apply a regex filter. Useful for strings only.

deleted_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

deleted_at.$fulltext

string

Filter to apply on full-text properties.

deleted_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

deleted_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

deleted_at.$contained

string[]

Filter arrays that contain all values of this parameter.

deleted_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

order

string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

The product's q.

category_id

Filter products by their category ID.

limit

number

Limit the number of items returned in the list.

offset

number

The number of items to skip when retrieving a list.

with_deleted

boolean

The product's with deleted.

$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

price_list_id

Filter products by the ID of a price list they belong to.

Response

The details of the product export.

transaction_id

string

required

The ID of the workflow execution's transaction. Use it to check the status of the export by sending a GET request to /admin/workflows-executions/export-products/:transaction-id

Overview

Scanner API

Admin API

Authorizations

Query Parameters

Response