List Products - Panora Documentation

GET

ecommerce

products

import { Panora } from "@panora/sdk";

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

async function run() {
  const result = await panora.ecommerce.products.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": [
    {
      "product_url": "https://product_url/tee",
      "product_type": "teeshirt",
      "product_status": "ACTIVE",
      "images_urls": [
        "https://myproduct/image"
      ],
      "description": "best tee ever",
      "vendor": "vendor_extern",
      "variants": [
        {
          "title": "teeshirt",
          "price": 20,
          "sku": "3",
          "options": null,
          "weight": 10,
          "inventory_quantity": 100
        }
      ],
      "tags": [
        "tag_1"
      ],
      "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

data.product_url

string | null

The URL of the product

Example:

"https://product_url/tee"

data.product_type

string | null

The type of the product

Example:

"teeshirt"

data.product_status

string | null

The status of the product. Either ACTIVE, DRAFT OR ARCHIVED.

Example:

"ACTIVE"

data.images_urls

string[] | null

The URLs of the product images

Example:

["https://myproduct/image"]

data.description

string | null

The description of the product

Example:

"best tee ever"

data.vendor

string | null

The vendor of the product

Example:

"vendor_extern"

data.variants

object[]

The variants of the product

Example:

[
  {
    "title": "teeshirt",
    "price": 20,
    "sku": "3",
    "options": null,
    "weight": 10,
    "inventory_quantity": 100
  }
]

data.tags

string[] | null

The tags associated with the product

Example:

["tag_1"]

data.field_mappings

object | null

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

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.id

string | null

The UUID of the product

Example:

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

data.remote_id

string | null

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

Example:

"id_1"

data.remote_data

object | null

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

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.created_at

string | null

The created date of the object

Example:

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

data.modified_at

string | null

The modified date of the object

Example:

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

Was this page helpful?

Suggest edits Raise issue

Overview Retrieve Products

import { Panora } from "@panora/sdk";

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

async function run() {
  const result = await panora.ecommerce.products.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": [
    {
      "product_url": "https://product_url/tee",
      "product_type": "teeshirt",
      "product_status": "ACTIVE",
      "images_urls": [
        "https://myproduct/image"
      ],
      "description": "best tee ever",
      "vendor": "vendor_extern",
      "variants": [
        {
          "title": "teeshirt",
          "price": 20,
          "sku": "3",
          "options": null,
          "weight": 10,
          "inventory_quantity": 100
        }
      ],
      "tags": [
        "tag_1"
      ],
      "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"
    }
  ]
}

Ecommerce Objects

Authorizations

Headers

Query Parameters

Response