POST

Query Store Variants

Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores-reader/v1/variants/query
Body Params
queryQuery

Query options.

Response Object
variantsArray <StoreVariant>

List of variants based on the specified filters and sorting.

metadataMetadata

Details on the paged set of results returned.

Query Store Variants Example 1
Request
cURL
curl -X POST \
   'https://www.wixapis.com/stores/v1/variants/query' \
   -H 'Content-Type: application/json' \
   -H 'Authorization: <AUTH>'
Response
JSON
{
  "variants": [
    {
      "id": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0020-0005-ad9cdc10d3b8",
      "variantId": "00000000-0000-0020-0005-ad9cdc10d3b8",
      "productId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
      "variantName": "250g | Stovetop",
      "productName": "Indonesian Blend",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg",
          "height": 3951,
          "width": 2977
        }
      },
      "customFields": {}
    },
    {
      "id": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0021-0005-ad9cdc10d3b8",
      "variantId": "00000000-0000-0021-0005-ad9cdc10d3b8",
      "productId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
      "variantName": "250g | Filter",
      "productName": "Indonesian Blend",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg",
          "height": 3951,
          "width": 2977
        }
      },
      "customFields": {}
    },
    {
      "id": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-003f-0005-ad9cdc10d3b8",
      "variantId": "00000000-0000-003f-0005-ad9cdc10d3b8",
      "productId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
      "variantName": "500g | Stovetop",
      "productName": "Indonesian Blend",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg",
          "height": 3951,
          "width": 2977
        }
      },
      "customFields": {}
    },
    {
      "id": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0040-0005-ad9cdc10d3b8",
      "variantId": "00000000-0000-0040-0005-ad9cdc10d3b8",
      "productId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
      "variantName": "500g | Filter",
      "productName": "Indonesian Blend",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg",
          "height": 3951,
          "width": 2977
        }
      },
      "customFields": {}
    },
    {
      "id": "0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7",
      "variantId": "00000000-0000-0020-0005-a316f7c67df7",
      "productId": "0614129c-8777-9f3b-4dfe-b80a54df10d5",
      "variantName": "250g | Stovetop",
      "productName": "Brazilian Arabica",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg",
          "height": 2992,
          "width": 4517
        }
      },
      "customFields": {}
    },
    {
      "id": "0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0021-0005-a316f7c67df7",
      "variantId": "00000000-0000-0021-0005-a316f7c67df7",
      "productId": "0614129c-8777-9f3b-4dfe-b80a54df10d5",
      "variantName": "250g | Filter",
      "productName": "Brazilian Arabica",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg",
          "height": 2992,
          "width": 4517
        }
      },
      "customFields": {}
    },
    {
      "id": "0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-003f-0005-a316f7c67df7",
      "variantId": "00000000-0000-003f-0005-a316f7c67df7",
      "productId": "0614129c-8777-9f3b-4dfe-b80a54df10d5",
      "variantName": "500g | Stovetop",
      "productName": "Brazilian Arabica",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg",
          "height": 2992,
          "width": 4517
        }
      },
      "customFields": {}
    },
    {
      "id": "0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0040-0005-a316f7c67df7",
      "variantId": "00000000-0000-0040-0005-a316f7c67df7",
      "productId": "0614129c-8777-9f3b-4dfe-b80a54df10d5",
      "variantName": "500g | Filter",
      "productName": "Brazilian Arabica",
      "managedVariant": true,
      "sku": "",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg",
          "height": 2992,
          "width": 4517
        }
      },
      "customFields": {}
    },
    {
      "id": "91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0020-0005-a316e6ba5b37",
      "variantId": "00000000-0000-0020-0005-a316e6ba5b37",
      "productId": "91f7ac8b-2baa-289c-aa50-6d64764f35d3",
      "variantName": "250g | Stovetop",
      "productName": "Colombian Arabica",
      "managedVariant": true,
      "sku": "10001",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg",
          "height": 3376,
          "width": 6000
        }
      },
      "customFields": {}
    },
    {
      "id": "91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0021-0005-a316e6ba5b37",
      "variantId": "00000000-0000-0021-0005-a316e6ba5b37",
      "productId": "91f7ac8b-2baa-289c-aa50-6d64764f35d3",
      "variantName": "250g | Filter",
      "productName": "Colombian Arabica",
      "managedVariant": true,
      "sku": "10003",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "250g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg",
          "height": 3376,
          "width": 6000
        }
      },
      "customFields": {}
    },
    {
      "id": "91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-003f-0005-a316e6ba5b37",
      "variantId": "00000000-0000-003f-0005-a316e6ba5b37",
      "productId": "91f7ac8b-2baa-289c-aa50-6d64764f35d3",
      "variantName": "500g | Stovetop",
      "productName": "Colombian Arabica",
      "managedVariant": true,
      "sku": "10002",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Stovetop"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg",
          "height": 3376,
          "width": 6000
        }
      },
      "customFields": {}
    },
    {
      "id": "91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0040-0005-a316e6ba5b37",
      "variantId": "00000000-0000-0040-0005-a316e6ba5b37",
      "productId": "91f7ac8b-2baa-289c-aa50-6d64764f35d3",
      "variantName": "500g | Filter",
      "productName": "Colombian Arabica",
      "managedVariant": true,
      "sku": "10004",
      "stock": {
        "trackQuantity": false,
        "quantity": 0,
        "inStock": true
      },
      "choices": {
        "Weight": "500g",
        "Ground for": "Filter"
      },
      "collectionIds": ["32fd0b3a-2d38-2235-7754-78a3f819274a"],
      "media": {
        "image": {
          "id": "nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg",
          "url": "https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg",
          "height": 3376,
          "width": 6000
        }
      },
      "customFields": {}
    }
  ],
  "metadata": {
    "count": 12,
    "offset": 0,
    "total": 12,
    "cursors": {}
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?