POST

Query Product Variants


Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs. See Stores Pagination for more information.

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/products/{id}/variants/query

Path Params
idstringRequired

Requested product ID.

Body Params
choicesMap <string, string>format map

The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).


variantIdsArray <string>

List of variant IDs (not relevant when passing choices).


pagingPaging

includeMerchantSpecificDataboolean

Whether merchant specific data should be included in the response. Requires permissions to manage products.

Response Object
variantsArray <Variant>

List of variants based on the specified filters and sorting.


metadataMetadata

totalResultsinteger
Query Product Variants Example 1
Request
cURL
Response
JSON
Errors

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

Did this help?