ShopEazydevelopers
API referenceMerchant API BetaDelivery

Save delivery settings

Beta
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-Key header. A retry with the same key does the work once.
PUT
/v1/merchant/stores/{storeId}/delivery

Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.

Authorization

merchantOAuth settings: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: settings: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

Money here is minor-unit integers, not Money objects.

allowDelivery*boolean
allowPickup*boolean
mode?string
Default"flat"
Value in"flat""live"
flatFeeMinor?integer
freeOverMinor?integer
markupBps?integer
Default0
maxDeliveryPriceMinor?integer
maxDeliveryOptions?integer
defaultParcel?
boxes?array<>

The store's boxes. Absent leaves the saved list alone.

collectionAddress?
pickupNote?string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/delivery' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "allowDelivery": false,  "allowPickup": false}'
Example Response
{  "data": {    "settings": {      "allowDelivery": true,      "allowPickup": true,      "mode": "flat",      "flatFee": {        "amount": 0,        "currency": "ZAR"      },      "freeOver": {        "amount": 0,        "currency": "ZAR"      },      "markupBps": 0,      "pickupNote": "string",      "defaultParcel": {        "lengthCm": 0,        "widthCm": 0,        "heightCm": 0,        "weightKg": 0      },      "collectionAddress": {        "addressLine": "string",        "localArea": "string",        "city": "string",        "province": "string",        "postalCode": "string",        "country": "string",        "lat": 0,        "lng": 0      },      "maxDeliveryPriceMinor": 0,      "maxDeliveryOptions": 0,      "boxes": [        {          "id": "string",          "name": "string",          "lengthCm": 0,          "widthCm": 0,          "heightCm": 0,          "emptyWeightKg": 0        }      ]    },    "couriers": [      {        "id": "string",        "name": "string",        "blurb": "string",        "services": [          "string"        ],        "live": true,        "accountLabel": "string",        "accountHint": "string",        "hasSandbox": true,        "keysUrl": "string",        "signupUrl": "string",        "steps": [          "string"        ],        "brandColor": "string",        "status": "connected",        "enabled": true,        "env": "sandbox"      }    ]  }}

Delivery settings and couriers GET

Access: OAuth scope `store:read`; owner/admin only; not write-gated.

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