GET
Page through the store's 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

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Case-insensitive substring on title or handle.

status
enum<integer>
Available options:
0,
1,
2
sort_by
enum<string>
default:updated_at
Available options:
updated_at,
created_at,
title,
price
sort_direction
enum<string>
default:desc
Available options:
asc,
desc

Response

OK

success
boolean
required
message
string
data
object[]
meta
object