Create an Item Collection

6 min

Each code-based Experience Decision requires a Collection of Decisions Items. An Item Collection defines a grouping of Decision Items.

Request

Request Type: POST

Endpoint: https://platform.adobe.io/data/core/dps/item-collections/

Headers

Key	Value
Authorization	Bearer <VARIES>
x-api-key	<VARIES> (e.g. 1234b8e8cd0a48918412d22dd9b01234)
x-gw-ims-org-id	59C7440F5DE147EA0A495EB3@AdobeOrg
accept	application/json
Content-Type	application/json
x-sandbox-name	<VARIES> (e.g. lab612-01)
x-schema-id	<VARIES> (e.g. https://ns.adobe.com/adobedemoamericas275/schemas/dc5b593541543883856ef0f29f35923ad24a963d5ff35646)

Request Parameters

Parameter	Example	Type	Description	Required
name	Credit Card Offer Collection	string	the description of the decision item collection	YES
description	a collection of credit card offers	string	the description of the decision item collection	NO
constraints		object	contains the contraints that identify the appropriate catalog and the included decision item lookup parameters	YES
itemCatalogId	dps:decision-catalog:1a386cd47beb42b4	string	the ID of the item catalog specific to the AEP sandbox	YES
constraint	see request	string	a psql query that defines what decision items to include in the collection	YES
uiModel	see request	string	escaped JSON that defines what has been selected as a constraint in UI and mirrors the psql logic included in the constraint attribute	NO

Request Body

{
    "name": "Test Collection",
    "description": "Test Collection",
    "constraints": [
        {
            "itemCatalogId": "dps:decision-catalog:1a386cd47beb42b4",
            "constraint": "SELECT * FROM offer_items WHERE ((_adobedemoamericas275.offerMetadata.offerCollectionTag = 'creditCardInstructor') OR (_adobedemoamericas275.offerMetadata.offerCollectionTag = 'platinumATTENDEENAME'))",
            "uiModel": "{\"operator\":\"or\",\"value\":[{\"operator\":\"equals\",\"value\":{\"left\":\"_adobedemoamericas275.offerMetadata.offerCollectionTag\",\"right\":\"creditCardInstructor\"}},{\"operator\":\"equals\",\"value\":{\"left\":\"_adobedemoamericas275.offerMetadata.offerCollectionTag\",\"right\":\"platinumTest\"}}]}"
        }
    ]
}

Relevant Response Parameters

Attribute	Example	Description
id	dps:item-collection:1a4e5a3813ef66e5	the ID of the item collection
sandboxId	71795633-d212-4495-b956-33d212849517	the ID of the sandbox in which the item collection was created

Response Body

{
    "id": "dps:item-collection:1a4e5a3813ef66e5",
    "sandboxId": "71795633-d212-4495-b956-33d212849517",
    "etag": 1,
    "createdDate": "2025-02-28T19:08:35.216Z",
    "lastModifiedDate": "2025-02-28T19:08:35.216Z",
    "createdBy": "[email protected]",
    "lastModifiedBy": "[email protected]",
    "createdByClientId": "c4a0b8e8cd0a48918412d22dd9b0c7f5",
    "lastModifiedByClientId": "c4a0b8e8cd0a48918412d22dd9b0c7f5"
}