This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Order 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. | PATCH | PatchOrder | omsservices/orders/patchupdate | response_t.id |
| 2. | PUT | UpdateOrder | omsservices/orders/update | response_t.id |
| 3. | POST | CreateOrder | omsservices/orders/create | response_t.id |
| 4. | DELETE | DeleteOrder | omsservices/orders/delete | request_orderid |
| 5. | POST | CreateNote | omsservices/note/create | request_orderid |
Payload
PatchOrder
Event Type: omsservices/orders/update
{
"version": "0",
"id": "87bc5c9b-fcdd-d32b-54ee-0a774f6d00a9",
"detail-type": "omsservices/orders/create",
"source": "omsservices",
"account": "277827593990",
"time": "2024-05-09T06:35:23Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"timestamp": 1715236523807,
"payload": {
"code": "ORDER_CREATED",
"t": {
"id": "18f5c104f19f7hk",
"orderinfo": {
"collectionid": 1715236523258376,
"createdtime": 1715236523799,
"createdby": "111",
"updatedtime": 1715236523799,
"channel": "string",
"storeid": "string",
"affiliateid": "string",
"locale": "en_US",
"deletable": false,
"editable": false,
"ordertype": "Default",
"effectiveorderdate": 0
},
"orderitems": [
{
"id": "string",
"lineid": "1",
"originallineid": "1",
"status": "Created",
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku01",
"pid": "Pid01",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Dilip",
"lastname": "Kumar",
"middlename": "string",
"type": "string",
"companyname": "Amazon",
"deliveryinstruction": "string",
"address1": "5thstreet",
"address2": "string",
"address3": "string",
"city": "NY",
"county": "NY",
"state": "string",
"zip": "AZ09OP",
"country": "USA"
},
"shippingmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shippingcontact": {
"phone": "9870543210",
"email": "dkrvdilip@gmail.com",
"preferredcontact": "EMAIL"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "string"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 0,
"discount": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"quantity": 2,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"quantityV2": 2.0
}
],
"status": [
"Created"
],
"otherproperties": {
"additionalProp3": "string",
"X-B3-TraceId": "663c6eab907bb99b983eda032a0ebe36",
"additionalProp2": "string",
"additionalProp1": "string",
"X-B3-SpanId": "834acdb6b7095549"
},
"payments": [
{
"id": "123",
"value": 0,
"type": "string",
"format": "0",
"mode": "Currency",
"paymentitems": [
{
"status": "PREAUTHORIZED",
"value": 0,
"paymentrefid": "100",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"chargepriority": 0,
"refundpriority": 0
}
],
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"usertracking": {
"firstname": "Dilip",
"lastname": "Kumar",
"zip": "AB001B",
"guestuser": false,
"guestuserid": "",
"accountid": "A01",
"userid": "User01",
"usercontact": {
"phone": "9600904325",
"email": "dilipkumar@skava.com",
"preferredcontact": "EMAIL"
}
},
"itemLevelPatchAllowed": false
}
},
"collectionId": "1715236523258376",
"eventType": "omsservices/orders/create",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateOrder
Event Type: omsservices/orders/update
{
"version": "0",
"id": "784aa7ed-d4a0-4478-edf6-c325cf825881",
"detail-type": "omsservices/orders/update",
"source": "omsservices",
"account": "277827593990",
"time": "2024-05-09T06:35:37Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "18f5c10823dujg5",
"timestamp": 1715236537934,
"payload": {
"code": "ORDER_CREATED",
"t": {
"id": "18f5c10823dujg5",
"orderdetails": {
"fulfilmentinfo": {
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Abhi Bittu",
"address1": "sai surya towers",
"address2": "",
"city": "Hyderabad",
"state": "IA",
"zip": "1000",
"country": "US"
},
"shippingmethod": {
"code": "Economy",
"name": "EconomyShipping",
"deliveryterm": "Economy",
"expectedshipmentdatetime": 0,
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 25,
"cost": 0,
"discountinfo": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"shippingcontact": {
"phone": "9600904325",
"email": "saiabhinav@yopmail.com",
"preferredcontact": "EMAIL"
}
}
},
"orderinfo": {
"collectionid": 1715236523258376,
"createdtime": 1715236536891,
"createdby": "111",
"updatedtime": 1715236537926,
"channel": "string",
"storeid": "string",
"affiliateid": "string",
"locale": "en_US",
"deletable": true,
"editable": false,
"ordertype": "Default",
"effectiveorderdate": 0,
"notification": [
{
"id": 1,
"createdtime": 1646299955802,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"item": [
{
"itemid": "Oitem1",
"quantity": 4,
"returntype": false,
"pricedetails": {
"sale": "600",
"discount": "-10",
"tax": "0.01",
"fulfildiscount": "-5",
"totalToBePaid": "610.02",
"fulfilsale": "25",
"totalsale": "620"
},
"email": "dkrvdilip@gmail.com",
"status": "In_Process"
}
],
"totalCostFinal": "610.02",
"city": "NY",
"orderid": "18f5c10823dujg5",
"address_Street2": "string",
"description": "Order has been created",
"storeid": "string",
"type": "ORDER_CREATED",
"title": "Order",
"taxCost": "0.01",
"zipcode": "AZ09OP",
"routingkey": "order.created",
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "Mar 3, 2022 9:32:35 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
},
{
"id": 2,
"createdtime": 1646299956471,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"totalCostFinal": "610.02",
"city": "NY",
"orderid": "18f5c10823dujg5",
"address_Street2": "string",
"description": "PYMT_STATUS_TRANS_FAILED",
"storeid": "string",
"type": "ORDER_DELETED",
"title": "Order",
"taxCost": "0.01",
"zipcode": "AZ09OP",
"routingkey": "order.deleted",
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "Mar 3, 2022 9:32:35 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
}
]
},
"failedReason": {
"failedWorkItem": "Payment",
"responseMessage": "PaymentItem 88888 not found",
"responseCode": "PYMT_ITM_GET_404"
},
"orderitems": [
{
"id": "Oitem1",
"lineid": "1",
"originallineid": "0",
"status": "Deleted",
"displaystatus": "Deleted",
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku01",
"pid": "Pid01",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 300,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Abhi Bittu",
"address1": "sai surya towers",
"address2": "",
"city": "Hyderabad",
"state": "IA",
"zip": "1000",
"country": "US"
},
"shippingmethod": {
"code": "Economy",
"name": "EconomyShipping",
"deliveryterm": "Economy",
"expectedshipmentdatetime": 0,
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 25,
"cost": 0,
"discountinfo": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shippingcontact": {
"phone": "9600904325",
"email": "saiabhinav@yopmail.com",
"preferredcontact": "EMAIL"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 25,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": -5,
"totalfulfilsale": 20
},
"sale": 600,
"cost": 0,
"discount": -10,
"discountcost": 0,
"personalizationsale": 15,
"personalizationcost": 0,
"personalizationdiscount": -5,
"totalsale": 620,
"esttax": 0,
"tax": 0.01,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "string"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0.01,
"taxrate": 0.01,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 15,
"discount": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"statustransaction": [
{
"status": "In_Process",
"id": "1646299955786"
},
{
"status": "In_Promotion_Validation",
"id": "1646299955820"
},
{
"status": "In_Payment_Review",
"id": "1646299956113"
},
{
"status": "Deleted",
"id": "1646299956446"
}
],
"quantity": 4,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 600,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"quantityV2": 4.0
},
{
"id": "Oitem2",
"lineid": "2",
"originallineid": "0",
"status": "Deleted",
"displaystatus": "Deleted",
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku02",
"pid": "Pid02",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 300,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Abhi Bittu",
"address1": "sai surya towers",
"address2": "",
"city": "Hyderabad",
"state": "IA",
"zip": "1000",
"country": "US"
},
"shippingmethod": {
"code": "Economy",
"name": "EconomyShipping",
"deliveryterm": "Economy",
"expectedshipmentdatetime": 0,
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 25,
"cost": 0,
"discountinfo": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shippingcontact": {
"phone": "9600904325",
"email": "saiabhinav@yopmail.com",
"preferredcontact": "EMAIL"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 25,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": -5,
"totalfulfilsale": 20
},
"sale": 600,
"cost": 0,
"discount": -10,
"discountcost": 0,
"personalizationsale": 15,
"personalizationcost": 0,
"personalizationdiscount": -5,
"totalsale": 620,
"esttax": 0,
"tax": 0.01,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "string"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0.01,
"taxrate": 0.01,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 15,
"discount": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "PROMOCARTLEVEL",
"confirmationcode": "PROMOCARTLEVEL",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": -10,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"statustransaction": [
{
"status": "In_Process",
"id": "1646299955786"
},
{
"status": "In_Promotion_Validation",
"id": "1646299955820"
},
{
"status": "In_Payment_Review",
"id": "1646299956113"
},
{
"status": "Deleted",
"id": "1646299956446"
}
],
"quantity": 4,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 600,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"quantityV2": 4.0
}
],
"status": [
"Deleted"
],
"nextstatus": [
],
"otherproperties": {
"X-B3-SpanId": "087e1b6ca1d9cb79",
"isPutRequest": "yes",
"additionalProp3": "string",
"X-B3-TraceId": "663c6eb9b7817797c0f66c2190e75c77",
"paymentCollectionId": "2",
"inventoryCollectionId": "2"
},
"payments": [
{
"id": "123",
"value": 610.02,
"type": "string",
"format": "0",
"mode": "Currency",
"paymentitems": [
{
"status": "PREAUTHORIZED",
"value": 610.02,
"paymentrefid": "88888",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"chargepriority": 0,
"refundpriority": 0
}
],
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 25,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": -5,
"totalfulfilsale": 20
},
"sale": 600,
"cost": 0,
"discount": -20,
"discountcost": 0,
"personalizationsale": 15,
"personalizationcost": 0,
"personalizationdiscount": -5,
"totalsale": 610,
"esttax": 0,
"tax": 0.02,
"taxable": 0,
"roundoff": 0
}
],
"transactions": [
{
"id": "1646299955786",
"createdtime": 1646299955786,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Created",
"updatestatus": "In_Process",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "Oitem1"
},
{
"id": "1646299955820",
"createdtime": 1646299955820,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Process",
"updatestatus": "In_Promotion_Validation",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "Oitem1"
},
{
"id": "1646299956097",
"createdtime": 1646299956097,
"component": 0,
"type": "PROMOTION_UPDATE",
"responsecode": "PRPOBLK1004",
"responsemessage": "Infinite promotion",
"description": "PromotionBLOCK"
},
{
"id": "1646299956113",
"createdtime": 1646299956113,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Validation",
"updatestatus": "In_Payment_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "Oitem1"
},
{
"id": "1646299956424",
"createdtime": 1646299956424,
"component": 0,
"type": "PAYMENTUPDATE",
"currentstatus": "[In_Payment_Review]",
"updatestatus": "[In_Inventory_Review, Deleted]",
"responsecode": "PYMT_ITM_GET_404",
"responsemessage": "PaymentItem 88888 not found",
"description": "PreProcessPaymentResponse"
},
{
"id": "1646299956446",
"createdtime": 1646299956446,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Payment_Review",
"updatestatus": "Deleted",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "Oitem1"
}
],
"usertracking": {
"firstname": "Mariam",
"lastname": "Poole",
"zip": "07364",
"guestuser": false,
"guestuserid": "",
"accountid": "Accountabhi",
"userid": "Abhi77",
"usercontact": {
"phone": "2705152122",
"email": "EditedOrder_bmd_66@mailinator.com",
"preferredcontact": "EMAIL"
}
},
"notes": [
{
"description": "Order placed with physical",
"createdby": "1",
"createdtime": 1640171861075
}
],
"itemLevelPatchAllowed": false
}
},
"collectionId": "1715236523258376",
"eventType": "omsservices/orders/update",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateOrder
Event Type: omsservices/orders/create
{
"version": "0",
"id": "8c8d6dc1-2582-a392-1d93-8343e8767680",
"detail-type": "omsservices/note/create",
"source": "omsservices",
"account": "277827593990",
"time": "2024-05-09T06:35:33Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "18f5c104f19f7hk",
"timestamp": 1715236533611,
"payload": {
"code": "NOTE_CREATED",
"t": {
"id": "18f5c104f19f7hk",
"orderinfo": {
"collectionid": 1715236523258376,
"createdtime": 1715236523799,
"createdby": "111",
"updatedtime": 1715236524907,
"channel": "string",
"storeid": "string",
"affiliateid": "string",
"locale": "en_US",
"deletable": false,
"editable": false,
"ordertype": "Default",
"effectiveorderdate": 0,
"notification": [
{
"id": 1,
"createdtime": 1715236523832,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"item": [
{
"itemid": "string",
"quantity": 2,
"quantityV2": 2.0,
"returntype": false,
"pricedetails": {
"sale": "0",
"discount": "0",
"tax": "0",
"fulfildiscount": "0",
"totalToBePaid": "0",
"fulfilsale": "0",
"totalsale": "0"
},
"email": "dkrvdilip@gmail.com",
"status": "In_Process"
}
],
"city": "NY",
"orderid": "18f5c104f19f7hk",
"address_Street2": "string",
"description": "Order has been created",
"discount": "0",
"storeid": "string",
"type": "ORDER_CREATED",
"title": "Order",
"taxCost": "0",
"totalCostAfterDiscount": "0",
"zipcode": "AZ09OP",
"routingkey": "order.created",
"approvalRequired": false,
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "May 9, 2024, 6:35:23 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
}
]
},
"orderitems": [
{
"id": "string",
"lineid": "1",
"originallineid": "1",
"status": "Ready_To_Edit",
"nextstatus": [
"Cancelled",
"Freeze_Edit"
],
"displaystatus": "Ready_To_Edit",
"aggregatestatus": [
"Ready_To_Edit"
],
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku01",
"pid": "Pid01",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Dilip",
"lastname": "Kumar",
"middlename": "string",
"type": "string",
"companyname": "Amazon",
"deliveryinstruction": "string",
"address1": "5thstreet",
"address2": "string",
"address3": "string",
"city": "NY",
"county": "NY",
"state": "string",
"zip": "AZ09OP",
"country": "USA"
},
"shippingmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shippingcontact": {
"phone": "9870543210",
"email": "dkrvdilip@gmail.com",
"preferredcontact": "EMAIL"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "3fbc12b4-32af-45d7-9f3e-15c06ad1346c"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 0,
"discount": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"statustransaction": [
{
"status": "In_Process",
"id": "1715236523820"
},
{
"status": "In_Promotion_Validation",
"id": "1715236523846"
},
{
"status": "In_Payment_Review",
"id": "1715236524135"
},
{
"status": "In_Inventory_Review",
"id": "1715236524164"
},
{
"status": "In_Promotion_Assignment",
"id": "1715236524454"
},
{
"status": "In_Fraud_Review",
"id": "1715236524744"
},
{
"status": "Ready_To_Update",
"id": "1715236524758"
},
{
"status": "Ready_To_Edit",
"id": "1715236524907"
}
],
"quantity": 2,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"allowedPatchFields": [
{
"status": "Cancelled",
"allowedInputs": [
{
"name": "reasoncode",
"type": "string",
"allowedValues": [
"Don't require this product now",
"Ordered a wrong product",
"Provided a wrong shipping address",
"Travelling out of town",
"Expected delivery time is higher",
"Change in billing/shipping address",
"Others"
],
"label": "Reasons",
"required": true
},
{
"name": "reasonmessage",
"type": "string",
"min": "0",
"max": "1000",
"label": "Comments",
"required": false,
"allowedCharacter": ""
},
{
"name": "quantity",
"type": "number",
"min": "1",
"max": "",
"label": "Quantity",
"required": true,
"minXPath": "",
"maxXPath": "order.orderitems[].quantity"
}
],
"confirmationMessage": "Are you sure you want to cancel the order item ?",
"actionName": "Cancel"
}
],
"quantityV2": 2.0
}
],
"status": [
"Ready_To_Edit"
],
"nextstatus": [
"Freeze_Edit",
"Cancelled"
],
"allowedPatchFields": [
{
"status": "Cancelled",
"allowedInputs": [
{
"name": "reasoncode",
"type": "string",
"allowedValues": [
"Don't require this product now",
"Ordered a wrong product",
"Provided a wrong shipping address",
"Travelling out of town",
"Expected delivery time is higher",
"Change in billing/shipping address",
"Others"
],
"label": "Reasons",
"required": true
},
{
"name": "reasonmessage",
"type": "string",
"min": "0",
"max": "1000",
"label": "Comments",
"required": false,
"allowedCharacter": ""
}
],
"confirmationMessage": "Are you sure you want to cancel the order ?",
"actionName": "Cancel"
}
],
"otherproperties": {
"additionalProp3": "string",
"X-B3-TraceId": "663c6eab907bb99b983eda032a0ebe36",
"additionalProp2": "string",
"additionalProp1": "string",
"X-B3-SpanId": "834acdb6b7095549"
},
"payments": [
{
"id": "123",
"value": 0,
"type": "string",
"format": "0",
"mode": "Currency",
"paymentitems": [
{
"status": "PREAUTHORIZED",
"value": 0,
"paymentrefid": "100",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"chargepriority": 0,
"refundpriority": 0
}
],
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"transactions": [
{
"id": "1715236523820",
"createdtime": 1715236523820,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Created",
"updatestatus": "In_Process",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236523846",
"createdtime": 1715236523846,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Process",
"updatestatus": "In_Promotion_Validation",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524119",
"createdtime": 1715236524119,
"component": 0,
"type": "PROMOTION_UPDATE",
"responsecode": "PRPOBLK1004",
"responsemessage": "Infinite promotion",
"description": "PromotionBLOCK"
},
{
"id": "1715236524135",
"createdtime": 1715236524135,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Validation",
"updatestatus": "In_Payment_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524149",
"createdtime": 1715236524149,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "[In_Payment_Review]",
"updatestatus": "[In_Inventory_Review, Deleted]",
"responsecode": "200",
"responsemessage": "Success",
"description": "Payload processing has been skipped - com.skava.oms.flow.adapter.PreProcessPaymentDelegate"
},
{
"id": "1715236524164",
"createdtime": 1715236524164,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Payment_Review",
"updatestatus": "In_Inventory_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524454",
"createdtime": 1715236524454,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Inventory_Review",
"updatestatus": "In_Promotion_Assignment",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524727",
"createdtime": 1715236524727,
"component": 0,
"type": "PROMOTION_UPDATE",
"responsecode": "PRPOASN1008",
"responsemessage": "Infinite promotion",
"description": "PromotionASSIGN"
},
{
"id": "1715236524744",
"createdtime": 1715236524744,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Assignment",
"updatestatus": "In_Fraud_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524758",
"createdtime": 1715236524758,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Fraud_Review",
"updatestatus": "Ready_To_Update",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524907",
"createdtime": 1715236524907,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Ready_To_Update",
"updatestatus": "Ready_To_Edit",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.listener.UserTaskIdAssigneListener",
"orderitemid": "string"
}
],
"usertracking": {
"firstname": "Dilip",
"lastname": "Kumar",
"zip": "AB001B",
"guestuser": false,
"guestuserid": "",
"accountid": "A01",
"userid": "User01",
"usercontact": {
"phone": "9600904325",
"email": "dilipkumar@skava.com",
"preferredcontact": "EMAIL"
}
},
"notes": [
{
"description": "Order placed with physical",
"createdby": "111",
"createdtime": 1715236533601,
"type": "USER",
"usertype": "CSR"
}
],
"itemLevelPatchAllowed": true
}
},
"collectionId": "1715236523258376",
"eventType": "omsservices/note/create",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteOrder
Event Type: omsservices/orders/delete
{
"version": "0",
"id": "1f4f0328-8fbe-ea8f-ab3e-a0a150b4272c",
"detail-type": "omsservices/orders/delete",
"source": "omsservices",
"account": "277827593990",
"time": "2024-05-09T06:35:42Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "18f5c109431ip3p",
"timestamp": 1715236542572,
"payload": {
"code": "ORDER_UPDATED",
"t": {
"id": "18f5c109431ip3p",
"orderinfo": {
"collectionid": 1541748567916000,
"createdtime": 1715236541487,
"createdby": "1",
"updatedtime": 1715236541833,
"channel": "string",
"storeid": "STR01",
"affiliateid": "string",
"locale": "en_US",
"deletable": true,
"editable": false,
"ordertype": "Default",
"effectiveorderdate": 0,
"notification": [
{
"id": 1,
"createdtime": 1715236541523,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"item": [
{
"itemid": "string",
"quantity": 2,
"quantityV2": 2.0,
"returntype": false,
"pricedetails": {
"sale": "20000",
"discount": "0",
"tax": "20",
"fulfildiscount": "0",
"totalToBePaid": "20020",
"fulfilsale": "0",
"totalsale": "20000"
},
"email": "dkrvdilip@gmail.com",
"status": "In_Process"
}
],
"city": "NY",
"orderid": "18f5c109431ip3p",
"address_Street2": "string",
"description": "Order has been created",
"discount": "0",
"storeid": "STR01",
"type": "ORDER_CREATED",
"title": "Order",
"taxCost": "20",
"totalCostAfterDiscount": "20000",
"zipcode": "AZ09OP",
"routingkey": "order.created",
"approvalRequired": false,
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "May 9, 2024, 6:35:41 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
},
{
"id": 2,
"createdtime": 1715236541848,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"city": "NY",
"orderid": "18f5c109431ip3p",
"address_Street2": "string",
"description": "Promotions failureBLOCK",
"discount": "0",
"storeid": "STR01",
"type": "ORDER_DELETED",
"title": "Order",
"taxCost": "20",
"totalCostAfterDiscount": "20000",
"zipcode": "AZ09OP",
"routingkey": "order.deleted",
"approvalRequired": false,
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "May 9, 2024, 6:35:41 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
}
]
},
"failedReason": {
},
"orderitems": [
{
"id": "string",
"lineid": "1",
"originallineid": "1",
"status": "Deleted",
"displaystatus": "Deleted",
"aggregatestatus": [
"Deleted"
],
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku01",
"pid": "Pid01",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 10000,
"saleprice": 10000,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 10,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "test",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 20000,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 20000,
"esttax": 0,
"tax": 20,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "string"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 0,
"discount": [
{
"code": "test",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "test",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"statustransaction": [
{
"status": "In_Process",
"id": "1715236541508"
},
{
"status": "In_Promotion_Validation",
"id": "1715236541539"
},
{
"status": "Deleted",
"id": "1715236541833"
}
],
"quantity": 2,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 20000,
"saleprice": 20000,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 20,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"quantityV2": 2.0
}
],
"status": [
"Deleted"
],
"nextstatus": [
],
"otherproperties": {
"additionalProp3": "string",
"X-B3-TraceId": "663c6ebd40ec23b037261f51e3049b57",
"additionalProp2": "string",
"additionalProp1": "string",
"X-B3-SpanId": "dabfd96d1ca820ab"
},
"payments": [
{
"id": "123",
"value": 20020,
"type": "string",
"format": "0",
"mode": "Currency",
"paymentitems": [
{
"status": "PREAUTHORIZED",
"value": 20020,
"paymentrefid": "100",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"chargepriority": 0,
"refundpriority": 0
}
],
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 20000,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 20000,
"esttax": 0,
"tax": 20,
"taxable": 0,
"roundoff": 0
}
],
"transactions": [
{
"id": "1715236541508",
"createdtime": 1715236541508,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Created",
"updatestatus": "In_Process",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236541539",
"createdtime": 1715236541539,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Process",
"updatestatus": "In_Promotion_Validation",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236541813",
"createdtime": 1715236541813,
"component": 0,
"type": "PROMOTION_UPDATE",
"description": "Promotion failed"
},
{
"id": "1715236541833",
"createdtime": 1715236541833,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Validation",
"updatestatus": "Deleted",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236542564",
"createdtime": 1715236542564,
"component": 0,
"type": "DELETED",
"currentstatus": "Deleted",
"updatestatus": "DELETED",
"responsecode": "200",
"responsemessage": "success",
"description": "com.skava.oms.service.order.impl.DefaultDeleteOrderImpl@296a7859"
}
],
"usertracking": {
"guestuser": false,
"accountid": "A01"
},
"itemLevelPatchAllowed": false
}
},
"collectionId": "1541748567916000",
"eventType": "omsservices/orders/delete",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_ORDER_ADMIN"
],
"channel": "CSR"
}
}
CreateNote
Event Type: omsservices/note/create
{
"version": "0",
"id": "8c8d6dc1-2582-a392-1d93-8343e8767680",
"detail-type": "omsservices/note/create",
"source": "omsservices",
"account": "277827593990",
"time": "2024-05-09T06:35:33Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "18f5c104f19f7hk",
"timestamp": 1715236533611,
"payload": {
"code": "NOTE_CREATED",
"t": {
"id": "18f5c104f19f7hk",
"orderinfo": {
"collectionid": 1715236523258376,
"createdtime": 1715236523799,
"createdby": "111",
"updatedtime": 1715236524907,
"channel": "string",
"storeid": "string",
"affiliateid": "string",
"locale": "en_US",
"deletable": false,
"editable": false,
"ordertype": "Default",
"effectiveorderdate": 0,
"notification": [
{
"id": 1,
"createdtime": 1715236523832,
"createdby": "User01",
"description": "Notification for Order",
"type": "DefaultNotificationEvent",
"properties": {
"address_Street1": "5thstreet",
"item": [
{
"itemid": "string",
"quantity": 2,
"quantityV2": 2.0,
"returntype": false,
"pricedetails": {
"sale": "0",
"discount": "0",
"tax": "0",
"fulfildiscount": "0",
"totalToBePaid": "0",
"fulfilsale": "0",
"totalsale": "0"
},
"email": "dkrvdilip@gmail.com",
"status": "In_Process"
}
],
"city": "NY",
"orderid": "18f5c104f19f7hk",
"address_Street2": "string",
"description": "Order has been created",
"discount": "0",
"storeid": "string",
"type": "ORDER_CREATED",
"title": "Order",
"taxCost": "0",
"totalCostAfterDiscount": "0",
"zipcode": "AZ09OP",
"routingkey": "order.created",
"approvalRequired": false,
"currency": "$",
"state": "string",
"user": "Dilip",
"orderDate": "May 9, 2024, 6:35:23 AM",
"email": "dilipkumar@skava.com",
"ordertype": "Default"
}
}
]
},
"orderitems": [
{
"id": "string",
"lineid": "1",
"originallineid": "1",
"status": "Ready_To_Edit",
"nextstatus": [
"Cancelled",
"Freeze_Edit"
],
"displaystatus": "Ready_To_Edit",
"aggregatestatus": [
"Ready_To_Edit"
],
"item": {
"info": {
"name": "Redshoe",
"categoryid": "CAT01",
"image": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc",
"link": "www.amazon.com",
"description": "Redcolorsportsshoe",
"size": "9inch",
"color": "Red",
"style": "Flexible",
"fit": "Flexible",
"dimension": "9inch"
},
"weightValue": "string",
"weightUnits": "string",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"minpurchasequantity": 0,
"maxpurchasequantity": 0,
"preordered": false,
"backordered": false,
"skuid": "Sku01",
"pid": "Pid01",
"upc": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"taxcode": "string",
"binid": "12asdfg34",
"vendor": "string",
"minpurchasequantityV2": 0.0,
"maxpurchasequantityV2": 0.0
},
"fulfilmentinfo": {
"fulfilmentid": {
"status": "string",
"id": 0
},
"shipmentdate": 0,
"type": "PHYSICAL",
"shippingaddress": {
"firstname": "Dilip",
"lastname": "Kumar",
"middlename": "string",
"type": "string",
"companyname": "Amazon",
"deliveryinstruction": "string",
"address1": "5thstreet",
"address2": "string",
"address3": "string",
"city": "NY",
"county": "NY",
"state": "string",
"zip": "AZ09OP",
"country": "USA"
},
"shippingmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "Currency",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnmethod": {
"code": "string",
"name": "string",
"deliveryterm": "string",
"deliverystore": "string",
"expectedshipmentdatetime": 0,
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"priceinfo": [
{
"mode": "string",
"conversionratio": 0.01,
"estprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"estcost": 0,
"price": 0,
"cost": 0,
"discountinfo": [
{
"code": "string",
"mode": "string",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
},
"returnaddress": {
"firstname": "string",
"lastname": "string",
"middlename": "string",
"type": "string",
"companyname": "string",
"deliveryinstruction": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"county": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shippingcontact": {
"phone": "9870543210",
"email": "dkrvdilip@gmail.com",
"preferredcontact": "EMAIL"
}
},
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"inventory": {
"blocktransaction": "3fbc12b4-32af-45d7-9f3e-15c06ad1346c"
},
"personalization": [
{
"id": "string",
"skuid": "string",
"receipt": false,
"message": "string",
"wrap": "string",
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"unitpersonalizationcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"totalpersonalizationcost": 0,
"unitpersonalizationprice": 0,
"totalpersonalizationprice": 0,
"discount": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
]
}
]
}
],
"discounts": [
{
"code": "string",
"confirmationcode": "123435677976",
"mode": "Currency",
"discountclass": "string",
"offerid": "string",
"parentitem": "string",
"priceinfo": {
"unitdiscount": 0,
"totaldiscount": 0,
"unitcost": 0,
"totalcost": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
}
},
"name": "string",
"description": "string",
"level": "ITEM",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"statustransaction": [
{
"status": "In_Process",
"id": "1715236523820"
},
{
"status": "In_Promotion_Validation",
"id": "1715236523846"
},
{
"status": "In_Payment_Review",
"id": "1715236524135"
},
{
"status": "In_Inventory_Review",
"id": "1715236524164"
},
{
"status": "In_Promotion_Assignment",
"id": "1715236524454"
},
{
"status": "In_Fraud_Review",
"id": "1715236524744"
},
{
"status": "Ready_To_Update",
"id": "1715236524758"
},
{
"status": "Ready_To_Edit",
"id": "1715236524907"
}
],
"quantity": 2,
"returnable": false,
"returnType": false,
"priceinfo": [
{
"conversionratio": 0.01,
"mode": "Currency",
"saveprice": 0,
"regprice": 0,
"saleprice": 0,
"costprice": 0,
"taxinfo": {
"esttax": 0,
"tax": 0,
"taxrate": 0,
"taxable": 0
},
"roundoff": 0
}
],
"storeid": "0",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
},
"allowedPatchFields": [
{
"status": "Cancelled",
"allowedInputs": [
{
"name": "reasoncode",
"type": "string",
"allowedValues": [
"Don't require this product now",
"Ordered a wrong product",
"Provided a wrong shipping address",
"Travelling out of town",
"Expected delivery time is higher",
"Change in billing/shipping address",
"Others"
],
"label": "Reasons",
"required": true
},
{
"name": "reasonmessage",
"type": "string",
"min": "0",
"max": "1000",
"label": "Comments",
"required": false,
"allowedCharacter": ""
},
{
"name": "quantity",
"type": "number",
"min": "1",
"max": "",
"label": "Quantity",
"required": true,
"minXPath": "",
"maxXPath": "order.orderitems[].quantity"
}
],
"confirmationMessage": "Are you sure you want to cancel the order item ?",
"actionName": "Cancel"
}
],
"quantityV2": 2.0
}
],
"status": [
"Ready_To_Edit"
],
"nextstatus": [
"Freeze_Edit",
"Cancelled"
],
"allowedPatchFields": [
{
"status": "Cancelled",
"allowedInputs": [
{
"name": "reasoncode",
"type": "string",
"allowedValues": [
"Don't require this product now",
"Ordered a wrong product",
"Provided a wrong shipping address",
"Travelling out of town",
"Expected delivery time is higher",
"Change in billing/shipping address",
"Others"
],
"label": "Reasons",
"required": true
},
{
"name": "reasonmessage",
"type": "string",
"min": "0",
"max": "1000",
"label": "Comments",
"required": false,
"allowedCharacter": ""
}
],
"confirmationMessage": "Are you sure you want to cancel the order ?",
"actionName": "Cancel"
}
],
"otherproperties": {
"additionalProp3": "string",
"X-B3-TraceId": "663c6eab907bb99b983eda032a0ebe36",
"additionalProp2": "string",
"additionalProp1": "string",
"X-B3-SpanId": "834acdb6b7095549"
},
"payments": [
{
"id": "123",
"value": 0,
"type": "string",
"format": "0",
"mode": "Currency",
"paymentitems": [
{
"status": "PREAUTHORIZED",
"value": 0,
"paymentrefid": "100",
"otherproperties": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
],
"chargepriority": 0,
"refundpriority": 0
}
],
"math": [
{
"paymentid": "123",
"mode": "Currency",
"fulfilmath": {
"estfulfilsale": 0,
"estfulfilcost": 0,
"estfulfiltax": 0,
"fulfilsale": 0,
"fulfilcost": 0,
"fulfiltax": 0,
"fulfildiscount": 0,
"totalfulfilsale": 0
},
"sale": 0,
"cost": 0,
"discount": 0,
"discountcost": 0,
"personalizationsale": 0,
"personalizationcost": 0,
"personalizationdiscount": 0,
"totalsale": 0,
"esttax": 0,
"tax": 0,
"taxable": 0,
"roundoff": 0
}
],
"transactions": [
{
"id": "1715236523820",
"createdtime": 1715236523820,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Created",
"updatestatus": "In_Process",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236523846",
"createdtime": 1715236523846,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Process",
"updatestatus": "In_Promotion_Validation",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524119",
"createdtime": 1715236524119,
"component": 0,
"type": "PROMOTION_UPDATE",
"responsecode": "PRPOBLK1004",
"responsemessage": "Infinite promotion",
"description": "PromotionBLOCK"
},
{
"id": "1715236524135",
"createdtime": 1715236524135,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Validation",
"updatestatus": "In_Payment_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524149",
"createdtime": 1715236524149,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "[In_Payment_Review]",
"updatestatus": "[In_Inventory_Review, Deleted]",
"responsecode": "200",
"responsemessage": "Success",
"description": "Payload processing has been skipped - com.skava.oms.flow.adapter.PreProcessPaymentDelegate"
},
{
"id": "1715236524164",
"createdtime": 1715236524164,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Payment_Review",
"updatestatus": "In_Inventory_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524454",
"createdtime": 1715236524454,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Inventory_Review",
"updatestatus": "In_Promotion_Assignment",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524727",
"createdtime": 1715236524727,
"component": 0,
"type": "PROMOTION_UPDATE",
"responsecode": "PRPOASN1008",
"responsemessage": "Infinite promotion",
"description": "PromotionASSIGN"
},
{
"id": "1715236524744",
"createdtime": 1715236524744,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Promotion_Assignment",
"updatestatus": "In_Fraud_Review",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524758",
"createdtime": 1715236524758,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "In_Fraud_Review",
"updatestatus": "Ready_To_Update",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.util.OrderProcessFlowService",
"orderitemid": "string"
},
{
"id": "1715236524907",
"createdtime": 1715236524907,
"component": 0,
"type": "FULFILMENTUPDATE",
"currentstatus": "Ready_To_Update",
"updatestatus": "Ready_To_Edit",
"responsecode": "200",
"responsemessage": "Success",
"description": "com.skava.oms.flow.listener.UserTaskIdAssigneListener",
"orderitemid": "string"
}
],
"usertracking": {
"firstname": "Dilip",
"lastname": "Kumar",
"zip": "AB001B",
"guestuser": false,
"guestuserid": "",
"accountid": "A01",
"userid": "User01",
"usercontact": {
"phone": "9600904325",
"email": "dilipkumar@skava.com",
"preferredcontact": "EMAIL"
}
},
"notes": [
{
"description": "Order placed with physical",
"createdby": "111",
"createdtime": 1715236533601,
"type": "USER",
"usertype": "CSR"
}
],
"itemLevelPatchAllowed": true
}
},
"collectionId": "1715236523258376",
"eventType": "omsservices/note/create",
"userId": "111",
"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 | Order Created | This event will be triggered when an order is created. | Topic: ecomm | order.created | FALSE | Notification |
| 2 | Order Canceled | This event is triggered when the user cancels the order or order items. | Topic: ecomm | order.cancelled | FALSE | Notification |
| 3 | Order Deleted | This event will be triggered when an order is deleted. | Topic: ecomm | order.deleted | FALSE | Notification |
| 4 | Order to Inventory | Event to publish the inventory to block the item in the inventory. When the order's inventory has to be blocked, this event will be called. | Queue: inventory.bulktransactions | Inventory check event | FALSE | InventoryBulkTransaction |
| 5 | Order to Promotion | Event to publish the promotion to the block or apply operations for the applied promotions in the order. When the order's promotions have to be blocked, a block promotion event is sent. When the order's promotion has to be assigned, an assign promotion event is sent. | Queue: promotion.block/assign | Promotion check event | FALSE | PromotionBulkTransaction |
| 6 | Order to Payment | Event to publish the payment to charge, refund, or authorize the payment. When the order has to be authorized with the payment given by the user, either charge for the order or refund the amount to the user if the order is canceled, deleted or returned. | Queue: payment.bulkTransactionRequestQueue | Payment check event | FALSE | PaymentBulkTransaction |
| 7 | Order Return | This event will be triggered when an order or order item return is accepted. | Topic:ecomm | order.return | FALSE | Notification |
| 8 | Order Shipped | This event will be triggered when an order is shipped. | Topic:ecomm | order.shipped | FALSE | Notification |
| 9 | Check Fraud | This event will be triggered when a fraud check is performed. | Topic: OmsMsgTopic | order.checkfraud | FALSE | CheckFraud |
| 10 | Preprocess Inventory | This event will be triggered to show the process on the inventory block when an order is created or updated. | Topic: OmsMsgTopic | order.preprocessinventory | FALSE | PreProcessInventory |
| 11 | Preprocess Payment | This event will be triggered to show the processing on the payment block when an order is created or updated. | Topic: OmsMsgTopic | order.preprocesspayment | FALSE | PreProcessPayment |
| 12 | Preprocess Promotion | This event will be triggered to show the process on the promotion block when an order is created or updated. | Topic: OmsMsgTopic | order.preprocesspromotion | FALSE | PreProcessPromotion |
| 13 | Order Return Submitted | This event will be triggered, when an order or order item return is submitted. | Topic:ecomm | order.return.submitted | FALSE | Notification |
| 14 | Undo Preprocess Inventory | This event will be triggered when undo a preprocessing of inventory in an order. | Topic: OmsMsgTopic | order.undopreprocessinventory | FALSE | PreProcessInventory |
| 15 | Undo Preprocess Payment | This event will be triggered when undo a preprocessing of the payment in an order. | Topic: OmsMsgTopic | order.undopreprocesspayment | FALSE | PreProcessPayment |
| 16 | Update Shipment | This event will be triggered when shipment status is updated. | Topic: OmsMsgTopic | order.updateshipment | FALSE | OrderDelegate |
| 17 | Create Exchange Order | This event is triggered when an exchange order is created. | Topic:ecomm | order.exchange | FALSE | Notification |
| 18 | Create Replace Order | This event is triggered when a replace order is created. | Topic:ecomm | order.replace | FALSE | Notification |
List of Fat Events
When order patch is done to change the order status, the fat events override the existing thin events. Below are the properties that are processed for the fat events:
| PROPERTY | Value | DESCRIPTION |
|---|---|---|
enableExternalEvent | True | Sends the event to the external target system. |
enableFatEvent | True | Enables the fat event. |
externalFatEventClass | Indicates the plugin class name that is used to modify and add the event payload data. | |
eventbridge | Indicates the AWS service used to send the event from source to target. | |
region | Indicates the AWS eventbridge region. | |
eventBusName | Indicates the event bridge bus name. |
Note:
- For information on the event payload, refer to Order Event Payload With and Without Fat Event.
- For information on the plugin that is used to send the fat event, refer to marketplaces-oms-plugin.
Payload Models
Below are the payloads for the Order microservice events.
InventoryBulkTransaction
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
binItems.binName | String | Indicates the name of the bin in Inventory. | bin1 |
binItems.skuId | String | Indicates the SKU ID of the order. | sku1 |
binItems.transaction.id | String | Indicates the ID of the transaction. | 1 |
binItems.transaction.type | Integer | Indicates the type of the transaction. The possible transaction types are: NONE (0), ADD (1), REMOVE (2), or TRANSFER (3). | 1 |
binItems.transaction.atpQty | Integer | Indicates the available quantity to purchase. | 3 |
binItems.transaction.notes | String | Specifies the information about the transaction. | This is the bin which contains shoes |
allOrNone | Boolean | Indicates whether the transaction type is All or None. | TRUE |
PromotionBulkTransaction
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
id | String | Indicates the ID of the order. | Order1 |
type | String | Indicates the type of the transaction whether it is ASSIGN or BLOCK. | BLOCK |
promoCodesInfo[].confirmationCode | String | Indicates the confirmation code, which is to be checked. | confirm1 |
promoCodesInfo[].promoCode | String | Indicates the promo code, which is used. | FLAT50 |
PaymentBulkTransaction
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
transactions[].value | long | Indicates the value of the transaction. | 1000 |
transactions[].type | String | Indicates the type of transaction, such as AUTH, CANCELAUTH, CHARGE, and REFUND. | REFUND |
transactions[].properties[].name | String | Indicates the custom property of the transaction. | It is a charge transaction |
transactions[].properties[].value | String | Indicates the value of the property transaction. | 1000 |
transactions[].paymentItemId | String | Indicates the ID of the payment item. | p1 |
transactions[].id | String | Indicates the ID of the transaction. | p1 |
transactions[].status | String | Indicates the status of the transaction. | CHARGE |
transactions[].responseCode | String | Indicates the response code of the transaction. | 200 |
transactions[].responseMessage | String | Indicates the response message of the transaction. | Success |
transactions[].createdBy | String | Indicates the user, who has created the transaction. | p1 |
transactions[].createdTime | long | Indicates the created timestamp (in milliseconds) of the transaction. | 1548328965 |
allOrNone | boolean | Indicates whether all the transactions has to be processed or not. | TRUE |
OrderDelegate
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the collection ID of the order, which is created, canceled, or deleted. | 1 |
locale | string | Indicates the locale of the message. | en-US |
orderId | String | Indicates the ID of the order. | Order1 |
orderPatchDTO.status | String | Indicates the status of the transaction. | CHARGE |
orderPatchDTO.reasoncode | String | Indicates the reason code of the operation made on the order. | 200 |
orderPatchDTO.reasonmessage | String | Indicates the reason message of the operation made on the order. | Success |
orderPatchDTO.properties[].name | String | Indicates the custom property of the order. | It is a charge transaction |
orderPatchDTO.properties[].value | String | Indicates the value of the order property. | 1000 |
orderPatchDTO.orderItemPatchDTO[].id | String | Indicates the item ID of the order. | OI1 |
orderPatchDTO.orderItemPatchDTO[].status | String | Indicates the status of the item. | Shipped |
orderPatchDTO.orderItemPatchDTO[].reasoncode | String | Indicates the reason code of the operation made on the order. | 200 |
orderPatchDTO.orderItemPatchDTO[].reasonmessage | String | Indicates the reason message of the operation made on the order. | Success |
orderPatchDTO.orderItemPatchDTO[].properties[].name | String | Indicates the custom property of the item. | It is a charge transaction |
orderPatchDTO.orderItemPatchDTO[].properties[].value | String | Indicates the value of the item property. | 1000 |
orderPatchDTO.orderItemPatchDTO[].otherproperties[].name | String | Indicates the additional property of the item. | It is a charge transaction |
orderPatchDTO.orderItemPatchDTO[].otherproperties[].value | String | Indicates the value of the item property. | 1000 |
orderPatchDTO.orderItemPatchDTO[].quantity | Integer | Indicates the quantity of the item. | 3 |
orderPatchDTO.orderItemPatchDTO[].returnable | Boolean | Indicates whether the item can be returned or not. | TRUE |
orderPatchDTO.UserPatchDTO.userid | String | Indicates the ID of the user. | USER1 |
orderPatchDTO.userTrackingDTO.firstname | String | Indicates the first name of the user. | john |
orderPatchDTO.userTrackingDTO.lastname | String | Indicates the last name of the user. | smith |
orderPatchDTO.userTrackingDTO.zip | String | Indicates the zip code of the user address. | 11111 |
orderPatchDTO.userTrackingDTO.guestuser | boolean | Indicates whether the user is guest user or not. | FALSE |
orderPatchDTO.userTrackingDTO.guestuserid | String | Contains the ID of the guest user. | guest1 |
orderPatchDTO.userTrackingDTO.ip | String | Indicates the IP address of the user. | 1.1.1.1 |
orderPatchDTO.userTrackingDTO.accountid | String | Indicates the account ID of the user. | account1 |
orderPatchDTO.userTrackingDTO.userid | String | Indicates the ID of the user. | USER1 |
orderPatchDTO.userTrackingDTO.usercontact.phone | String | Indicates the phone number of the user. | 91000000000 |
orderPatchDTO.userTrackingDTO.usercontact.email | String | Indicates the email ID of the user. | someone@example.com |
orderPatchDTO.userTrackingDTO.usercontact.preferredcontact | String | Indicates the preferred contact of the user. | EMAIL, TEXT, PHONE |
orderPatchDTO.otherproperties | List | Indicates the custom properties of the order. | shipmentid: “id1234” |
paymentTrans[].value | long | Indicates the value of the transaction. | 1000 |
paymentTrans[].type | String | Indicates the type of transaction – AUTH, CANCELAUTH, CHARGE, and REFUND. | REFUND |
paymentTrans[].properties[].name | String | Indicates the custom property of the transaction. | It is a charge transaction |
paymentTrans[].properties[].value | String | Indicates the value of the transaction property. | 1000 |
paymentTrans[].paymentItemId | String | Indicates the ID of the payment item. | p1 |
paymentTrans[].id | String | Indicates the ID of the transaction. | p1 |
paymentTrans[].status | String | Indicates the status of the transaction. | CHARGE |
paymentTrans[].responseCode | String | Indicates the response code of the transaction. | 200 |
paymentTrans[].responseMessage | String | Indicates the response message of the transaction. | Success |
paymentTrans[].createdBy | String | Indicates the user, who has created the transaction. | p1 |
paymentTrans[].createdTime | long | Indicates the created timestamp (in milliseconds) of the transaction. | 1548328965 |
CheckFraud
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
orderid | String | Indicates the unique ID of the order, which is created, canceled, or deleted. | Order1 |
status | String | Indicates the status of the order. | Shipped |
fraud | boolean | Indicates whether the transaction is fraud or not. | FALSE |
PreProcessInventory
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
orderid | String | Indicates the unique ID of the order, which is created, canceled, or deleted. | Order1 |
collectionId | long | Indicates the collection ID of the order, which is created, canceled, or deleted. | 1 |
inventoryCollectionId | long | Indicates the collection ID of the inventory associated with the current order. | 1 |
binItems[].binName | String | Indicates the name of the bin in the inventory. | bin1 |
binItems[].skuId | String | Indicates the SKU ID of the order. | sku1 |
binItems[].transaction.id | String | Indicates the ID of the transaction. | 1 |
binItems[].transaction.type | Integer | Indicates the type of transaction. The possible transaction types are: NONE (0), ADD (1), REMOVE (2), TRANSFER (3). | 1 |
binItems[].transaction.atpQty | Integer | Indicates the available quantity to purchase. | 3 |
binItems[].transaction.notes | String | Indicates the notes added to the transaction. | This is the bin which contains shoes |
PreProcessPayment
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
orderid | String | Indicates the unique ID of the order, which is created, canceled, or deleted. | Order1 |
collectionId | long | Indicates the collection ID of the order, which is created, canceled, or deleted. | 1 |
paymentCollectionId | long | Indicates the collection ID of the payment associated with the current order. | 1 |
allOrNone | Boolean | Indicates whether the transaction type is All or None. | TRUE |
transactions[].value | long | Indicates the value of the transaction. | 1000 |
transactions[].type | String | Indicates the type of the transaction. The possible transaction types are: AUTH, CANCELAUTH, CHARGE, and REFUND. | REFUND |
transactions[].properties[].name | String | Indicates the custom property of the transaction. | It is a charge transaction |
transactions[].properties[].value | String | Indicates the value of the transaction property. | 1000 |
transactions[].paymentItemId | String | Indicates the ID of the payment item. | p1 |
transactions[].id | String | Indicates the ID of the transaction. | p1 |
transactions[].status | String | Indicates the status of the transaction. | CHARGE |
transactions[].responseCode | String | Indicates the response code of the transaction. | 200 |
transactions[].responseMessage | String | Indicates the response message of the transaction. | Success |
transactions[].createdBy | String | Indicates the user, who has created the transaction. | p1 |
transactions[].createdTime | long | Indicates the created timestamp (in milliseconds) when the transaction is created. | 1548328965 |
PreProcessPromotion
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
orderid | String | Indicates the unique ID of the order, which is created, canceled, or deleted. | Order1 |
collectionId | long | Indicates the collection ID of the order, which is created, canceled, or deleted. | 1 |
promotionCollectionId | long | Indicates the collection ID of the promotion associated with the current order. | 1 |
promotionList[].confirmationCode | String | Indicates the confirmation code, which is to be checked. | confirm1 |
promotionList[].promoCode | String | Indicates the promo code, which is used. | FLAT50 |
Notification
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
id | Long | Indicates the unique ID of the notification. | 1000 |
createdtime | Long | Indicates the created time of the notification in milliseconds. | 1516789034567 |
createdby | String | Contains the ID of the user, who has created the notification. | 123 |
status | String | Specifies the status of the notification. | Cancelled |
description | String | Indicates the description of the notification. | Order/ Order item is canceled. |
type | String | Indicates the type of the notification. The possible values are: ORDER_CREATED ORDER_DELETED, ORDER_CANCELLED, ORDER_RETURN_SUBMIT, and ORDER_RETURN_ACCEPTED. | ORDER_RETURN_SUBMIT |
itemId | String | Indicates the ID of the item to be canceled. | SHOE |
paymentitemid | String | Indicates the ID of the payment item, which is associated with the item to be canceled. | 567 |
properties | HashMap | Contains the custom properties of the notification. |
Event Payload With and Without Fat Event
| Event Name | Payload |
|---|---|
Without Fat Event | { |
With Fat Event | { |
Revision History
2024-05-22 | SW – Added the external events for Release 8.17.4
2023-06-13 | SW – Updated the content for 8.14 release.
2020-01-14 | AN– Updated content for February 2020 release.
2019-10-31 | MA – Updated content for November 2019 release.
2019-05-16 | AN – Updated to a new table tool.
2019-05-06 | PLK – Minor copyedits.
2019-04-11 | MA – Content updated for April 2019 release.
2019-01-23 | PLK – Content uploaded.
