Customers

Customers are the merchant’s own records — loyalty members, account customers, delivery addresses. Reservations sit on top of them: every booking belongs to a customer.

Endpoints

Method	Path	Scope
`GET`	`/v1/customers`	`customers.read`
`GET`	`/v1/customers/:id`	`customers.read`
`POST`	`/v1/customers`	`customers.write`
`PATCH`	`/v1/customers/:id`	`customers.write`

Create a customer

curl -s "$API_BASE_URL/customers" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Priya Nair",
    "mobile": "+919845012345",
    "email": "priya@example.com",
    "loyaltyNo": "LP-004182",
    "address": "42 Church Street",
    "ZIP": "560001",
    "StoreId": 1
  }'

Field	Type	Required	Notes
`name`	string	yes	Up to 150 characters
`mobile`	string	no	Up to 40 characters. The de-facto identity key — see below
`email`	string	no	Validated as an email address
`loyaltyNo`	string	no	Loyalty card or membership number, up to 20 characters
`loyaltyPoint`	number	no	Opening points balance
`address`, `landmark`	string	no	Delivery address lines
`ZIP`	string	no	Postal code
`countryId`, `stateId`, `state`	number / string	no	Location, for tax and reporting
`latitude`, `longitude`	number	no	Used for delivery routing
`trn`	string	no	Tax registration number for B2B invoices
`TaxExempt`	number	no	`1` suppresses tax on this customer’s sales
`creditCust`	number	no	`1` allows sales on account
`creditLimit`	number	no	Maximum outstanding balance
`opening`	number	no	Opening balance carried in from another system
`birthDate`, `anniversary`	string	no	`YYYY-MM-DD`, used for campaigns
`StoreId`	number	no	Home store. `0` means the record is shared across stores
`status`	number	no	`1` active (default), `0` inactive

{
  "data": {
    "id": 5521,
    "name": "Priya Nair",
    "mobile": "+919845012345",
    "loyaltyNo": "LP-004182",
    "status": 1
  }
}

curl -s "$API_BASE_URL/customers?mobile=%2B919845012345" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

search matches name, mobile and email; mobile and email filter exactly.

Reservations

Table bookings — creating them, the status lifecycle, the store’s booking rules and their error codes — have their own page: Reservations.