Lookup an item collection

Last update: August 29, 2024

CREATED FOR:

  • Experienced
  • Developer

You can look up specific item collection by making a GET request to the Offer Library API that includes the id in the request path.

API format

GET /{ENDPOINT_PATH}/item-collections/{ID}
ParameterDescriptionExample
{ENDPOINT_PATH}The endpoint path for persistence APIs.https://platform.adobe.io/data/core/dps
{ID}The id of the entity you wish to look up.itemCollections1234

Request

curl -X GET 'https://platform.adobe.io/data/core/dps/item-collections/itemCollections1234' \
-H 'Accept: *,application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'

Response

A successful response returns the details of the item collections.

{
    "created": "2024-01-31T18:28:52.888Z",
    "modified": "2024-06-28T19:44:13.112Z",
    "etag": 7,
    "schemas": [
        "https://ns.adobe.com/experience/decisioning/item-collection;version=1.2"
    ],
    "createdBy": "{CREATED_BY}",
    "lastModifiedBy": "{MODIFIED_BY}",
    "id": "itemCollection1234",
    "name": "Item collection One",
    "description": "Item collection",
    "constraints": [
        {
            "itemCatalogId": "itemCatalog1234",
            "uiModel": "{\"operator\":\"equals\",\"value\":{\"left\":\"_experience.decisioning.decisionitem.itemName\",\"right\":\"Some offer item\"}}"
        }
    ]
}
recommendation-more-help