ShopEazydevelopers
API referenceMerchant API BetaDelivery

Book a courier collection

Beta
Credentials
  • OAuth access token
Scopes
delivery:write
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.
POST
/v1/merchant/stores/{storeId}/orders/{orderId}/delivery/book

Re-quotes and books the live quote matching provider + serviceCode. When that is not what the shopper paid for, answers 409 confirm_different whose message is the question to put to the merchant (e.g. "The customer paid R80 for ... Book ... for R95 instead?"); resend with confirmDifferent: true.

An OAuth connection is held to what the merchant allowed it in Settings, AI apps: a courier costing more than the grant's courierMaxCents on the merchant's courier account answers 403 over_courier_limit, and a connection may book 50 a day (UTC) before 429 rate_limited. First-party calls have neither.

Access: OAuth scope delivery:write; write-gated by the subscription.

Authorization

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

Path Parameters

storeId*string

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

orderId*string

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

Only serviceCode (+ provider, since a code alone is not unique) is trusted; the server re-quotes and books the live quote's price, estimate and drop-off.

serviceCode*string
provider?string
lockerId?string
lockerProvider?string
lockerCourier?string
lockerName?string
lockerAddress?string
lockerHours?string
confirmDifferent?boolean

Resend with true after a 409 confirm_different the merchant accepted.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders/<orderId>/delivery/book' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "serviceCode": "string"}'
Example Response
{  "data": {    "id": "string",    "number": "string",    "channel": "online",    "customerName": "string",    "soldByName": "string",    "total": {      "amount": 0,      "currency": "ZAR"    },    "status": "open",    "paymentStatus": "unpaid",    "fulfillmentStatus": "unfulfilled",    "placedAt": 0,    "lineCount": 0,    "kinds": [      "physical"    ],    "currency": "string",    "customerEmail": "string",    "customerPhone": "string",    "lines": [      {        "id": "string",        "kind": "physical",        "requiresShipping": true,        "title": "string",        "variantTitle": "string",        "customisations": [          {            "groupName": "string",            "choiceName": "string",            "price": {              "amount": 0,              "currency": "ZAR"            }          }        ],        "quantity": 0,        "unitPrice": {          "amount": 0,          "currency": "ZAR"        },        "lineTotal": {          "amount": 0,          "currency": "ZAR"        },        "fulfilled": true,        "imageUrl": "string"      }    ],    "subtotal": {      "amount": 0,      "currency": "ZAR"    },    "shipping": {      "amount": 0,      "currency": "ZAR"    },    "discount": {      "amount": 0,      "currency": "ZAR"    },    "paid": {      "amount": 0,      "currency": "ZAR"    },    "refunded": {      "amount": 0,      "currency": "ZAR"    },    "kept": {      "amount": 0,      "currency": "ZAR"    },    "refundable": {      "amount": 0,      "currency": "ZAR"    },    "pendingRefunds": [      {        "amount": {          "amount": 0,          "currency": "ZAR"        },        "providerName": "string"      }    ],    "eft": {      "reference": "string",      "overdue": true,      "overdueAt": 0,      "bankName": "string",      "account": "string"    },    "customerNote": "string",    "giftNote": "string",    "notes": [      {        "at": 0,        "message": "string",        "author": "string"      }    ],    "timeline": [      {        "at": 0,        "type": "created",        "message": "string",        "author": "string"      }    ],    "fulfilment": {      "method": "delivery",      "serviceName": "string",      "lockerName": "string",      "address": "string",      "provider": "string",      "serviceCode": "string",      "locker": {        "id": "string",        "name": "string",        "provider": "string",        "courier": "string",        "address": "string",        "hours": "string"      },      "fellBack": true    },    "shippingAddress": "string",    "shippingAddressParts": {      "addressLine": "string",      "localArea": "string",      "city": "string",      "province": "string",      "postalCode": "string"    },    "shippingAddressMissing": [      "string"    ],    "needsCourier": true,    "shipment": {      "provider": "string",      "trackingReference": "string",      "state": "pending",      "estimate": "string"    }  }}

Live courier prices for this order POST

A POST because it calls the couriers, but changes nothing, so it is not write-gated: a store whose plan has lapsed can still ask for a price. Access: OAuth scope `orders:read`; not write-gated.

Call off a booked collection DELETE

Access: OAuth scope `delivery:write`; write-gated by the subscription.