Raw materials, A to Z
- Credentials
- OAuth access token
- Scopes
listings:read
What the shop holds but does not sell: stock on hand, unit, cost and reorder point. Quantities are in the unit family's base (grams, millilitres, millimetres, or each).
Access: OAuth scope listings:read; not write-gated.
Paged: { items, nextCursor }, limit (default 100, at most 200) and an opaque cursor.
merchantOAuth listings:readAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
cursor?stringThe nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.
limit?integerPage size: default 100, at most 200 (more is 200; a missing or unusable value is 100).
1 <= value <= 200100OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/materials' \ -H 'Authorization: Bearer <access_token>'{ "data": { "items": [], "nextCursor": null }}Set what a product is made from PUT
Replaces the whole recipe: the materials and the quantity of each per unit made, which `recordBuild` then takes off. Each line's name and unit are read from the material when it is saved. An unknown material is 422 `validation_error`; a product that is gone or is not physical is 404 `not_found` / 422. Plan: Scale (403 `plan_limit` on a plan without it): starting something new needs Scale, as `addSupplier` does. `getProductRecipe` stays open after a downgrade. Replacing with the same lines changes nothing, so a retry is safe. Access: OAuth scope `listings:write`; write-gated by the subscription.
Add a raw material POST
Scale. The material starts empty: stock arrives through a delivery or a count. 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.