External Events via EventBridge
The following events contain the entity changed in the event message payload.
List of Events
S.No. | API Call | Call Details | Event Type | Identifier |
---|---|---|---|---|
1. | POST | CreateLocation | locationservice/location/create | response_identifier |
2. | PATCH | PatchUpdateLocation | locationservice/location/patch | response_identifier |
3. | PUT | UpdateLocation | locationservice/location/update | response_identifier |
4. | POST | CreateEvent | locationservice/event/create | response_identifier |
5. | PATCH | PatchUpdateEvent | locationservice/event/patch | response_identifier |
6. | PUT | UpdateEvent | locationservice/event/update | response_identifier |
7. | DELETE | DeleteEvent | locationservice/event/delete | response_identifier |
8. | PATCH | PatchUpdateLocationProperty | locationservice/locationproperty/patch | response_locationProperties.name |
9. | PUT | UpdateLocationProperty | locationservice/locationproperty/update | response_locationProperties.name |
10. | DELETE | DeleteLocation | locationservice/location/delete | response_identifier |
Payload
CreateLocation
Event Type: locationservice/location/create
{
"version": "0",
"id": "1b6c783b-4e02-0880-66aa-be5be4d90f32",
"detail-type": "locationservice/location/create",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:11:49Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "1715238707987",
"timestamp": 1715238708410,
"payload": {
"identifier": "1715238707987",
"collectionId": 138,
"status": "ACTIVE",
"address": {
"address1": "#1, 1st Main Road",
"address2": "Near Chellarams",
"address3": "Commercial Road",
"city": "Ooty",
"state": "Tamilnadu",
"postalCode": "643001",
"latitude": 11.4189,
"longitude": 76.7114,
"country": null,
"phoneNumber": null
},
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"hours": [
{
"hoursType": "STANDARD",
"name": "102_LOC1_REG_BIZ_HRS",
"description": "Regular business hours of the store",
"standardHours": {
"monday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "monday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "monday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "monday business hours"
}
],
"tuesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "tuesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "tuesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "tuesday business hours"
}
],
"wednesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "wednesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "wednesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "wednesday business hours"
}
],
"thursday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "thursday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "thursday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "thursday business hours"
}
],
"friday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "friday business hours"
}
],
"saturday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "saturday business hours"
}
],
"sunday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "14:00",
"description": "sunday business hours"
}
]
},
"overrides": null
}
],
"events": [
],
"createdOn": "2024-05-09T07:11:48.039164735",
"createdBy": 1,
"updatedOn": "2024-05-09T07:11:48.103550691",
"updatedBy": 1,
"properties": [
{
"value": "externalevents1715238707987",
"name": "Proprietor",
"locale": "en_US"
},
{
"value": "Furniche Ooty",
"name": "name",
"locale": "en_US"
}
],
"binId": "1715238707987",
"enableShipToStore": true,
"enableStorePickup": true,
"enableShipFromStore": true
},
"collectionId": "138",
"eventType": "locationservice/location/create",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
PatchUpdateLocation
Event Type: locationservice/location/patch
{
"version": "0",
"id": "8b1e4f47-1468-73ba-935e-ea1e61851abf",
"detail-type": "locationservice/location/patch",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:11:53Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "1715238707987",
"timestamp": 1715238713914,
"payload": {
"identifier": "1715238707987",
"collectionId": 138,
"status": "ACTIVE",
"address": {
"address1": "#1, 1st Main Road",
"address2": "Near Chellarams",
"address3": "Commercial Road",
"city": "Ooty",
"state": "Tamilnadu",
"postalCode": "643001",
"latitude": 11.4189,
"longitude": 76.7114,
"country": null,
"phoneNumber": null
},
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"hours": [
{
"hoursType": "STANDARD",
"name": "102_LOC1_REG_BIZ_HRS",
"description": "Regular business hours of the store",
"standardHours": {
"monday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "monday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "monday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "monday business hours"
}
],
"tuesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "tuesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "tuesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "tuesday business hours"
}
],
"wednesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "wednesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "wednesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "wednesday business hours"
}
],
"thursday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "thursday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "thursday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "thursday business hours"
}
],
"friday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "friday business hours"
}
],
"saturday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "saturday business hours"
}
],
"sunday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "14:00",
"description": "sunday business hours"
}
]
},
"overrides": null
}
],
"events": [
],
"createdOn": "2024-05-09T07:11:48.039",
"createdBy": 1,
"updatedOn": "2024-05-09T07:11:53.886237074",
"updatedBy": 1,
"properties": [
{
"value": "externalevents1715238707987",
"name": "Proprietor",
"locale": "en_US"
},
{
"value": "Furniche Ooty",
"name": "name",
"locale": "en_US"
}
],
"binId": "externalevents1715238713833",
"enableShipToStore": true,
"enableStorePickup": true,
"enableShipFromStore": true
},
"collectionId": "138",
"eventType": "locationservice/location/patch",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLocation
Event Type: locationservice/location/update
{
"version": "0",
"id": "7ad9fa7d-df63-6f77-c2c0-23e005dacd84",
"detail-type": "locationservice/location/update",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:11:59Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "1715238707987",
"timestamp": 1715238719149,
"payload": {
"identifier": "1715238707987",
"collectionId": 138,
"status": "ACTIVE",
"address": {
"address1": "#1, 1st Main Road",
"address2": "Near Chellarams",
"address3": "Commercial Road",
"city": "Ooty",
"state": "Tamilnadu",
"postalCode": "643001",
"latitude": 11.4189,
"longitude": 76.7114,
"country": null,
"phoneNumber": null
},
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"hours": [
{
"hoursType": "BUSINESS",
"name": "102_LOC1_REG_BIZ_HRS",
"description": "Regular business hours of the store",
"standardHours": {
"monday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "monday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "monday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "22:00",
"description": "monday business hours"
}
],
"tuesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "tuesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "tuesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "22:00",
"description": "tuesday business hours"
}
],
"wednesday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "wednesday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "wednesday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "wednesday business hours"
}
],
"thursday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "13:00",
"description": "thursday business hours"
},
{
"type": "CLOSED",
"startTime": "13:00",
"endTime": "14:30",
"description": "thursday lunch hours"
},
{
"type": "OPEN",
"startTime": "14:30",
"endTime": "21:00",
"description": "thursday business hours"
}
],
"friday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "friday business hours"
}
],
"saturday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "21:00",
"description": "saturday business hours"
}
],
"sunday": [
{
"type": "OPEN",
"startTime": "09:00",
"endTime": "14:00",
"description": "sunday business hours"
}
]
},
"overrides": null
}
],
"events": [
],
"createdBy": 0,
"updatedOn": "2024-05-09T07:11:59.13543313",
"updatedBy": 1,
"properties": [
{
"value": "Prabhu M",
"name": "Proprietor",
"locale": "en_US"
},
{
"value": "Furniche Ooty",
"name": "name",
"locale": "en_US"
}
],
"binId": "ExternalEvents1715238719105",
"locationType": "Store",
"enableShipToStore": true,
"enableStorePickup": true,
"enableShipFromStore": true
},
"collectionId": "138",
"eventType": "locationservice/location/update",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateEvent
Event Type: locationservice/event/create
{
"version": "0",
"id": "f1781cf5-39e7-01f1-ce9f-0011feb9c924",
"detail-type": "locationservice/event/create",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:04Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ExternalEvents1715238724392",
"timestamp": 1715238724505,
"payload": {
"identifier": "ExternalEvents1715238724392",
"collectionId": 138,
"name": "EventProp",
"shortDescription": "Event",
"longDescription": "EventForLocationID",
"url": "string",
"locationIds": [
"1715238707987"
],
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"tags": [
"string1"
],
"startTime": "2016-11-09T06:14:44.797",
"endTime": "2025-11-09T06:14:44.797",
"updatedOn": "2024-05-09T07:12:04.468552982",
"createdOn": "2024-05-09T07:12:04.463831558",
"updatedBy": 0,
"createdBy": 0,
"properties": [
{
"value": "event001",
"name": "prop1",
"locale": "en_US"
}
]
},
"collectionId": "138",
"eventType": "locationservice/event/create",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
PatchUpdateEvent
Event Type: locationservice/event/patch
{
"version": "0",
"id": "d36967e6-3a8a-a87a-a42a-83109fecd91b",
"detail-type": "locationservice/event/patch",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:09Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ExternalEvents1715238724392",
"timestamp": 1715238729814,
"payload": {
"identifier": "ExternalEvents1715238724392",
"collectionId": 138,
"name": "EventProp",
"shortDescription": "Event",
"longDescription": "EventForLocationID",
"url": "string",
"locationIds": [
"1715238707987"
],
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"tags": [
"string1"
],
"startTime": "2016-11-09T06:14:44.797",
"endTime": "2025-11-09T06:14:44.797",
"updatedOn": "2024-05-09T07:12:09.802322803",
"createdOn": "2024-05-09T07:12:04.463",
"updatedBy": 0,
"createdBy": 0,
"properties": [
{
"value": "event10001",
"name": "prop1",
"locale": "en_US"
}
]
},
"collectionId": "138",
"eventType": "locationservice/event/patch",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateEvent
Event Type: locationservice/event/update
{
"version": "0",
"id": "fb805198-54da-4e1f-3f34-9679784a78c9",
"detail-type": "locationservice/event/update",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:15Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ExternalEvents1715238724392",
"timestamp": 1715238735104,
"payload": {
"identifier": "ExternalEvents1715238724392",
"collectionId": 138,
"name": "EventProp",
"shortDescription": "Event",
"longDescription": "EventForLocationID",
"url": "string",
"locationIds": [
"1715238707987"
],
"images": [
{
"url": "https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg",
"caption": "store location 001 logo for collection 102",
"description": "logo of this store 001 for collection 102"
}
],
"tags": [
"string1"
],
"startTime": "2016-11-09T06:14:44.797",
"endTime": "2025-11-09T06:14:44.797",
"updatedOn": "2024-05-09T07:12:15.09218603",
"createdOn": "2024-05-09T07:12:04.463",
"updatedBy": 0,
"createdBy": 0,
"properties": [
{
"value": "Events1715238735044",
"name": "prop1",
"locale": "en_US"
}
]
},
"collectionId": "138",
"eventType": "locationservice/event/update",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteEvent
Event Type: locationservice/event/delete
{
"version": "0",
"id": "3bb24668-129e-ab1f-5364-aaf3be14256e",
"detail-type": "locationservice/event/delete",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:20Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ExternalEvents1715238724392",
"timestamp": 1715238740377,
"payload": {
"responseCode": "LOEVD0000",
"responseMessage": "Event IdExternalEvents1715238724392 Deleted Successfully.",
"timeStamp": "1715238740367"
},
"collectionId": "138",
"eventType": "locationservice/event/delete",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
PatchUpdateLocationProperty
Event Type: locationservice/locationproperty/patch
{
"version": "0",
"id": "3b05fd31-a4f4-dc7d-db8d-9055dd117644",
"detail-type": "locationservice/locationproperty/patch",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:25Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"timestamp": 1715238745724,
"payload": {
"locationProperties": [
{
"value": "proprietor value updated",
"locale": "en_US",
"name": "Proprietor"
},
{
"value": "Updatedexternalevents1715238745684",
"locale": "en_US",
"name": "name"
}
],
"count": 2
},
"collectionId": "138",
"eventType": "locationservice/locationproperty/patch",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLocationProperty
Event Type: locationservice/locationproperty/update
{
"version": "0",
"id": "4934976d-3462-2d32-ef46-b234e99f94b4",
"detail-type": "locationservice/locationproperty/update",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:31Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"timestamp": 1715238750965,
"payload": {
"locationProperties": [
{
"value": "PUTUpdatedexternalevents1715238750930",
"locale": "en_US",
"name": "Proprietor"
}
],
"count": 1
},
"collectionId": "138",
"eventType": "locationservice/locationproperty/update",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteLocation
Event Type: locationservice/location/delete
{
"version": "0",
"id": "223d1a30-c652-f457-5166-cfa322577f60",
"detail-type": "locationservice/location/delete",
"source": "locationservice",
"account": "277827593990",
"time": "2024-05-09T07:12:36Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "1715238707987",
"timestamp": 1715238756173,
"payload": {
"responseCode": "LOLOD0000",
"responseMessage": "Location Id1715238707987 Deleted Successfully.",
"timeStamp": "1715238756165"
},
"collectionId": "138",
"eventType": "locationservice/location/delete",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
Revision History
2024-05-23 | SD – Create page and updated content.