v1
latestOpenAPI 3.1.02026-07-242470655.6 KBList Products
Get products page. Default page response size is 50, max requested page size is 200.
get/sites/multiscreen/{site_name}/ecommerce/products
Path parameters
site_namestring required
The unique identifier for the target site.
Query parameters
offsetinteger
Zero-based offset for elements (0..N)
limitinteger
The size of the page to be returned
sortstring
Sorting criteria in the format: property(asc|desc). Sort order is optional, default sort order is ascending. Multiple sort criteria are supported.
directionstring
[asc, desc] Order direction for the property specified in sort
Response
200
Example response
{
"results": [
{
"categories": [
{
"id": "WMd1xylGrp",
"title": "Men shoes"
}
],
"custom_fields": [
{
"id": "01J44P3PR742P3MRJ11HRT43Q2",
"value": "This is a tagline"
}
],
"description": "The most amazing t shirt ever sold",
"external_id": "KTP9XGbSg2",
"id": "IakdKbiUiK",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"managed_inventory": true,
"name": "Amazing T-shirt",
"options": [
{
"choices": [
{
"id": "db3je27rg7",
"value": "45"
}
],
"id": "WMd1xylGrp",
"name": "Shirt size"
}
],
"prices": [
{
"compare_at_price": "19.99",
"currency": "USD",
"price": "12.34"
}
],
"quantity": 25,
"requires_shipping": true,
"seo": {
"description": "Amazing T-shirt made with 100% biologic cotton",
"product_url": "amazing-t-shirt",
"title": "Amazing T-shirt"
},
"sku": "UGG-BB-PUR-06",
"status": "HIDDEN",
"stock_status": "IN_STOCK, OUT_OF_STOCK",
"type": "PHYSICAL",
"variations": [
{
"external_id": "KTP9XGbSg2",
"id": "KTP9XGbSg2",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"options": [
{
"choice_id": "db3je27rg7",
"choice_value": "45",
"option_id": "WMd1xylGrp",
"option_name": "Shirt size"
}
],
"price_difference": "string",
"quantity": 25,
"sku": "UGG-BB-PUR-06",
"status": "HIDDEN"
}
]
}
],
"site_name": "string"
}