productVariants

query

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Retrieve the list of product variants.

Arguments

Order the base list in ascending manner using the specified sort key.

after ● String

Returns elements following the specified cursor. The first argument must also be specified when using this argument.

before ● String

Returns elements preceding the specified cursor. The last argument must also be specified when using this argument.

first ● Int

Returns the first n elements in the list.

last ● Int

Returns the last n elements in the list.

reverse ● Boolean

Whether to reverse the order of the list.

● true: reverse

● false: do not reverse

Default value: false

query ● String

Use one or more filters for the query.

parameter	description
barcode	The barcode value linked to the product.
collection	The ID of the collection.
gift_card	Specify if the product is a gift card item (boolean value passed).
inventory_quantity	Product variant's available inventory.
location_id	The ID of the location
option1	The 1st option value of the product variant
option2	The 2nd option value of the product variant
option3	The 3rd option value of the product variant
option4	The 4th option value of the product variant
option5	The 5th option value of the product variant
product_ids	The ID of the product (currently does not support passing in multiple IDs)
product_status	The product's status.
product_type	A product type customized by the merchant.
sku	The SKU of the product variant, a case-sensitive string.
tag	The tags associated with the product.
taxable	Whether the variant is taxed when sold (boolean value passed).
title	The product's title.
updated_at	The last modified date and time of the product variant.
vendor	The vendor name of the product.
spu	The product's SPU code.

tip

The current supports a maximum of 5 parameters. Optimizations will be implemented in the future.

title:'test' AND inventory_quantity:>=1000

Return

List of edge nodes.

pageInfo ● PageInfo!non-null

Pagination Assistance Information.

Status and error codes

For detailed information about common codes, see Status and error codes.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy