Get product variants by ID
Variants are different options of an item such as size, color, and materials. For example, there are 12 variants for a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer more options to shoppers . Note:
1. At least one variant must be specified.
2. If you don’t have product ID, use the corresponding SKU-based endpoint - GET /products/sku/{sku}/variants
.
3. The status
parameter is applicable to the id
passed in path parameter and not for the variants. That is, the variants returned as part of the response are either the variants attached to the Live or Draft version of the product based on the status
parameter.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Path Parameters
24-character system-generated product ID.
Query Parameters
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Comma-separated locale codes of product. The service throws a 400 error if the locale isn't supported. Standard locales can be found at https://www.rfc-editor.org/rfc/rfc5646. <br /> Note: The recommended way to get the locale is by invoking multi-channel service.
Comma-separated statuses indicating the preferred order of the product versions considered for this operation (endpoint action). For example, <br />1. When the status is DRAFT
, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE
, this operation will only apply to the Live version of the product, if it exists <br />3 When the status is LIVE,DRAFT
, this operation will prioritize Live version first, if it exists. Otherwise, the Draft version is considered. <br />4 When the status is DRAFT,LIVE
this operation will prioritize the Draft version first, if it exists. Otherwise, the Live version is considered.
Response
Details of variants by IDs
Was this page helpful?