Skip to main content
GET
/
api
/
v1
/
catalog-products
List catalog products
curl --request GET \
  --url http://localhost:3001/api/v1/catalog-products \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "title": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "price": "<string>",
      "compareAtPrice": "<string>",
      "currency": "<string>",
      "primaryImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "primaryImageUrl": "<string>",
      "imageIds": [
        "<string>"
      ],
      "productUrl": "<string>",
      "category": "<string>",
      "tags": [
        "<string>"
      ],
      "sku": "<string>",
      "vendor": "<string>",
      "featured": true,
      "lastSyncedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Query Parameters

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
limit
integer
default:20
Required range: 1 <= x <= 100
Maximum string length: 200
source
enum<string>
Available options:
shopify,
woocommerce,
manual
status
enum<string>
Available options:
active,
hidden,
archived
Available options:
true,
false
category
string
Maximum string length: 200
tags
string
Maximum string length: 500
missingImage
enum<string>
Available options:
true,
false
missingDescription
enum<string>
Available options:
true,
false
missingCategoryOrTags
enum<string>
Available options:
true,
false
discounted
enum<string>
Available options:
true,
false
staleSync
enum<string>
Available options:
true,
false
sort
enum<string>
default:createdAt
Available options:
title,
price,
createdAt,
updatedAt
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Default Response

success
boolean
required
data
object[]
required
pagination
object
required