Skip to content
docs
ES
CatalogChannels

Summarize what a channel still needs, by data

Summarizes, per data field, what is still missing to publish on the channel.

GET/v1/channels/{channelId}/requirements/summary
Requires an access token with the channel:read permission.

Path Parameters

channelId*string

Identifier of the sales channel.

Query Parameters

sellerId?string

Identifier of the seller.

onlyMissing?boolean
categoryIds?array<ResourceId>

Only items in these categories.

gender?array<string>

Gender the item is intended for.

minPrice?number

Lowest price to include, in the store currency.

Formatdouble
maxPrice?number

Highest price to include, in the store currency.

Formatdouble
minStock?integer

Minimum stock level.

Formatint32
maxStock?integer

Maximum stock level.

Formatint32
search?string

Free-text search.

listingIds?array<ResourceId>

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.ecomiq.pe/api/v1/channels/7204558912004329619/requirements/summary" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "listingCount": 24,  "readyCount": 24,  "checkedCount": 24,  "items": [    {      "externalId": "7204558912004323067",      "name": "Tienda online",      "target": "attribute",      "variant": false,      "missing": 1,      "missingListings": 1,      "suggested": 1,      "suggestedValue": "Tienda online",      "sources": [        {          "source": "Tienda online",          "count": 24        }      ]    }  ],  "missingCategoryListings": 1,  "missingProductCategoryListings": 1}