本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

List Product Variants

Develop Env

https://echo.apifox.com/anything

GET

/products/{product}/variants

Product Variants

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

This endpoint allows you to list all product variants directly from this endpoint by passing the product as a path parameter.

Scopes

products.read- Products Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

product

integer

required

Product ID. List of Product ID can be found here.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (ProductVariant) {21}]

optional

number

required

A unique identifier associated with a specific variant of a product or item.

price

object

required

The price of the product variant.

regular_price

object

required

The regular price of the product variant.

cost_price

object

required

The purchase price at which a product or item was acquired, excluding any additional expenses or markups.

sale_price

object

required

The sale price of the product variant.

has_special_price

boolean

read-onlyrequired

Whether or not the product variant has a special price.

stock_quantity

integer

required

The amount of the product variant total stock quantity. Only updated if the store feature manage product by branches is not activated.

Example:

unlimited_quantity

boolean

required

Whether or not the product variant is of unlimit quantity.

notify_low

integer

required

Sets a threshold value to trigger notifications when inventory falls below.

barcode

string

required

The barcode value of product variant.

Example:

abc01

sku

string

required

A unique Stock Keeping Unit (SKU) identifier assigned to a specific variant of a product.

Example:

23-TD23-32

mpn

string

required

Manufacturer Part Number, a unique identifier assigned by a manufacturer to a specific product or component, which helps distinguish it from other similar products and facilitates inventory management, product tracking, and ordering processes.

gtin

string

required

Global Trade Item Number, a unique and standardized identifier used to uniquely represent products, items, or services in the global marketplace, to enable efficient tracking and management across supply chains and retail sectors. If product_type is set to any of the following: product, group_products, codes, digital, donating then value can be set. Otherwise, it can be set to null

updated_at

object (Date)

required

The date and time product variant is updated.

related_options

array[integer]

required

An array for the related options to this variant.

related_option_values

array[integer]

required

An array for the values of the related options to this variant.

weight

number

required

The numerical value that represents the mass or weight of a specific variant of a product.

Example:

weight_type

string

required

Product Variant Weight Type

Example:

weight_label

string

required

Product variant weight label representing the type of the weight.

Example:

٣ كجم

is_user_subscribed_to_sku

boolean

read-onlyrequired

Whether or not the user subscribed for the sku.

is_default

boolean

required

Whether or not enable showing that the product variant is the default

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 652911549,
            "price": {
                "amount": 13.5,
                "currency": "SAR"
            },
            "sale_price": {
                "amount": 0,
                "currency": "SAR"
            },
            "regular_price": {
                "amount": 0,
                "currency": "SAR"
            },
            "stock_quantity": 3000,
            "barcode": "barcode-ABC",
            "sku": "sku-variant-1551119600",
            "related_option_values": [
                667315336
            ],
            "weight": 3,
            "weight_type": "kg",
            "weight_label": "٣ كجم"
        }
    ],
    "pagination": {
        "count": 1,
        "total": 1,
        "perPage": 60,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

🟠404Not Found

🟠401Unauthorized

Product Variants

Product Variant Details