GET
/
ecommerce
/
customers
/
{id}
import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.ecommerce.customers.retrieve({
    xConnectionToken: "<value>",
    id: "<id>",
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "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"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-connection-token
string
required

The connection token

Path Parameters

​
id
string
required

id of the customer you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
email
string | null

The email of the customer

Example:

"joedoe@gmail.com"

​
first_name
string | null

The first name of the customer

Example:

"Joe"

​
last_name
string | null

The last name of the customer

Example:

"Doe"

​
phone_number
string | null

The phone number of the customer

Example:

"+336666666"

​
addresses
object[] | null

The addresses of the customer

Example:
[
  {
    "address_type": "PERSONAL",
    "street_1": "5th Avenue",
    "state": "New York",
    "city": "New York",
    "country": "United States of America"
  }
]
​
field_mappings
object | null

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

Example:
{
  "fav_dish": "broccoli",
  "fav_color": "red"
}
​
id
string | null

The UUID of the customer

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
remote_id
string | null

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

Example:

"id_1"

​
remote_data
object | null

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

Example:
{
  "fav_dish": "broccoli",
  "fav_color": "red"
}
​
created_at
string | null

The created date of the object

Example:

"2024-10-01T12:00:00Z"

​
modified_at
string | null

The modified date of the object

Example:

"2024-10-01T12:00:00Z"