Products

List products

Lists the products on the connected store in the platform's default order, each with its variants, options and images. Cursor-paginated: pass limit (1-50, default 20) and the cursor from a previous response's nextCursor; nextCursor is null when there are no more pages. Filter with status and/or query (the platform's product search syntax, e.g. title:*shirt* vendor:Acme tag:summer).

Supported on Shopify (platform shopify); accounts on other platforms return 400. A store connected before product access was added answers 403 insufficient_permissions until the merchant reconnects it through GET /v1/connect/shopify.

get/v1/accounts/{accountId}/products

Path parameters

accountIdstring required

Connected Shopify SocialAccount id.

Query parameters

limitinteger

Page size (1-50).

cursorstring

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

status'active' | 'draft' | 'archived'

Only products in this status.

querystring

Platform product search syntax, passed through verbatim (Shopify: title, vendor, product_type, tag, sku, handle, created_at, updated_at, ...).

Response

Products listed

platform'shopify'
nextCursorstring nullable

Cursor for the next page; null when there are no more pages.

Changes

Changed in 2 of the 56 revisions of this API.5

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added