Edit a material
- Credentials
- OAuth access token
- Scopes
listings:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
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.
merchantOAuth listings:writeAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
materialId*stringA material id, from GET /materials.
Idempotency-Key*stringRequired 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.
^[A-Za-z0-9_-]{8,128}$application/json- body
Only what is sent changes. The unit cannot be changed.
name?string1 <= length <= 120unitCost?What ONE BASE unit costs (a gram, not a kilogram), in minor units.
supplierId?stringreorderPoint?numberIn base units.
0 <= valuereorderQty?numberIn base units.
0 <= valuesku?stringlength <= 64note?stringlength <= 500OK
application/json- response
data*curl -X PATCH 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/materials/<materialId>' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "string", "name": "string", "sku": "string", "unit": "each", "onHand": 0, "unitCost": null, "supplierId": "string", "reorderPoint": 0, "lowStockThreshold": 0, "reorderQty": 0, "note": "string" }}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.
Set or change a material's stock POST
Send `set` (a counted total) or `add` (a change; negative removes), never both. The move is written to the stock ledger with its reason; stock cannot go below zero. Access: OAuth scope `listings:write`; write-gated by the subscription.