Returns a list of up to 100 products, given the provided paging, sorting and filtering. See Stores Pagination for more information.
Whether variants should be included in the response.
Whether hidden products should be included in the response. Requires permissions to manage products.
Whether merchant specific data should be included in the response. Requires permissions to manage products.
curl -X POST \
'https://www.wixapis.com/stores/v1/products/query' \
--data-binary '{
"includeVariants": true
}' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'{
"products": [
{
"id": "131604aa-169f-d3e8-f076-a967b03e880c",
"name": "T-Shirt",
"slug": "t-shirt",
"visible": true,
"productType": "physical",
"description": "<p>Made from 100% cotton</p>",
"stock": {
"trackInventory": true,
"quantity": 300,
"inStock": true
},
"price": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"additionalInfoSections": [
{
"title": "Care Instructions",
"description": "<p>Wash with similar colors</p>\n"
}
],
"ribbons": [
{
"text": "Soft and comfy"
}
],
"ribbon": "Soft and comfy",
"brand": "Nice",
"media": {
"mainMedia": {
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg",
"width": 1500,
"height": 1500
},
"id": "c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg"
},
"items": [
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg",
"width": 1500,
"height": 1500
},
"id": "c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg"
},
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg",
"width": 1280,
"height": 1600
},
"id": "c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg"
}
]
},
"customTextFields": [
{
"title": "What would like us to print on the t-shirt?",
"maxLength": 100,
"mandatory": false
}
],
"manageVariants": true,
"productOptions": [
{
"optionType": "drop_down",
"name": "Size",
"choices": [
{
"value": "Small",
"description": "Small",
"media": {
"items": []
},
"inStock": true,
"visible": true
},
{
"value": "Medium",
"description": "Medium",
"media": {
"items": []
},
"inStock": true,
"visible": true
},
{
"value": "Large",
"description": "Large",
"media": {
"items": []
},
"inStock": true,
"visible": true
}
]
},
{
"optionType": "drop_down",
"name": "Color",
"choices": [
{
"value": "White",
"description": "White",
"media": {
"mainMedia": {
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg",
"width": 1500,
"height": 1500
},
"id": "c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg"
},
"items": [
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg",
"width": 1500,
"height": 1500
},
"id": "c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg"
}
]
},
"inStock": true,
"visible": true
},
{
"value": "Black",
"description": "Black",
"media": {
"mainMedia": {
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg",
"width": 1280,
"height": 1600
},
"id": "c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg"
},
"items": [
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg",
"width": 1280,
"height": 1600
},
"id": "c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg"
}
]
},
"inStock": true,
"visible": true
}
]
}
],
"productPageUrl": {
"base": "www.my-website.com",
"path": "/product-page/t-shirt"
},
"numericId": "1608035843758000",
"inventoryItemId": "ece9fb55-e960-2c17-0f89-56984fc177f3",
"discount": {
"type": "NONE",
"value": 0
},
"collectionIds": [],
"variants": [
{
"id": "c9f8678b-af10-4dc2-8e0e-3e823a5491df",
"choices": {
"Size": "Small",
"Color": "White"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10000",
"visible": true
}
},
{
"id": "44be1f7b-d32d-419d-b04d-a2a9342cf9e6",
"choices": {
"Size": "Small",
"Color": "Black"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10003",
"visible": true
}
},
{
"id": "75f7dbd2-9c6c-47bb-8d39-fe7de085a942",
"choices": {
"Size": "Medium",
"Color": "White"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10001",
"visible": true
}
},
{
"id": "9fbd21c2-6480-4428-89f6-304d48f081e2",
"choices": {
"Size": "Medium",
"Color": "Black"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10004",
"visible": true
}
},
{
"id": "e9f502a9-a770-4441-a407-b9d043c22b85",
"choices": {
"Size": "Large",
"Color": "White"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10002",
"visible": true
}
},
{
"id": "c9904f6b-d82f-4872-a4d9-de5ef5580126",
"choices": {
"Size": "Large",
"Color": "Black"
},
"variant": {
"priceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 10,
"discountedPrice": 10,
"formatted": {
"price": "$10.00",
"discountedPrice": "$10.00"
}
},
"weight": 0.3,
"sku": "10005",
"visible": true
}
}
],
"lastUpdated": "2020-12-15T14:00:27.415Z",
"seoData": {
"tags": [
{
"type": "title",
"children": "T-Shirt",
"custom": false,
"disabled": false
},
{
"type": "meta",
"props": {
"name": "description",
"content": "Made from 100% organic cotton"
},
"children": "",
"custom": false,
"disabled": false
}
]
}
},
{
"id": "0873ed58-f88d-77d1-4566-afd4c50d253e",
"name": "Digital product",
"slug": "digital-product",
"visible": true,
"productType": "digital",
"description": "<p>A digital product delivered upon payment</p>",
"sku": "",
"weight": 0,
"stock": {
"trackInventory": false,
"inStock": true
},
"price": {
"currency": "USD",
"price": 20,
"discountedPrice": 20,
"formatted": {
"price": "$20.00",
"discountedPrice": "$20.00"
}
},
"priceData": {
"currency": "USD",
"price": 20,
"discountedPrice": 20,
"formatted": {
"price": "$20.00",
"discountedPrice": "$20.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 20,
"discountedPrice": 20,
"formatted": {
"price": "$20.00",
"discountedPrice": "$20.00"
}
},
"additionalInfoSections": [],
"ribbons": [
{
"text": "New arrival"
}
],
"ribbon": "New arrival",
"brand": "Nice",
"media": {
"items": []
},
"customTextFields": [],
"manageVariants": false,
"productOptions": [],
"productPageUrl": {
"base": "https://www.my-website.com",
"path": "/product-page/digital-product"
},
"numericId": "1608041194964000",
"inventoryItemId": "f78c12a7-0772-882e-ba99-502b3af2dac1",
"discount": {
"type": "NONE",
"value": 0
},
"collectionIds": [],
"variants": [
{
"id": "00000000-0000-0000-0000-000000000000",
"choices": {},
"variant": {
"priceData": {
"currency": "USD",
"price": 20,
"discountedPrice": 20,
"formatted": {
"price": "$20.00",
"discountedPrice": "$20.00"
}
},
"convertedPriceData": {
"currency": "USD",
"price": 20,
"discountedPrice": 20,
"formatted": {
"price": "$20.00",
"discountedPrice": "$20.00"
}
},
"weight": 0,
"sku": "",
"visible": true
}
}
],
"lastUpdated": "2020-12-15T14:06:34.964Z"
}
],
"metadata": {
"items": 100,
"offset": 0
},
"totalResults": 2
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.