v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

ecommerce/customers

Retrieve Customers

Retrieve customers from any connected Ats software

get/ecommerce/customers/{id}

Path parameters

idstring required

id of the customer you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ats software.

Headers

x-connection-tokenstring required

The connection token

Response

emailstring nullable

The email of the customer

first_namestring nullable

The first name of the customer

last_namestring nullable

The last name of the customer

phone_numberstring nullable

The phone number of the customer

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the customer

remote_idstring nullable

The remote ID of the customer in the context of the 3rd Party

remote_dataobject nullable

The remote data of the customer in the context of the 3rd Party

created_atstring nullable

The created date of the object

modified_atstring nullable

The modified date of the object

Example response

{
  "email": "joedoe@gmail.com",
  "first_name": "Joe",
  "last_name": "Doe",
  "phone_number": "+336666666",
  "addresses": [
    {
      "address_type": "PERSONAL",
      "street_1": "5th Avenue",
      "state": "New York",
      "city": "New York",
      "country": "United States of America"
    }
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}