xclade
Store APIProducts

List Products

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

GET
/store/products

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.

offset?number

The number of items to skip when retrieving a list.

limit?number

Limit the number of items returned in the list.

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 -.

$and?

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

$or?

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

q?string

Search term to filter the product's searchable properties.

id?id|
title?title|

Filter by product titles.

handle?handle|

Filter by product handles.

is_giftcard?boolean

Whether the product is a gift card.

collection_id?unknown

Filter by a collection's ID to retrieve the products in it.

tag_id?tag_id|

Filter by a tag's ID to retrieve the products in it.

type_id?type_id|

Filter by a type's ID to retrieve the products in it.

created_at?

Filter by the product's creation date.

updated_at?

Filter by the product's update date.

region_id?string

The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.

province?string

The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.

sales_channel_id?sales_channel_id|
category_id?category_id|
variants?

Filter the products' variants.

country_code?string

The product's country code.

cart_id?string

The product's cart id.

Header Parameters

x-publishable-api-key*string

Publishable API Key created in the Medusa Admin.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/store/products" \  -H "x-publishable-api-key: string"
{
  "limit": 0,
  "offset": 0,
  "count": 0,
  "products": [
    {}
  ]
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}