AppsThemesAPIs and referencesChangelogSupportFeedBack
Apps
Log inSign up

Variant Details

get https://{shopdomain}.myshoplaza.com/openapi/2022-01/variants/

🔒

Requires read_product access scope. More access scope

The Variant Details API allows you to retrieve detailed information about a specific product variant. Variants represent specific configurations of a product, such as different sizes, colors, or styles. This endpoint requires a valid variant_id and provides detailed data about the variant, including its pricing, inventory, SKU, and other attributes. Use this API to fetch information for managing or displaying specific variants in your system.This API is especially useful for:

  1. Fetch pricing, inventory, and other details for a specific variant.
  2. Support detailed product management by accessing individual variant data.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredExampleDescription
variant_idstringYes9fb9f3c6-2300-42c1-8593-d9008d7cfc09The unique identifier for the variant.

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

Field Type Example Description
variant.id string 1b735278-62c7-41ad-9976-b1b63a90590d Unique identifier for the variant.
variant.product_id string 636a07da-39eb-4829-bde9-b65fae1c28b0 Unique identifier for the associated product.
variant.image_id string 91d032e7-bbc8-47e4-8668-9ba6fe714de6 Unique identifier for the associated image.
variant.created_at string (date) 2024-04-15T02:00:57Z Timestamp indicating when the variant was created.
variant.updated_at string (date) 2024-04-15T02:00:57Z Timestamp indicating when the variant was last updated.
variant.title string S-red Title of the variant.
variant.option1 string S First option value for the variant (e.g., size).
variant.option2 string red Second option value for the variant (e.g., color).
variant.option3 string "" Third option value for the variant, if applicable.
variant.image object Image Object
variant.image.src string //cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png URL of the image associated with the variant.
variant.image.width integer 1588 Width of the variant image in pixels.
variant.image.height integer 2246 Height of the variant image in pixels.
variant.image.path string efd33b921cacd5311a32dd03a9bc8740.png File path of the variant image.
variant.image.alt string "" Alternative text for the variant image.
variant.position integer 1 Position of the variant in the product's variant list.
variant.compare_at_price string 100.00 Original price of the variant before discounts.
variant.price string 100.00 Current price of the variant.
variant.sku string S-RED Stock Keeping Unit (SKU) for the variant.
variant.barcode string 123 Barcode associated with the variant.
variant.note string s-red Notes or additional information about the variant.
variant.inventory_quantity integer 10 Number of items available in inventory for the variant.
variant.weight string 0.10 Weight of the variant.
variant.weight_unit string kg Unit of measurement for the weight (e.g., kg, lb).
variant.cost_price string 11.00 Cost price of the variant.
variant.wholesale_price object wholesale price object
variant.wholesale_price.price string 100.00 Wholesale price for the variant.
variant.wholesale_price.min_quantity integer 1 Minimum quantity required to avail the wholesale price.

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

FieldTypeExampleDescription
errorsArray["Context"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorArray "store is not active"Indicates an error encountered during the process.

Error Details

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
422Variant Not FoundThe variant ID provided in the request does not exist.{ "errors": ["Record not found"] }
Invalid or empty variant_idmissing required variant_id or variant_id with incorrect UUID types{ "errors": [ "variant_id has an invalid UUID"]}

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!

Support

Shoplazza

Updates

Partner Program

Support

Shoplazza

Updates

Partner Program

Follow Us

© Shoplazza
Partner Program Agreement API Terms Terms of Service Privacy Policy Use Policy