Get a product variant

Requires read_products access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/products/variants/:variant_id.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Get the product variant information based on the variant ID.

Path Parameters

variant_id string required

The unique identifier for a variant.
Maximum length：64

Example: 18057039439794751459380282

Query Parameters

fields string

Specify the fields to be returned, with multiple fields separated by commas. For available fields, refer to the top-level child parameters under the variant object in the response.

Example: id,title

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

variantobject

Variant information.
price string

The selling price of the variant. The value is rounded to two decimal places.
Example: 90.22
required_shipping boolean

Indicates whether the variant is required to be shipped.

true: Shipping is required.

false: Shipping is not required.
title string

The title of the variant, assembled from the option value of the variant.
Example: red · xl
barcode string

The barcode of the variant.
Example: T00000001
weight_unit string

The unit of weight for the variant. Valid values are:

g: gram

kg: kilogram

lb: pound

oz: ounce

zh_kg: kilogram
compare_at_price string

The original price of the variant. The value is rounded to two decimal places.
Example: 129.99
imageobject

The image of the variant.
src string

The link to the variant image, represented as a URL.
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
alt string

The alternative textual description of the variant image, usually a word or phrase with the characteristics or content of the image.
Example: This is an image alt.
id string

The unique identifier for the variant image.
Example: 5785060242207917075
inventory_policy string

Indicates whether the variant is allowed to be oversold.

deny: Does not allow overselling.

continue: Allow overselling.
inventory_quantity integer

The total inventory quantity at all storage locations.
Example: 99
inventory_tracker boolean

Indicates whether the inventory tracking is enabled.

true: Inventory tracking is enabled.

false: Inventory tracking is not enabled.
option3 string

Information of the third option of the variant.
Example: cotton
product_id string

The unique identifier for the product corresponding to the variant.
Example: 16057039432335097907370282
id string

The unique identifier for the variant.
Example: 18057039439794751459380282
inventory_item_id string

The unique identifier for the inventory item.
Example: 5785060242375689228
option1 string

Information of the first option of the variant.
Example: red
option2 string

Information of the second option of the variant.
Example: xl
option4 string

Information of the fourth option of the variant.
Example: short
sku string

The product SKU. It is distinct from variant.id returned by SHOPLINE.
Example: S0000000001
taxable boolean

Indicates whether the variant is subject to tax.

true: Tax is required.

false: Tax is not required.
weight string

The weight of the variant. The value is rounded up if it exceeds two decimal places.
Example: 0.23
option5 string

Information of the fifth option of the variant.
Example: casual

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

variant_id — path required

Authorization — header required

fields — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/products/variants/variant_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal