ShopEazydevelopers
API referenceMerchant API BetaProducts

List or search the catalogue

Beta
Credentials, one of
  • Station token
  • OAuth access token
Scopes
listings:read
GET
/v1/merchant/stores/{storeId}/products

Access: OAuth scope listings:read; not write-gated.

Paged: { items, nextCursor }, limit (default 100, at most 200) and an opaque cursor.

Authorization

headerAuthorizationBearer <token>

It may call only the operations whose x-stations lists its kind, on its own store, and acts through the access of the owner or admin who paired it. Unpairing it, or that person leaving the business, ends it (401 station_revoked).

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

kind?string
Value in"physical""service""ticketing""tour"
status?string

Default all.

Value in"draft""active""archived""all"
search?string
lowStock?boolean

Only items at or under their low-stock level.

hasPhoto?boolean

true: only items with at least one photo (what a product shoot can start from). Default: every item.

cursor?string

The nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.

limit?integer

Page size: default 100, at most 200 (more is 200; a missing or unusable value is 100).

Range1 <= value <= 200
Default100

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "id": "Vbysrj7cZDLaTk20BVsd",        "kitId": "5gvu5rElbDNOBru2HYMi",        "title": "Botanical garden walk",        "slug": "botanical-garden-walk",        "kind": "tour",        "price": {          "amount": 35000,          "currency": "ZAR"        },        "imageUrl": null,        "active": true,        "stock": null      },      {        "id": "Lt4HUbN7ScpvnxPHUARR",        "kitId": "cbzXdyoC08TecFtCKeTn",        "title": "Glazed ceramic pot",        "slug": "glazed-ceramic-pot",        "kind": "physical",        "price": {          "amount": 18900,          "currency": "ZAR"        },        "imageUrl": "https://images.example.com/plants/ceramic-pot.jpg",        "active": true,        "stock": 20      },      {        "id": "65myAK8IFZKwZBG84Gmw",        "kitId": "cbzXdyoC08TecFtCKeTn",        "title": "Monstera deliciosa, 20 cm pot",        "slug": "monstera-deliciosa-20-cm-pot",        "kind": "physical",        "price": {          "amount": 34900,          "currency": "ZAR"        },        "imageUrl": "https://images.example.com/plants/monstera.jpg",        "active": true,        "stock": 24      }    ],    "nextCursor": null  }}