Saltar al contenido
Guías
EN
Referencia de API
establecatalog:read

Listar productos

GET/v1/catalog/products

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Parámetros de consulta

limit?integer

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

Cursor opaco de la respuesta anterior. Omítelo en la primera página.

search?string

Filtro de texto libre. Los campos consultados dependen del recurso.

sortBy?string

Campo de ordenamiento. Los valores admitidos dependen del recurso.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

  • "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
Formatodouble
maxPrice?number
Formatodouble
minOnHand?integer
Formatoint32
maxOnHand?integer
Formatoint32
minAvailable?integer
Formatoint32
tags?array<string>
excludeTags?array<string>
includeVariants?boolean
includeTotalCount?boolean
projection?string

Valor en

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

Cuerpo de la respuesta

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}