List products

Scope

• ecommerce:read Read e-commerce – the person behind the key must be all members.

Path parameters

store_idstringrequired

The store's ID, which you choose.

Query parameters

limitinteger

The maximum number of items in the response (1–250, default 100).at least 1 · at most 250 · default 100

cursorstring

next_cursor from the previous response, for the next page. Omit for the first page.

updated_sincestring

Only what has changed since then (ISO 8601).

Response

200 A page of products.

dataarray<object>required

data[].idstringrequired

data[].titlestringrequired

data[].urlstring | nullrequired

data[].image_urlstring | nullrequired

data[].vendorstring | nullrequired

data[].product_typestring | nullrequired

data[].variantsarray<object>required

data[].variants[].idstringrequired

data[].variants[].titlestringrequired

data[].variants[].skustring | nullrequired

data[].variants[].pricenumber | nullrequired

data[].variants[].inventory_quantityinteger | nullrequired

data[].variants[].urlstring | nullrequired

data[].variants[].image_urlstring | nullrequired

data[].created_atstring (time, ISO 8601)required

When the product was first sent in.

data[].updated_atstring (time, ISO 8601)required

When the product was last changed.

has_morebooleanrequired

There are more: fetch the next page with cursor=next_cursor.

next_cursorstring | nullrequired

Send as cursor for the next page. null on the last page.

Errors

401

unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive

402

payment_required

403

insufficient_scopeforbiddenworkspace_suspended

404

not_found

422

validation_failed

429

rate_limited

500

internal_error