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

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

async function run() {
  const result = await panora.ecommerce.customers.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();
{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "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

Query Parameters

​
remote_data
boolean

Set to true to include data from the original software.

​
limit
number
default:50

Set to get the number of records.

​
cursor
string

Set to get the number of records after this cursor.

Response

200 - application/json
​
prev_cursor
string | null
required
​
next_cursor
string | null
required
​
data
object[]
required