Skip to main content

Collection

v1

Description

Get notified when a new collection of products is created, edited, or deleted.


Supported Type

  • Create
  • Update
  • Delete

Payload

{
"event":{
"id":"6j8ltgPuodGyl8Yv+PBVY8SgizrFTV8sVwg5azjy6jw=",
"name":"collection",
"type":"update",
"version":"1",
"trace_id":[
"silverbolt.bad8dbf2-05b9-11ec-b7ea-d271864b1058"
],
"created_timestamp":1629905580350
},
"payload":{
"collection":{
"id":"61262a035c7e03000187e94b",
"seo":{
"title":"Manual Handpick Coll",
"description":""
},
"logo":{
"url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png",
"type":"image"
},
"meta":{

},
"name":"Manual Handpick Coll",
"slug":"manual-handpick-coll",
"tags":[

],
"type":"items",
"badge":{
"text":"",
"color":"#ffffff"
},
"items":[
{
"action":"remove",
"item_id":75252592
},
{
"action":"remove",
"item_id":7608878
},
{
"action":"remove",
"item_id":7608686
},
{
"action":"remove",
"item_id":7608576
},
{
"action":"remove",
"item_id":7608538
},
{
"action":"remove",
"item_id":7608163
},
{
"action":"remove",
"item_id":7608170
}
],
"query":{

},
"app_id":"5d64e3500bcad8693a821c0d",
"banners":{
"portrait":{
"url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png",
"type":"image"
},
"landscape":{
"url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png",
"type":"image"
}
},
"sort_on":"manual",
"_schedule":{
"start":"2021-08-25T11:30:41.931000+00:00",
"next_schedule":[
{
"start":"2021-08-25T11:30:41.931000+00:00"
}
]
},
"is_active":true,
"published":true,
"allow_sort":true,
"description":"",
"_custom_json":{

},
"allow_facets":true,
"_locale_language":{

},
"visible_facets_keys":[

]
}
},
"contains":[
"collection"
],
"company_id":61,
"application_id":"5d64e3500bcad8693a821c0d"
}

Object Properties

KeyTypeDescription
idstringID of the collection created
typestringType of collection. For e.g. items, query, etc.
is_activebooleanKey to determine whether the collection is active or in_active
allow_facetsbooleanAllow facets on the filters while listing
slugstringUnique automatically generated slug of the collection
metaobjectExtra meta that can be added for the collection
descriptionstringDescription of the collection created
badgeobjectColour of the badge
app_idstringApplication ID in which the collection is created
visible_facet_keysarrayKeys that should be available for facet on product listing
publishedbooleanKey to determine whether the collection is published or not
bannersobjectLandscape and Portrait Image URL of the collection
_locale_languageobjectConversion of the brand name in different languages
sort_onstringKey to sort the collection products
_scheduleobjectSchedule when the collection should be live
allow_sortbooleanWhether to allow sort for the products in the collection
_custom_jsonobjectExtra json data
namestringName of the collection data
tagsarrayTags added to the particular collection
seoobjectDescriptive name and description for SEO purpose
logoobjectLogo url of the collection
queryobjectQuery on which the collection was created
itemsarrayItems included in the collection