KOkontainer
PIM: Channels: Items

Returns a list of Channel Items

Search and Retrieve Channel Items

Endpoint for retrieving a collection of channel items. Column filters can be applied to limit the collection returned to those items which match the given criteria.

get/pim/channels/{channel_id}/items

Request

Path parameters

channel_idstring required

ID of Channel

Query parameters

pageobject

Page Options

  • Define items per page using "size" parameter (default 500, max 2000).
  • Define the search_after (pagination cursor) using the "after" parameter, by adding and array of values.
  • Read the cursor for the next page from meta.links.next; follow it until it is null (the last page).

Example

{
  "page": {
    "size": 50,
    "after": [
      "55753"
    ]
  }
}

{
  "size": 50,
  "after": [
    "55753"
  ]
}
sortstring

Sort Options

Define sort columns by including the column name(s), separated by a comma (","). The sort order for each sort column is ascending by default. To sort in descending order, prefix the column name with a minus ("-").

relationshipsstring

Requested relationships (e.g., root_item, parent_item)

filterobject

Filtering

Filters can be applied to limit the results that are returned. Filters are applied using the "filter" query parameter. You can find the filter columns that are supported in the Elements section.

Example:

To apply a product filter where the "active" column equals "true", and the "name" element is like "shoes", you would write the filter query as below:

{
  "filter": {
    "active": {
      "eq": "true"
    },
    "name": {
      "like": "shoes"
    }
  }
}

{
  "active": {
    "eq": "true"
  },
  "name": {
    "like": "shoes"
  }
}

Response

success

Example response

{
  "data": [
    {
      "type": "category_item",
      "id": "1234",
      "attributes": {
        "string_field_example": {
          "value": "String value"
        },
        "boolean_field_example": {
          "value": true
        },
        "numeric_field_example": {
          "value": 10.1
        },
        "resource_field_example": {
          "value": "String representation of resource",
          "meta": {
            "resource_item_id": "123",
            "resource_category_id": "12"
          }
        }
      },
      "links": {
        "self": "https://example.kontainer.com/jsonapi/v2/pim/channels/23/items/1234"
      },
      "meta": {
        "category_id": "12",
        "family": "13",
        "path": [
          "1234",
          "5678"
        ],
        "variation": "31",
        "variation_name": "Color",
        "level": 2,
        "is_end_level": true
      }
    }
  ],
  "meta": {
    "total": 1234,
    "filters": [
      {
        "field": "material",
        "operator_id": 3,
        "operator_codename": "OPERATOR_EQUAL",
        "value": "Polyester"
      }
    ],
    "page": {
      "size": "50",
      "after": [
        "55753"
      ]
    },
    "links": {
      "current": "https://example.kontainer.com/jsonapi/v2/pim/channels/12/items",
      "first": "https://example.kontainer.com/jsonapi/v2/pim/channels/12/items",
      "next": "https://example.kontainer.com/jsonapi/v2/pim/channels/12/items?page[after][]=55753"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.