Sign in
Commerce

List products

Lists the store's products with their variants, options and images. Cursor-paginated: pass limit (1-100, default 20) and the cursor from a previous response's nextCursor, which is null on the last page. Filter with status and/or query (the platform's product search syntax, passed through verbatim). A status the platform has no equivalent of returns an empty page.

get/v1/commerce/products

Query parameters

accountIdstring required

Connected store SocialAccount id.

limitinteger
cursorstring

Opaque cursor from a previous response. Omit for the first page.

status'active' | 'draft' | 'pending_review' | 'rejected' | 'inactive' | 'archived' | 'deleted'

Zernio product status. The platform value is returned as platformStatus. Shopify: ACTIVE, DRAFT and ARCHIVED map to the same names; UNLISTED maps to inactive.

querystring

Platform product search syntax (Shopify: title, vendor, product_type, tag, sku, handle, ...).

collectionIdstring

Only products in this collection.

Response

Products listed

nextCursorstring nullable

Example response

{
  "products": [
    {
      "variants": [
        {
          "price": {
            "amount": "19.90",
            "currency": "USD"
          },
          "compareAtPrice": {
            "amount": "19.90",
            "currency": "USD"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 2 of the 60 revisions of this API.2