Customer

Fields

`id`: `number`

Attributes: Unique
A unique identifier assigned to each customer.

`name`: `string`

The full name of the customer.

`phone_number`: `string`

Attributes: Unique The customer’s primary phone number, including the country code.

`secondary_phone_number`: `string`

An alternative phone number for the customer, also including the country code.

`email`: `string`

The customer’s email address.

`locations`: `array<object<CustomerLocation>>`

Attributes: Read-only, conditional

The customer’s locations. This field is only included when the request is made with the ?include_locations=true query parameter (on the customer list and retrieve endpoints); it is omitted otherwise.

Example

Default response:

{
  "id": 12345,
  "name": "Jane Doe",
  "phone_number": "+15551234567",
  "secondary_phone_number": "+15557654321",
  "email": "jane.doe@example.com"
}

With ?include_locations=true:

{
  "id": 12345,
  "name": "Jane Doe",
  "phone_number": "+15551234567",
  "secondary_phone_number": null,
  "email": "jane.doe@example.com",
  "locations": [
    {
      "id": 9691,
      "area": {
        "id": 146,
        "name_ar": "عيناب",
        "name_en": "Ainab",
        "district": "Aley",
        "lat": "33.766414000000000",
        "long": "35.546311000000000",
        "maps_link": "http://maps.google.com/maps?q=33.766414,35.546311",
        "code": "LBN0146",
        "is_external": false,
        "area_group": null
      },
      "directions": "Near the pharmacy"
    }
  ]
}

The list endpoint (GET /customers/) returns results wrapped in a pagination envelope: { "count", "next", "previous", "results": [ ... ] }.

Introduction

Models

Endpoints

Fields

`id`: `number`

`name`: `string`

`phone_number`: `string`

`secondary_phone_number`: `string`

`email`: `string`

`locations`: `array<object<CustomerLocation>>`

Example

​Fields

​id: number

​name: string

​phone_number: string

​secondary_phone_number: string

​email: string

​locations: array<object<CustomerLocation>>

​Example

Fields

`id`: `number`

`name`: `string`

`phone_number`: `string`

`secondary_phone_number`: `string`

`email`: `string`

`locations`: `array<object<CustomerLocation>>`

Example