Skip to content
Guides
ES
API reference
stablecatalog:read

List products

GET/v1/catalog/products

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
productIds?array<any>
status?array<>
excludeStatus?array<>
includeArchived?boolean
categoryIds?array<any>
excludeCategoryIds?array<any>
brandIds?array<any>
excludeBrandIds?array<any>
storeIds?array<any>
sellerIds?array<any>
excludeSellerIds?array<any>
skuIds?array<any>
skus?array<string>
types?array<>
excludeTypes?array<>
isFeatured?boolean
ean?string
minPrice?number
Formatdouble
maxPrice?number
Formatdouble
minOnHand?integer
Formatint32
maxOnHand?integer
Formatint32
minAvailable?integer
Formatint32
tags?array<string>
excludeTags?array<string>
includeVariants?boolean
includeTotalCount?boolean
projection?string

Value in

  • "summary"
  • "full"
  • "spreadsheet"
channelId?null|string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/products"
{  "data": [    {      "id": "string",      "sku": null,      "storeId": "string",      "sellerId": null,      "type": "product",      "name": "string",      "description": "string",      "slug": "string",      "currency": null,      "taxRate": null,      "taxIncluded": null,      "brand": "string",      "price": 0.1,      "compareAtPrice": null,      "costPrice": null,      "totalOnHand": 0,      "available": 0,      "committed": 0,      "totalVariants": 0,      "activeVariants": 0,      "vendor": null,      "tags": [        "string"      ],      "specifications": [        {          "name": "string",          "key": "string",          "value": "string"        }      ],      "images": [        {          "id": "string",          "url": "string",          "name": null,          "width": null,          "height": null,          "isPrimary": true,          "order": 0        }      ],      "category": "string",      "packageId": null,      "shippingProfileId": null,      "status": "draft",      "metaTitle": null,      "metaDescription": null,      "metaKeywords": null,      "featuredUntil": null,      "isFeatured": true,      "minOrderQuantity": 0,      "maxOrderQuantity": null,      "isDigital": true,      "hasVariants": true,      "hasActivity": true,      "hasPriceLists": true,      "hasReviews": true,      "hasSizeGuide": true,      "variants": [        {          "id": "string",          "sku": "string",          "name": "string",          "barcode": null,          "status": "outOfStock",          "price": 0.1,          "compareAtPrice": null,          "costPrice": null,          "trackInventory": true,          "allowBackorders": true,          "lowStockThreshold": 0,          "onHand": 0,          "committed": 0,          "available": 0,          "images": [            {              "imageId": "string",              "order": 0,              "isPrimary": true            }          ],          "options": [            {              "name": "string",              "key": "string",              "value": "string"            }          ],          "inventories": [            {              "id": "string",              "locationId": "string",              "onHand": 0,              "committed": 0,              "available": 0,              "incoming": 0,              "unavailable": 0,              "version": 0,              "createdOn": "2019-08-24T14:15:22Z",              "updatedOn": null            }          ]        }      ],      "views": 0,      "salesCount": 0,      "reviewsCount": 0,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null,      "lastActivityOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}