> For the complete documentation index, see [llms.txt](https://docs.partner.aboutyou.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.partner.aboutyou.com/api/products/get-products.md).

# Get Products

## Get Products

> List product variants by \`page\` (deprecated) or by \`cursor\`.\
> \
> A cursor comes from the previous response's \`pagination.next\_cursor\`, and\
> cursor mode omits \`page\`, \`pages\` and \`total\`.\
> \
> \*\*Rate limit:\*\* 1000 requests per minute

```json
{"openapi":"3.1.0","info":{"title":"Sellers Center API","version":"1.3.3"},"security":[{"APIKeyAuth":[]}],"components":{"securitySchemes":{"APIKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Status":{"enum":["draft","pending_approval","rejected","pending_active","active","inactive","problem"],"title":"Status","type":"string"},"GetProductsResponseSchema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetProductItemSchema"},"title":"Items","type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["items","pagination"],"title":"GetProductsResponseSchema","type":"object"},"GetProductItemSchema":{"properties":{"style_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Style Key"},"status":{"$ref":"#/components/schemas/Status"},"colorway_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reference key for the colorway, one style in one color combination. Sits between style_key and sku.","title":"Colorway Key"},"sku":{"title":"Sku","type":"string"},"ean":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ean"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"deprecated":true,"description":"Use descriptions instead","title":"Description"},"descriptions":{"anyOf":[{"$ref":"#/components/schemas/LocalizedDescriptionSchema"},{"type":"null"}]},"color":{"anyOf":[{"type":"integer"},{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"description":"Color attribute id, or a list of ids ordered by attribute sort when the product carries more than one color.","title":"Color"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size"},"second_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Second Size"},"brand":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Brand"},"category":{"title":"Category","type":"integer"},"category_secondary":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Id of the unisex counterpart the product is also listed in. Null otherwise, and always while the unisex listing is not offered.","title":"Category Secondary"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stock quantity of the product variant in the merchant's warehouse.","title":"Quantity"},"quantity_fbm":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stock quantity of the product variant in ABOUT YOU warehouses.","title":"Quantity Fbm"},"weight":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Weight"},"countries":{"anyOf":[{"items":{"description":"ISO 3166-1 alpha-2 country code","pattern":"^[A-Za-z]{2}$","type":"string"},"type":"array"},{"type":"null"}],"title":"Countries"},"country_of_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Of Origin"},"attributes":{"items":{"type":"integer"},"title":"Attributes","type":"array"},"material_composition_textile":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaterialCompositionTextileSchema"},"type":"array"},{"type":"null"}],"title":"Material Composition Textile"},"material_composition_non_textile":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaterialCompositionNonTextileSchema"},"type":"array"},{"type":"null"}],"title":"Material Composition Non Textile"},"prices":{"items":{"$ref":"#/components/schemas/PriceSchema"},"title":"Prices","type":"array"},"images":{"items":{"type":"string"},"title":"Images","type":"array"}},"required":["style_key","status","colorway_key","sku","ean","name","description","descriptions","color","size","second_size","brand","category","category_secondary","quantity","quantity_fbm","weight","countries","country_of_origin","attributes","prices","images"],"title":"GetProductItemSchema","type":"object"},"LocalizedDescriptionSchema":{"additionalProperties":{"type":"string"},"description":"Schema for handling localized descriptions with locale keys.","title":"LocalizedDescriptionSchema","type":"object"},"MaterialCompositionTextileSchema":{"properties":{"cluster_id":{"description":"ID (integer) of this property","minimum":1,"title":"Cluster Id","type":"integer"},"components":{"items":{"$ref":"#/components/schemas/TextileMaterialSchema"},"title":"Components","type":"array"}},"required":["cluster_id","components"],"title":"MaterialCompositionTextileSchema","type":"object"},"TextileMaterialSchema":{"properties":{"material_id":{"description":"ID (integer) of this property","minimum":1,"title":"Material Id","type":"integer"},"fraction":{"description":"Fraction of the material in the composition in percentage.","title":"Fraction","type":"integer"}},"required":["material_id","fraction"],"title":"TextileMaterialSchema","type":"object"},"MaterialCompositionNonTextileSchema":{"properties":{"cluster_id":{"description":"ID (integer) of this property","minimum":1,"title":"Cluster Id","type":"integer"},"components":{"items":{"$ref":"#/components/schemas/NonTextileMaterialSchema"},"title":"Components","type":"array"}},"required":["cluster_id","components"],"title":"MaterialCompositionNonTextileSchema","type":"object"},"NonTextileMaterialSchema":{"properties":{"material_id":{"description":"ID (integer) of this property","minimum":1,"title":"Material Id","type":"integer"}},"required":["material_id"],"title":"NonTextileMaterialSchema","type":"object"},"PriceSchema":{"properties":{"country_code":{"description":"ISO 3166-1 alpha-2 country code","pattern":"^[A-Za-z]{2}$","title":"Country Code","type":"string"},"currency":{"anyOf":[{"description":"ISO 4217 alpha-3 currency code","pattern":"^[A-Za-z]{3}$","type":"string"},{"type":"null"}],"description":"**Warning:** this field is currently optional, but will become mandatory soon - always send it. Currency the prices are denominated in. Must match the currency configured for the country - see the countries endpoint for the currency of each country.","title":"Currency"},"retail_price":{"exclusiveMinimum":0,"maximum":1000000,"title":"Retail Price","type":"number"},"sale_price":{"anyOf":[{"exclusiveMinimum":0,"maximum":1000000,"type":"number"},{"type":"null"}],"title":"Sale Price"}},"required":["country_code","retail_price"],"title":"PriceSchema","type":"object"},"Pagination":{"properties":{"per_page":{"description":"Number of items per page.","exclusiveMinimum":0,"title":"Per Page","type":"integer"},"page":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"type":"null"}],"description":"Page number (null in cursor mode).","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"Total pages (null in cursor mode).","title":"Pages"},"total":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"Total count (null in cursor mode).","title":"Total"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL for next page (null in cursor mode).","title":"Next"},"prev":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL for previous page (null in cursor mode).","title":"Prev"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opaque cursor for next page when using cursor-based pagination.","title":"Next Cursor"}},"required":["per_page"],"title":"Pagination","type":"object"},"BadRequestSchema":{"properties":{"message":{"description":"Error message","title":"Message","type":"string"}},"required":["message"],"title":"BadRequestSchema","type":"object"}}},"paths":{"/api/v1/products/":{"get":{"operationId":"scapi_app_endpoints_product_api_get_products","summary":"Get Products","parameters":[{"in":"query","name":"style_key","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Style key to search for","title":"Style Key"},"required":false,"description":"Style key to search for"},{"in":"query","name":"sku","schema":{"anyOf":[{"items":{"description":"Stock Keeping Unit identifier","maxLength":120,"type":"string"},"maxItems":100,"type":"array"},{"type":"null"}],"description":"Exact SKU to filter by. Repeat the parameter for up to 100 SKUs.","title":"SKU"},"required":false,"description":"Exact SKU to filter by. Repeat the parameter for up to 100 SKUs."},{"in":"query","name":"status","schema":{"anyOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}],"description":"Status of the product to filter by. Choose from: \"draft\", \"pending_approval\", \"rejected\", \"pending_active\", \"active\", \"inactive\", \"problem\".","title":"Status"},"required":false,"description":"Status of the product to filter by. Choose from: \"draft\", \"pending_approval\", \"rejected\", \"pending_active\", \"active\", \"inactive\", \"problem\"."},{"in":"query","name":"page","schema":{"default":1,"deprecated":true,"description":"Page number to retrieve items from. Deprecated: offset pagination recounts the full result set on every request. Use `cursor` instead.","minimum":1,"title":"Page","type":"integer"},"required":false,"description":"Page number to retrieve items from. Deprecated: offset pagination recounts the full result set on every request. Use `cursor` instead.","deprecated":true},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":100,"minimum":1,"title":"Per Page","type":"integer"},"required":false,"description":"Number of items per page."},{"in":"query","name":"cursor","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opaque cursor from previous response for cursor-based pagination. When provided, omit page or use page=1.","title":"Cursor"},"required":false,"description":"Opaque cursor from previous response for cursor-based pagination. When provided, omit page or use page=1."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductsResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestSchema"}}}},"default":{"headers":{"X-RateLimit-Limit":{"description":"Total requests allowed in the time window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining requests in the current window","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the current window resets","schema":{"type":"integer"}}}}},"description":"List product variants by `page` (deprecated) or by `cursor`.\n\nA cursor comes from the previous response's `pagination.next_cursor`, and\ncursor mode omits `page`, `pages` and `total`.\n\n**Rate limit:** 1000 requests per minute","tags":["Products"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.partner.aboutyou.com/api/products/get-products.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.