This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Lists microservice.

External Events via EventBridge

The following events contain the entity changed in the event message payload.

List of Events

S.No.	API call	Call detail	Event Type	Identifier
1	POST	CreateList	listservice/list/create	response_list.id
2	DELETE	DeleteList	listservice/list/delete	response_list.id
3	POST	CreateListItem	listservice/listitem/create	response_listItems.id
4	DELETE	DeleteListItem	listservice/listitem/delete	response_listItems.id
5	POST	CreateListProperties	listservice/listproperties/create	response_list.id
6	DELETE	DeleteListProperties	listservice/listproperties/delete	response_list.id
7	POST	CreateListItemProperties	listservice/listitemproperties/create	response_listItems.id
8	DELETE	DeleteListItemProperties	listservice/listitemproperties/delete	response_listItems.id
9	PUT	UpdateListProperties	listservice/listproperties/update	response_list.id
10	PUT	UpdateListItemProperties	listservice/listitemproperties/update	response_listItems.id
11	PATCH	PatchUpdateList	listservice/list/patch	response_list.id
12	PATCH	PatchUpdateListItem	listservice/listitem/patch	response_listItems.id
13	PATCH	PatchUpdateListProperties	listservice/listproperties/patch	response_list.id
14	PATCH	PatchUpdateListItemProperties	listservice/listitemproperties/patch	response_listItems.id

Payload

CreateList

Event Type: listservice/list/create


