API reference

Customers

Register and manage shoppers, their addresses, contact points and tags — the building blocks for a storefront or app. A customer can have multiple emails, phones and addresses, each with a default. Login itself is issued by the auth service (see Authentication).

Base URLhttps://zopping.com

Customers

The shopper record. Create with at least a name, phone/email and organizationId; you may nest an address to create one in the same call. Keep your own id in clientId.

Fields

Field	Type	Description
`id`	integerread-only
`organizationId`	stringrequired
`name`	stringrequired
`lastName`	string
`phone`	string	Primary phone.
`email`	string	Primary email.
`password`	string	Optional; set to allow login.
`clientId`	stringkey	Your external customer id.
`address`	object	Optional nested address to create.
`status`	stringread-only
`totalOrders`	integerread-only
`defaultAddress`	objectread-only

GET/api/customer-service/customer

List customers

Parameters

Parameter	Type	Description
`organizationId`required	string· query
`page`	integer· query
`limit`	integer· query	Default 20.
`phone`	string· query	Filter by phone.
`email`	string· query	Filter by email.
`clientId`	string· query	Filter by your id(s).

Request

curl "https://zopping.com/api/customer-service/customer?organizationId=<org-id>&phone=9876543210" \
  -H "Authorization: Bearer $ZOPPING_TOKEN"

Response

{
  "data": {
    "customer": [
      {
        "id": 7781,
        "name": "Asha",
        "phone": "9876543210",
        "status": "ENABLED",
        "totalOrders": 12
      }
    ],
    "count": 1,
    "offset": 0,
    "limit": 20
  }
}

POST/api/customer-service/customer

Create a customer

Request body

{
  "organizationId": "<org-id>",
  "name": "Asha",
  "phone": "9876543210",
  "email": "asha@example.com",
  "clientId": "CRM-7781",
  "address": {
    "address": "12 MG Road",
    "city": "Bengaluru",
    "pincode": "560001"
  }
}

GET/api/customer-service/customer/{id}

Get a customer

Parameters

Parameter	Type	Description
`id`required	integer· path

PUT/api/customer-service/customer/{id}

Update a customer

Guest

Create a lightweight guest customer for express checkout; it converts to a registered customer on first login.

POST/api/customer-service/guest

Create a guest

Request body

{
  "organizationId": "<org-id>",
  "name": "Guest",
  "phone": "9876543210",
  "email": "guest@example.com",
  "password": "••••••"
}

Addresses

Delivery addresses for a customer, with optional geo-coordinates used by fulfilment to resolve a delivery zone.

Fields

Field	Type	Description
`id`	integerread-only
`customerId`	integerrequired
`address`	stringrequired
`city`	stringrequired
`pincode`	string
`landmark`	string
`latitude`	number
`longitude`	number
`state`	string
`clientId`	stringkey

GET/api/customer-service/address

List addresses

Parameters

Parameter	Type	Description
`organizationId`required	string· query
`customerId`required	integer· query

POST/api/customer-service/address

Add an address

Request body

{
  "organizationId": "<org-id>",
  "customerId": 7781,
  "address": "12 MG Road",
  "city": "Bengaluru",
  "pincode": "560001",
  "latitude": 12.9758,
  "longitude": 77.6096
}

PUT/api/customer-service/address/{id}

Update an address

Parameters

Parameter	Type	Description
`id`required	integer· path

DELETE/api/customer-service/address/{id}

Delete an address

Parameters

Parameter	Type	Description
`id`required	integer· path

Emails & phones

A customer can hold multiple emails and phones. Add, update status, or remove them. The wire field for a phone number is phone.

POST/api/customer-service/email

Add an email

Request body

{
  "organizationId": "<org-id>",
  "customerId": 7781,
  "email": "asha2@example.com"
}

DELETE/api/customer-service/email/{id}

Remove an email

Parameters

Parameter	Type	Description
`id`required	integer· path

POST/api/customer-service/phone

Add a phone

Request body

{
  "organizationId": "<org-id>",
  "customerId": 7781,
  "phone": "9988776655"
}

DELETE/api/customer-service/phone/{id}

Remove a phone

Parameters

Parameter	Type	Description
`id`required	integer· path

Passwords

Let customers change their password, or kick off a reset by email/phone username.

POST/api/customer-service/change-password

Change password

Request body

{
  "customerId": 7781,
  "oldPassword": "••••",
  "newPassword": "••••••"
}

POST/api/customer-service/reset-password

Request a password reset

Request body

{
  "organizationId": "<org-id>",
  "username": "asha@example.com"
}