KOkontainer
PIM: Channels: Items

Returns a single Channel Items

Returns a single Channel Items

get/pim/channels/{channel_id}/items/{item_id}

Request

Path parameters

channel_idstring required

ID of Channel

item_idstring required

ID of Channel Item

Query parameters

relationshipsstring

Requested relationships (e.g., root_item, parent_item, children). children is only returned for hierarchical categories.

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
    }
  }
}

Changes

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