Skip to content
docs
Guides
ES
CatalogChannels
channel:read

List listing requirements

GET/v1/channels/{channelId}/listings/requirements

List listing requirements. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

channelId*string

Identifier of the sales channel.

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"
listingIds?array<ResourceId>
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://example.com/v1/channels/7204558912004325301/listings/requirements" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "columns": [    {      "externalId": "7204558912004325301",      "name": "Example resource",      "required": false,      "options": [        "example"      ]    }  ],  "rows": [    {      "listingId": "7204558912004325301",      "productId": "7204558912004325301",      "productName": "Example resource",      "sku": "SKU-001",      "readinessStatus": "unknown",      "categoryPath": "example",      "categoryMapped": false,      "missing": 1,      "values": {        "key": {          "value": "example",          "source": "example",          "variantValues": [            {              "variantId": "7204558912004325301",              "sku": "SKU-001",              "value": "example",              "source": "example",              "valueId": "7204558912004325301"            }          ]        }      }    }  ],  "total": 1,  "nextCursor": "example"}