Skip to content
docs
ES
CatalogChannels

List listing requirements

Returns a cursor-paginated table of requirements per listing.

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

Path Parameters

channelId*string

Identifier of the sales channel.

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Cursor from the previous response. Omit it on the first page.

search?string

Free-text search.

sortBy?string

Field to sort by.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
listingIds?array<ResourceId>
productIds?array<ResourceId>

Only these products.

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

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/listings/requirements" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "columns": [    {      "externalId": "7204558912004323067",      "name": "Tienda online",      "required": true,      "optionValues": [        {          "id": "7204558912004325220",          "name": "Material"        }      ],      "allowCustomValue": false,      "target": "attribute",      "variant": false,      "valueType": "Tienda online"    }  ],  "rows": [    {      "listingId": "7204558912004321492",      "productId": "7204558912004322039",      "productName": "Tienda online",      "sku": "POL-001-AZ-M",      "readinessStatus": "ready",      "categoryPath": "Tienda online",      "categoryMapped": false,      "missing": 1,      "values": {        "key": {          "value": "Tienda online",          "source": "Tienda online",          "state": "ok",          "variantValues": [            {              "variantId": "7204558912004323197",              "sku": "POL-001-AZ-M",              "value": "Polo de algodón Azul / M",              "source": "Tienda online",              "valueId": "7204558912004324721",              "state": "ok"            }          ]        }      }    }  ],  "total": 178,  "nextCursor": "eyJpZCI6IjcyMDQ1NTg5MTIwMDQzMjUzMDEifQ",  "choices": {    "key": {      "key": {        "optionValues": [          {            "id": "7204558912004325220",            "name": "Material"          }        ],        "allowCustomValue": false,        "valueType": "Tienda online",        "allowedUnits": [          {            "id": "7204558912004325220",            "name": "Material"          }        ],        "defaultUnit": "Tienda online"      }    }  }}