ShopEazydevelopers
API referenceMerchant API BetaProducts

One item, as the editor needs it

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

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

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.

productId*string

An item id (any kind, not only physical products).

Response Body

OK

application/json
  1. response
data*

details is shaped by kind.

Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products/<productId>' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "id": "65myAK8IFZKwZBG84Gmw",    "kitId": "cbzXdyoC08TecFtCKeTn",    "kind": "physical",    "title": "Monstera deliciosa, 20 cm pot",    "slug": "monstera-deliciosa-20-cm-pot",    "description": "A healthy, glossy monstera in a 20 cm nursery pot. Bright, indirect light and a drink every week or so.",    "price": {      "amount": 34900,      "currency": "ZAR"    },    "compareAtPrice": {      "amount": 39900,      "currency": "ZAR"    },    "status": "active",    "tags": [      "indoor",      "low light"    ],    "categoryIds": [      "s9EOwLS0KUlAWoAEdqRT"    ],    "media": [      {        "id": "m0-mvnovvgd",        "url": "https://images.example.com/plants/monstera.jpg",        "alt": "A monstera in a terracotta pot"      }    ],    "details": {      "sku": "MON-20",      "barcode": "6001000000017",      "trackInventory": true,      "stock": 24,      "lowStockThreshold": 5,      "requiresShipping": true,      "options": [],      "variants": []    },    "customisations": [],    "managedInConsole": [],    "updatedAt": 1792924382485  }}

Set the shipping weight and box on several products POST

The bulk "Set shipping" of the products list: one weight and/or one box for up to 200 physical products. A box that is no longer in the store's list is 422 `validation_error` and nothing is written. The answer is one `{ id, ok, error? }` per product (`BulkResult`); an id that is not a physical product, is gone, or is in a kit the merchant has archived (`kit_archived`), is left alone. A retry is safe: writing the same weight and box twice changes nothing, and the same `Idempotency-Key` replays the first answer. Access: OAuth scope `listings:write`; write-gated by the subscription.

Edit an item (allow-listed fields only) PATCH

Access: OAuth scope `listings:write`; write-gated by the subscription.