Collections are subsets of offers based on predefined conditions defined by a marketer, such as category of the offer.
You can look up specific collections by making a GET request to the Offer Library API that includes either the collection @id
or the name of the collection in the request path.
API format
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FILTER}&{QUERY_PARAMS}
Parameter | Description | Example |
---|---|---|
{ENDPOINT_PATH} |
The endpoint path for repository APIs. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
The container where the collections are located. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_FILTER} |
Defines the schema associated with collections. | https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1 |
id |
A string used to match the @id property of the entities. The string is matched exactly. The parameters id and name cannot be used together. |
xcore:offer-filter:124bd44648f17ec1 |
name |
A string used to match the xdm:name property of the entities. The string is matched exactly, with capitalization, but wild card characters can be used. The parameters id and name cannot be used together |
Mobile demo |
Request
curl -X GET \
'https://platform.adobe.io/data/core/xcore/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&id=xcore:offer-filter:124bd44648f17ec1' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-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 placement including information about your container ID, instance ID and, unique collection @id
.
{
"containerId": "ab574eca-f7a9-38d0-b3d9-297376ca9ee2",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1",
"requestTime": "2020-10-21T21:29:27.329070Z",
"_embedded": {
"results": [
{
"instanceId": "27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-10-20T02:37:11.263718Z",
"repo:lastModifiedDate": "2020-10-20T02:37:11.263718Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_score": 0,
"_instance": {
"xdm:ids": [
"xcore:tag:124bd3de7f598dd8"
],
"xdm:name": "Mobile Demo",
"xdm:filterType": "anyTags",
"@id": "xcore:offer-filter:124bd44648f17ec1"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"href": "/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances/27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 1,
"count": 1
},
"_links": {
"self": {
"href": "/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&id=xcore:offer-filter:124bd44648f17ec1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}