products
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.
Arguments
Returns the last n elements in the list.
Whether to reverse the order of the list.
● true: reverse
● false: do not reverse
Default value: false
Use one or more filters for the query
| parameter | description |
|---|---|
| created_at | The creation date and time of the product. |
| updated_at | The last modified date and time of the product. |
| title | The product's title. |
| tag | The tags associated with the product. |
| id | The ID of the product. |
| barcode | The barcode value linked to the product. |
| gift_card | Specify if the product is a gift card item (boolean value passed). |
| inventory_total | Product's available inventory. |
| out_of_stock_somewhere | Designate if partially out of stock (boolean value passed). |
| price | Price of the product variant in decimal format. |
| product_type | A product type customized by the merchant. |
| published_status | Online store's publication status. |
| status | The product's status. |
| sku | The SKU of the product variant, a case-sensitive string. |
| vendor | The vendor name of the product. |
| spu | The 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
Returns elements following the specified cursor. The
first argument must also be specified when using this argument.Returns elements preceding the specified cursor. The
last argument must also be specified when using this argument.Returns the first n elements in the list.
Return
List of edge nodes.
List of nodes contained within a ProductEdge.
Pagination Assistance Information.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?