POS Customer

Aggregate and indexed Customer information.

Customers include information about emails, phones and addresses.

Customer
CustomerEmail
CustomerPhone
CustomerAddress

Methods

Retrieve Customers

Retrieve a specific location POS customers.

GET /pos/v2/{locationId}/customers

Response 200

Returns a collection of Customer objects

{
  "results": [
    {
      "posRef": "string",
      "firstName": "string",
      "lastName": "string",
      "customerPhones": [
        {
          "phone": "string"
        }
      ],
      "customerEmails": [
        {
          "email": "string"
        }
      ],
      "customerAddresses": [
        {
          "posRef": "string",
          "streetAddress1": "string",
          "streetAddress2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string"
        }
      ]
    }
  ],
  "meta": {}
}

Definitions

Customer
CustomerEmail
CustomerPhone
CustomerAddress

Customer

Information about an Customer, Customer Address, Phone, Email

Name	Type	Description
posRef*	string	POS Customer reference ID. Unique per location.
firstName*	string	First name
lastName	string	Last name
customerPhones	array	Customer Phones
customerEmails	array	Customer Emails
customerAddresses	array	Customer Addresses

CustomerEmail

Name	Type	Description
email*	string	Email (unique customerId + email)

CustomerPhone

Name	Type	Description
phone*	string	Phone (unique customerId + phone)

CustomerAddress

Name	Type	Description
posRef*	string	POS Customer Address reference ID. Combination of (locationId + posRef) is unique
streetAddress1	string	Address line 1
streetAddress2	string	Address line 2
city	string	City
state	string	State
postalCode	string	Postal Code

Customers