{
  "version": "0",
  "id": "f8f34ef6-34b5-7ec4-0a76-8d15d1bf7bdb",
  "detail-type": "listservice/list/create",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:29:59Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "663c6d673ddabb0f3e4c0955",
    "timestamp": 1715236199382,
    "payload": {
      "list": {
        "id": "663c6d673ddabb0f3e4c0955",
        "type": "WISHLIST",
        "userId": "1",
        "accountId": "string",
        "itemType": "SKU",
        "createdBy": "1",
        "updatedBy": "string",
        "accessType": "PRIVATE",
        "listItems": [
          {
            "id": "2533",
            "key": "string",
            "name": "string"
          }
        ],
        "name": "ExternalEventsList1715236199323",
        "createdTime": "1715236199367",
        "updatedTime": "1715236199367"
      }
    },
    "collectionId": "2921",
    "eventType": "listservice/list/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteList

Event Type: listservice/list/delete


{
  "version": "0",
  "id": "8f14f8a2-4463-e441-a896-962079092403",
  "detail-type": "listservice/list/delete",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:31:03Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236263722,
    "payload": {
      "responseCode": "LILIDEL0000",
      "responseMessage": "List deleted successfully.",
      "timeStamp": "1715236263714"
    },
    "collectionId": "2921",
    "eventType": "listservice/list/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateListItem

Event Type: listservice/listitem/create


{
  "version": "0",
  "id": "25c9b017-5a4a-a92e-e4fc-a0a47a944016",
  "detail-type": "listservice/listitem/create",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:07Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236207985,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "string15",
          "name": "ExternalEventsListtem1715236207937",
          "createdTime": "1715236207973",
          "updatedTime": "string",
          "properties": {
            "additionalProp1": "string12",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitem/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteListItem

Event Type: listservice/listitem/delete


{
  "version": "0",
  "id": "4fe7b1ef-8d8f-cb82-d775-92d2f68f3c1b",
  "detail-type": "listservice/listitem/delete",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:58Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236258448,
    "payload": {
      "responseCode": "LIITDEL0000",
      "responseMessage": "List item deleted successfully.",
      "timeStamp": "1715236258445"
    },
    "collectionId": "2921",
    "eventType": "listservice/listitem/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateListProperties

Event Type: listservice/listproperties/create


{
  "version": "0",
  "id": "69a5825a-766e-b641-0b9c-1279f521c704",
  "detail-type": "listservice/listproperties/create",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:34Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "663c6d673ddabb0f3e4c0955",
    "timestamp": 1715236234242,
    "payload": {
      "list": {
        "id": "663c6d673ddabb0f3e4c0955",
        "type": "WISHLIST",
        "userId": "1",
        "accountId": "string",
        "itemType": "SKU",
        "createdBy": "1",
        "updatedBy": "1",
        "accessType": "PRIVATE",
        "listItems": [
          {
            "id": "2534",
            "key": "updated",
            "updatedTime": "1715236228987",
            "properties": {
              "additionalProp1": "updatedValue1",
              "additionalProp2": "updatedValue2"
            }
          }
        ],
        "name": "ExternalEventsList1715236199323",
        "createdTime": "1715236199367",
        "updatedTime": "1715236234224",
        "properties": {
          "additionalProp1": "updatedValue1",
          "additionalProp2": "updatedValue2"
        }
      }
    },
    "collectionId": "2921",
    "eventType": "listservice/listproperties/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteListProperties

Event Type: listservice/listproperties/delete


{
  "version": "0",
  "id": "26d7afbb-9415-679f-5cf2-68e7e9be4280",
  "detail-type": "listservice/listproperties/delete",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:55Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236255190,
    "payload": {
      "responseCode": "LIPRDEL0000",
      "responseMessage": "The list item properties have been deleted successfully.",
      "timeStamp": "1715236255182"
    },
    "collectionId": "2921",
    "eventType": "listservice/listproperties/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateListItemProperties

Event Type: listservice/listitemproperties/create


{
  "version": "0",
  "id": "ca7e2dc5-463f-46af-c445-88bac1ba44d3",
  "detail-type": "listservice/listitemproperties/create",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:18Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236218534,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "updated",
          "updatedTime": "1715236218523",
          "properties": {
            "additionalProp8": "prop8"
          }
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitemproperties/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteListItemProperties

Event Type: listservice/listitemproperties/delete


{
  "version": "0",
  "id": "43d2bf90-9e33-f90b-f033-319d28dbe2bf",
  "detail-type": "listservice/listitemproperties/delete",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:49Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236249972,
    "payload": {
      "responseCode": "LIITPRDEL0000",
      "responseMessage": "The list item properties have been deleted successfully.",
      "timeStamp": "1715236249964"
    },
    "collectionId": "2921",
    "eventType": "listservice/listitemproperties/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateListProperties

Event Type: listservice/listproperties/update


{
  "version": "0",
  "id": "55cbc647-1bfb-ea1b-4f70-5c197ddfdf7d",
  "detail-type": "listservice/listproperties/update",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:44Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "663c6d673ddabb0f3e4c0955",
    "timestamp": 1715236244699,
    "payload": {
      "list": {
        "id": "663c6d673ddabb0f3e4c0955",
        "type": "WISHLIST",
        "userId": "1",
        "accountId": "string",
        "itemType": "SKU",
        "createdBy": "1",
        "updatedBy": "1",
        "accessType": "PRIVATE",
        "listItems": [
          {
            "id": "2534",
            "key": "updated",
            "updatedTime": "1715236228987",
            "properties": {
              "additionalProp1": "updatedValue1",
              "additionalProp2": "updatedValue2"
            }
          }
        ],
        "name": "ExternalEventsList1715236199323",
        "createdTime": "1715236199367",
        "updatedTime": "1715236244689",
        "properties": {
          "additionalProp1": "updatedValue"
        }
      }
    },
    "collectionId": "2921",
    "eventType": "listservice/listproperties/update",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateListItemProperties

Event Type: listservice/listitemproperties/update


{
  "version": "0",
  "id": "417023d1-b7b7-74d7-5fd3-f3d5283d340f",
  "detail-type": "listservice/listitemproperties/update",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:29Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236228999,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "updated",
          "updatedTime": "1715236228987",
          "properties": {
            "additionalProp1": "updatedValue1",
            "additionalProp2": "updatedValue2"
          }
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitemproperties/update",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

PatchUpdateList

Event Type: listservice/list/patch


{
  "version": "0",
  "id": "e010e3a7-6d8e-34f6-7ee3-3bc9f03fb450",
  "detail-type": "listservice/listitem/patch",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:13Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236213258,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "updated",
          "updatedTime": "1715236213246"
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitem/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

PatchUpdateListItem

Event Type: listservice/listitem/patch


{
  "version": "0",
  "id": "e010e3a7-6d8e-34f6-7ee3-3bc9f03fb450",
  "detail-type": "listservice/listitem/patch",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:13Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236213258,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "updated",
          "updatedTime": "1715236213246"
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitem/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

PatchUpdateListProperties

Event Type: listservice/listproperties/patch


{
  "version": "0",
  "id": "9ec807dc-48ad-70c1-1b64-385c06a8ca54",
  "detail-type": "listservice/listproperties/patch",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:39Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "663c6d673ddabb0f3e4c0955",
    "timestamp": 1715236239472,
    "payload": {
      "list": {
        "id": "663c6d673ddabb0f3e4c0955",
        "type": "WISHLIST",
        "userId": "1",
        "accountId": "string",
        "itemType": "SKU",
        "createdBy": "1",
        "updatedBy": "1",
        "accessType": "PRIVATE",
        "listItems": [
          {
            "id": "2534",
            "key": "updated",
            "updatedTime": "1715236228987",
            "properties": {
              "additionalProp1": "updatedValue1",
              "additionalProp2": "updatedValue2"
            }
          }
        ],
        "name": "ExternalEventsList1715236199323",
        "createdTime": "1715236199367",
        "updatedTime": "1715236239462",
        "properties": {
          "additionalProp1": "updatedValue",
          "additionalProp2": "updatedValue2"
        }
      }
    },
    "collectionId": "2921",
    "eventType": "listservice/listproperties/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

PatchUpdateListItemProperties

Event Type: listservice/listitemproperties/patch


{
  "version": "0",
  "id": "e4c95bfb-098a-7eae-357f-5ac68c9fa44d",
  "detail-type": "listservice/listitemproperties/patch",
  "source": "listservice",
  "account": "277827593990",
  "time": "2024-05-09T06:30:23Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1715236223769,
    "payload": {
      "listItems": [
        {
          "id": "2534",
          "key": "updated",
          "updatedTime": "1715236223757",
          "properties": {
            "additionalProp8": "updatedValue"
          }
        }
      ]
    },
    "collectionId": "2921",
    "eventType": "listservice/listitemproperties/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

Internal Events via RabbitMQ/AWS MQ

The following events communicate with the internal microservices.

List of Events

SL.#	NAME	DESCRIPTION	PUBLISH LOCATION	ROUTING KEY	DURABILITY	PAYLOAD TYPE
1	Create List	This event is triggered when a list is created.	Topic: `ecomm`	`list.created`	true	listPayload
2	Update List	This event is triggered when a list is updated.	Topic: `ecomm`	`list.updated`	true	listPayload
3	Delete List	This event is triggered when a list is deleted.	Topic: `ecomm`	`list.deleted`	true	listPayload
4	Create Listitem	This event is triggered when a listitem is created.	Topic: `ecomm`	`listitem.created`	true	listPayload
5	Update Listitem	This event is triggered when a listitem is updated.	Topic: `ecomm`	`listitem.updated`	true	listPayload
6	Delete Listitem	This event is triggered when a listitem is deleted.	Topic: `ecomm`	`listitem.deleted`	true	listPayload

Payload Model

Below is the payload for the Lists microservice events.

listPayload

PROPERTY	TYPE	DESCRIPTION	EXAMPLE
`userId`	`long`	Indicates the identifier of the user, who has accessed the cart.	123
`listId`	`long`	Indicates the identifier of the list, which is created, updated, or deleted.	123
`listItemId`	`long`	Indicates the identifier of the listitem, which is created, updated, or deleted.	123
`listType`	`string`	Specifies the type of the list. The possible values are WISHLIST, SAVEFORLATER, and FAVOURITES.	WISHLIST
`listItemType`	`string`	Specifies the allowed item types of the list.	SKU

Revision History
2024-05-22 | AN – Added external events for 8.17.4 release.
2019-05-16 | AN – Updated to a new table tool.
2019-04-06 | AN – Content updated for April 2019 release.
2019-01-23 | PLK – Page created and content uploaded.

Events – Lists

External Events via EventBridge

List of Events

Payload

CreateList

DeleteList

CreateListItem

DeleteListItem

CreateListProperties

DeleteListProperties

CreateListItemProperties

DeleteListItemProperties

UpdateListProperties

UpdateListItemProperties

PatchUpdateList

PatchUpdateListItem

PatchUpdateListProperties

PatchUpdateListItemProperties

Internal Events via RabbitMQ/AWS MQ

List of Events

Payload Model

listPayload