ShopEazydevelopers
API referenceMerchant API BetaStock

What sells, what sits, what runs out

Beta
Credentials
  • OAuth access token
Scopes
listings:read
GET
/v1/merchant/stores/{storeId}/stock/insights

Over the last 30 days: the fast and slow sellers, what is not moving, and what runs out soon at the current pace.

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

Authorization

merchantOAuth listings:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: listings:read

Path Parameters

storeId*string

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

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/stock/insights' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "fast": [],    "slow": [],    "notMoving": [      {        "name": "Glazed ceramic pot / Small",        "onHand": 12      },      {        "name": "Glazed ceramic pot / Large",        "onHand": 8      },      {        "name": "Monstera deliciosa, 20 cm pot",        "onHand": 30      }    ],    "runningOut": []  }}

Record a batch made POST

Adds the finished product to stock and takes its recipe's materials off, in one transaction. Scale. Plan: Scale (403 `plan_limit` on a plan without it). Reading and changing what already exists stays open after a downgrade. Access: OAuth scope `listings:write`; write-gated by the subscription.

Credits and which AI tools can run GET

Access: OAuth scope `store:read`; not write-gated.