GET
List products.

Authorizations

X-Agent-Key
string
header
required

Service-account key, format sq_agt_*. Carries least-privilege scopes.

Headers

X-Store-ID
string

Target store; required when the key is bound to multiple stores.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 250
page_info
string

Opaque cursor from meta.next_page_info / meta.previous_page_info or the Link header.

page
integer

Legacy offset pagination. Adds meta.page and meta.total_pages. Prefer page_info.

Required range: x >= 1
status
string

Comma-separated: active, draft, archived.

Example:

"active,draft"

vendor
string
product_type
string
tag
string

Comma-separated. A product matches if it has ANY of the tags (case-insensitive).

Example:

"sale,summer"

collection_id
string

Only products in this collection (see GET /collections).

query
string

Case-insensitive substring match on title, handle or any variant SKU. Aliases: q, search.

ids
string

Comma-separated product ids, at most 250.

updated_at_min
string<date-time>
updated_at_max
string<date-time>
created_at_min
string<date-time>
created_at_max
string<date-time>
order
string
default:updated_at desc

<updated_at|created_at|title|id> <asc|desc>.

Example:

"id asc"

fields
string

Comma-separated top-level fields to return. Including variants embeds variants.

Example:

"id,title,status,variants"

include
enum<string>

variants embeds each product's variants.

Available options:
variants

Response

OK

success
boolean
required
message
string
data
object
meta
object