Save one courier's own settings
- Credentials
- OAuth access token
- Scopes
settings:write- Role
- Owners and admins only. Staff get
403 forbidden. - Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Services, hand-over, drop-off point and markup of one courier, written one field at a time so nothing else of the delivery settings is touched. The answer is the config as it now stands. Sending the same values again changes nothing, so a retry is safe.
Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.
merchantOAuth settings: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: settings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
providerId*stringA payment provider id (e.g. yoco, peach, ikhokha) or courier id.
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.
1 <= propertiesservices?collection?string"driver""dropOff"dropOffPoint?|null clears it, or the old kiosk would quietly stay the origin of every quote.
markupBps?|null clears it, so the store-wide markup applies again.
0 <= value <= 100000OK
application/json- response
data*curl -X PATCH 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/delivery/couriers/<providerId>' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "providerId": "string", "services": { "door": true, "locker": true }, "collection": "driver", "dropOffPoint": { "id": "string", "provider": "string", "name": "string", "address": "string", "hours": "string", "lat": 0, "lng": 0 }, "markupBps": 0 }}One courier's own settings GET
Services, hand-over (driver collects or the merchant drops off), the drop-off point and the courier's own markup. `getDelivery` lists the couriers and whether each is connected; this is what `saveCourierConfig` changes. A courier that was never connected answers the defaults (`collection: driver`). Access: OAuth scope `store:read`; owner/admin only; not write-gated.
Roughly what dropping off saves against a driver collecting GET
Priced for the store's default parcel to where its customers actually are (its most recent delivery address), because a saving to nowhere in particular is a number nobody can trust. Asks the courier for two rates; if it cannot be reached the answer is `saving: null`, never an error. A read, so it is not write-gated. Access: OAuth scope `store:read`; not write-gated.