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.
Arguments
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
parameterdescription
created_atThe creation date and time of the product.
updated_atThe last modified date and time of the product.
titleThe product's title.
tagThe tags associated with the product.
idThe ID of the product.
barcodeThe barcode value linked to the product.
gift_cardSpecify if the product is a gift card item (boolean value passed).
inventory_totalProduct's available inventory.
out_of_stock_somewhereDesignate if partially out of stock (boolean value passed).
pricePrice of the product variant in decimal format.
product_typeA product type customized by the merchant.
published_statusOnline store's publication status.
statusThe product's status.
skuThe SKU of the product variant, a case-sensitive string.
vendorThe vendor name of the product.
spuThe product's SPU code.
tip
The current supports a maximum of 30 parameters. Optimizations will be implemented in the future.

Grammar reference

title:'test' AND inventory_total:>=1000
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.
Return
edges ● [ProductEdge!]non-null
List of edge nodes.
More
nodes ● [Product!]non-null
List of nodes contained within a ProductEdge.
More
pageInfo ● PageInfo!non-null
Pagination Assistance Information.
More
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?