ShopEazydevelopers
API referenceMerchant API BetaStock

Add a raw material

Beta
Credentials
  • OAuth access token
Scopes
listings:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Plan
Scale. A plan without it gets 403 plan_limit.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/materials

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.

Authorization

merchantOAuth listings:write
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:write

Path Parameters

storeId*string

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

Header Parameters

Idempotency-Key*string

Required on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
name*string
Length1 <= length <= 120
unit*StockUnit
Value in"each""g""kg""ml""l""mm""cm""m"
unitCost?

What ONE BASE unit costs (a gram, not a kilogram), in minor units.

supplierId?string
reorderPoint?number

In base units.

Range0 <= value
reorderQty?number

In base units.

Range0 <= value
sku?string
Lengthlength <= 64
note?string
Lengthlength <= 500

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/materials' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "unit": "each"}'
Example Response
{  "data": {    "id": "string",    "name": "string",    "sku": "string",    "unit": "each",    "onHand": 0,    "unitCost": null,    "supplierId": "string",    "reorderPoint": 0,    "lowStockThreshold": 0,    "reorderQty": 0,    "note": "string"  }}

Raw materials, A to Z GET

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`.

Edit a material PATCH

Only what is sent changes. The unit is set once and never changes: every number stored against it would be reread. Not plan-gated beyond the subscription: what exists stays editable. Access: OAuth scope `listings:write`; write-gated by the subscription.