Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Product

List Products

List all products for a workspace

get/workspaces/{workspace_id}/products

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

A comma-separated list of product IDs to filter by.

visible_in_storetrue | false

Filter products by visibility in the online store.

visible_in_customer_centertrue | false

Filter products by visibility in the customer center.

archivedtrue | false

Filter products by archived state.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,2,3",
  "visible_in_store": true,
  "visible_in_customer_center": true,
  "archived": true
}

Response

OK

idinteger

ID

public_idstring nullable

Product Public ID

workspace_idinteger

Workspace ID

namestring

Product name

current_pathstring nullable

Current Path

archivedboolean nullable

Archived

visible_in_storeboolean nullable

Visible in Store

visible_in_customer_centerboolean nullable

Visible in Customer Center

image_idstring nullable

Image

seo_titlestring nullable

A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.

seo_descriptionstring nullable

A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource).

seo_image_idstring nullable

SEO image

commissionableboolean nullable

Commissionable

{"stackTrail":"components:schemas:ProductAttributes:properties:image_ids","oasType":"schema","type":"unknown","description":"Images"}
default_variant_idinteger

The ID of the default variant of the product

{"stackTrail":"components:schemas:ProductAttributes:properties:variant_ids","oasType":"schema","type":"unknown","description":"Variant IDs"}
{"stackTrail":"components:schemas:ProductAttributes:properties:price_ids","oasType":"schema","type":"unknown","description":"Price IDs"}
{"stackTrail":"components:schemas:ProductAttributes:properties:tag_ids","oasType":"schema","type":"unknown","description":"Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s)"}
redirect_funnel_idstring nullable

Redirect funnel

cancellation_funnel_urlstring nullable

Cancellation Funnel Url

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 22,
    "public_id": "RTWMAd",
    "workspace_id": 42000,
    "name": "Sample Product",
    "current_path": null,
    "archived": false,
    "visible_in_store": true,
    "visible_in_customer_center": true,
    "image_id": null,
    "seo_title": "Buy Sample Product Online",
    "seo_description": "This is a sample product.",
    "seo_image_id": null,
    "commissionable": true,
    "image_ids": [],
    "default_variant_id": 22,
    "variant_ids": [
      22
    ],
    "price_ids": [],
    "tag_ids": [],
    "redirect_funnel_id": null,
    "cancellation_funnel_url": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "variant_properties": [
      {
        "id": 22,
        "name": "Color"
      }
    ]
  }
]