ShopEazydevelopers
API referenceMerchant API BetaCustomers

One customer

Beta
Credentials, one of
  • Station token
  • OAuth access token
Scopes
customers:read
GET
/v1/merchant/stores/{storeId}/customers/{customerId}

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

Authorization

headerAuthorizationBearer <token>

It may call only the operations whose x-stations lists its kind, on its own store, and acts through the access of the owner or admin who paired it. Unpairing it, or that person leaving the business, ends it (401 station_revoked).

Path Parameters

storeId*string

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

customerId*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customers/<customerId>' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "id": "dX3fN9Vqb9YKrX8GsA1H",    "name": "Thandi Mokoena",    "email": "thandi.mokoena@example.com",    "phone": "+27 82 000 0000",    "orderCount": 0,    "totalSpent": {      "amount": 0,      "currency": "ZAR"    },    "lastOrderAt": null,    "address": {      "addressLine": "5 Example Avenue",      "localArea": "Parkhurst",      "city": "Johannesburg",      "province": "Gauteng",      "postalCode": "2193",      "country": "ZA",      "line1": "5 Example Avenue",      "suburb": "Parkhurst"    },    "notes": "Likes low-light plants. Prefers WhatsApp.",    "tags": [      "plant club"    ],    "marketingOptIn": false,    "status": "active",    "hasAccount": false,    "createdAt": 1792924390822  }}