---
title: "List products"
method: GET
path: "/v1/messaging/commerce/products"
tags: ["Commerce"]
---

# List products

`GET /v1/messaging/commerce/products`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/commerce/products`
- Auth: HTTP bearer

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.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Query parameters

- `limit` integer
- `query` string: Platform product search syntax (Shopify: title, vendor, product_type, tag, sku, handle, ...).
- `cursor` string: Opaque cursor from a previous response. Omit for the first page.
- `status` 'active' | 'draft' | 'pending_review' | 'rejected' | 'inactive' | 'archived' | 'deleted'
- `accountId` string, required: Connected store SocialAccount id.
- `collectionId` string: Only products in this collection.

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `products` object[]
      - `id` string: Platform-native product id.
      - `seo` object
        - `title` string, nullable
        - `description` string, nullable
      - `url` string, nullable: Public storefront URL; null while the product is not published.
      - `tags` string[]
      - `title` string
      - `handle` string, nullable: URL slug of the product.
      - `images` object[]: First 20 images, in store order.
        - `id` string, nullable: Media id, used to reorder or remove images. Null for collection images.
        - `url` string
        - `altText` string, nullable
      - `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.
      - `vendor` string, nullable
      - `options` object[]: Option axes (e.g. Size, Color) and their values.
        - `name` string
        - `values` string[]
      - `platform` 'shopify'
      - `variants` object[]: First 100 variants.
        - `id` string: Platform-native variant id.
        - `sku` string, nullable
        - `price` object: An exact amount of money. The amount is a decimal string so cents are never lost to floating point.
          - `amount` string, required
          - `currency` string, required: ISO 4217 code. Never null: the store currency is filled in when the platform omits it.
        - `title` string: Option combination label, e.g. "S / Blue".
        - `barcode` string, nullable
        - `options` object[]
          - `name` string
          - `value` string
        - `compareAtPrice` object, nullable: An exact amount of money. The amount is a decimal string so cents are never lost to floating point.
          - `amount` string, required
          - `currency` string, required: ISO 4217 code. Never null: the store currency is filled in when the platform omits it.
        - `availableForSale` boolean, nullable
        - `inventoryQuantity` integer, nullable: Units on hand; null when inventory is not tracked.
      - `accountId` string
      - `createdAt` string, date-time, nullable
      - `updatedAt` string, date-time, nullable
      - `productType` string, nullable
      - `publishedAt` string, date-time, nullable
      - `platformData` object, nullable: Platform-only fields. Null when the platform has none.
      - `featuredImage` object, nullable
        - `id` string, nullable: Media id, used to reorder or remove images. Null for collection images.
        - `url` string
        - `altText` string, nullable
      - `platformStatus` string: The raw status on the platform, e.g. ACTIVE on Shopify.
      - `totalInventory` integer, nullable
      - `descriptionHtml` string, nullable
    - `nextCursor` string, nullable
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)