ShopEazydevelopers
API referenceMerchant API BetaDelivery

What is going in the box, and what it will be billed at

Beta
Credentials
  • OAuth access token
Scopes
orders:read
GET
/v1/merchant/stores/{storeId}/orders/{orderId}/delivery/parcel-preview

Shown before booking a courier. Only lines that need shipping count; lineIds narrows it to the lines of one parcel of a split order. Nothing is quoted or booked: quoteDelivery prices it and bookCollection books it. A read, so it is not write-gated.

Access: OAuth scope orders:read; not write-gated.

Authorization

merchantOAuth orders:read
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: orders:read

Path Parameters

storeId*string

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

orderId*string

Query Parameters

lineIds?string

Comma-separated line ids of the order. Default: every line that needs shipping.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders/<orderId>/delivery/parcel-preview' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "parcels": [      {        "description": "string",        "lengthCm": 0,        "widthCm": 0,        "heightCm": 0,        "weightKg": 0,        "chargeableKg": 0,        "volumetricKg": 0      }    ],    "totalChargeableKg": 0,    "usingDefaultFor": [      "string"    ],    "unmeasurable": true  }}