Skip to content

List Products

Endpoint

http
GET /unified/ecommerce/products
Integrations supported
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
updated_at
string
The date and time when product was updated
Supported in
  • Bigcommerce
  • Wix
  • WooCommerce
name
string
The name of a product
Supported in
  • Bigcommerce
  • Shopify
sort_by
object
The field to sort the resource by. Should be in format `{ fieldName: direction }`. The direction can be `asc` or `desc`.
Supported in
  • Bigcommerce
  • Wix
  • WooCommerce
created_at
string
The date and time when product was created
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix
  • WooCommerce
updated_at
string
The date and time when product was updated
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix
id
string
The unique identifier for a product
All possible enum values:
  • asc
  • desc
Supported in
  • WooCommerce
created_at
string
The date and time when product was created
Supported in
  • Shopify
  • Wix
  • WooCommerce

Response Body

result
object[]
List of Products
id
string
REQUIRED · The unique identifier for a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
name
string
The name of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
description
string
The description of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
status
string
The status of a product. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • active
  • inactive
Supported in
  • WooCommerce
price
string
The price of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
sku
string
The sku of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
inventory_quantity
string
The quantity of a product in stock
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
images
object[]
The images of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
id
string
The unique identifier of an image of a product
url
string
The url of an image of product
weight
string
The weight of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
weight_unit
string
The weight unit of a product
options
object[]
The options of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
id
string
The unique identifier of an option of a product
name
string
The name of option for product
values
array
The values of option for product
variants
object[]
The options of a product
Supported in
  • Bigcommerce
  • Shopify
  • Wix
id
string
The unique identifier of a variant of a product
name
string
The name of variant for product
price
string
The price of variant for product
sku
string
The sku of variant for product
inventory_quantity
string
The quantity of variant for product in stock
weight
string
The weight of variant
options
object[]
The options for variant
id
string
The unique identifier for option of variant
name
string
The name for option of variant
value
string
The value for option of variant
images
object[]
The images for variant
id
string
The unique identifier for image of variant
url
string
The url of image of variant
tags
string[]
The tags of a product
Supported in
  • Shopify
  • WooCommerce
categories
object[]
The categories of a product
Supported in
  • WooCommerce
id
string
The unique identifier of a category of product
name
string
The name of category for product
created_at
string
The date and time when product was created
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
updated_at
string
The date and time when product was updated
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.