One courier's own settings
- Credentials
- OAuth access token
- Scopes
store:read- Role
- Owners and admins only. Staff get
403 forbidden.
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.
merchantOAuth store: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: store:read
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.
OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/delivery/couriers/<providerId>' \ -H 'Authorization: Bearer <access_token>'{ "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 }}"Collect from you": on or off, and what to tell shoppers PUT
Only these two fields are written, so the rest of the delivery settings are never touched (`saveDelivery` owns those). At least one way to get an order must stay on: turning collection off while delivery is off is 422 `validation_error` ("Turn on delivery or collection..."). The answer is the saved values. A `pickupNote` that is not sent keeps the note as it is; an empty string clears it. Saving the same values again changes nothing. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.
Save one courier's own settings PATCH
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.