Skip to main content

AsyncAPI for order service 0.0.1 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Table of Contents

Operations

PUB orderProcessing Operation

Accepts one of the following messages:

Message orderCreated

order status will be INIT after created

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderCancelled

order status will be CLOSED after cancelled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderFulfilled

order status will be FULFILLED fulfilled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderFulfillFailed

order status will be FULFILL_FAILED fulfilled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderCharged

order status will be CHARGED

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderRefunded

order status will be REFUNDED

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderRefundRequested

order status will be REFUNDING/REFUNDED/REFUND_FAILED after refund requested

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderRefundFailed

order status will be REFUND_FAILED

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderChargeback

order status will be CHARGEBACK

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderChargebackReversed

order status will be CHARGEBACK_REVERSED

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderExpired

order status will be CLOSED

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message orderStatusUpdated

order status will be target status after updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.orderobject---additional properties are allowed
payload.order.orderNostringOrder number---
payload.order.paymentOrderNostringPayment order number---
payload.order.namespacestringOrder namespace---
payload.order.userIdstringUser id---
payload.order.itemIdstringItem id---
payload.order.itemNamestringItem Name---
payload.order.sandboxbooleanisSandbox, indicate if order is sandbox---
payload.order.quantityintegerItem quantity-format (int32)-
payload.order.priceintegerOrder price-format (int32)-
payload.order.discountedPriceintegerOrder discounted price-format (int32)-
payload.order.paymentProviderstringPayment provider---
payload.order.currencyobjectOrder currency info--additional properties are allowed
payload.order.currency.currencyCodestringcurrency code---
payload.order.currency.currencySymbolstringcurrency symbol---
payload.order.currency.currencyTypestringcurrency typeallowed ("REAL", "VIRTUAL")--
payload.order.currency.namespacestringnamespace---
payload.order.currency.decimalsintegerdecimals-format (int32)-
payload.order.regionstring----
payload.order.languagestring----
payload.order.statusstringOrder status---
payload.order.statusReasonstringOrder status reason---
payload.order.previousStatusstringOrder status before action---
payload.order.orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info---
payload.order.orderBundleItemInfos.priceintegercurrent available price per item---
payload.order.orderBundleItemInfos.discountedPriceintegercurrent available discounted price per item---
payload.order.orderBundleItemInfos.itemNamestringitem name---
payload.order.orderBundleItemInfos.itemIdstringitem id---
payload.order.orderBundleItemInfos.itemSkustringitem sku---
payload.order.orderBundleItemInfos.quantityintegerquantity---
payload.order.orderBundleItemInfos.purchasedbooleanwhether this item has been purchased in this order---
payload.order.deductionintegerTotal of deduction-format (int32)-
payload.order.deductionDetailsarray<object>Deduction details, include every discount code actual deducted value---
payload.order.deductionDetails.deductionTypestringdeduction typeallowed ("DISCOUNT_CODE")--
payload.order.deductionDetails.discountCodeDeductionDetailobjectdiscount code info--additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategoriesboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.codestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deductioninteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfigobject---additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespacestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCodestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountTypestring-allowed ("AMOUNT", "PERCENTAGE")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentageinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmountinteger----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackableboolean----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictTypestring-allowed ("NONE", "ITEMS_AND_CATEGORIES")--
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.itemsarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemIdstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemNamestring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categoriesarray<object>----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPathstring----
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategoriesboolean----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"order": {
"orderNo": "string",
"paymentOrderNo": "string",
"namespace": "string",
"userId": "string",
"itemId": "string",
"itemName": "string",
"sandbox": true,
"quantity": 0,
"price": 0,
"discountedPrice": 0,
"paymentProvider": "string",
"currency": {
"currencyCode": "string",
"currencySymbol": "string",
"currencyType": "REAL",
"namespace": "string",
"decimals": 0
},
"region": "string",
"language": "string",
"status": "string",
"statusReason": "string",
"previousStatus": "string",
"orderBundleItemInfos": [
{
"price": 0,
"discountedPrice": 0,
"itemName": "string",
"itemId": "string",
"itemSku": "string",
"quantity": 0,
"purchased": true
}
],
"deduction": 0,
"deductionDetails": [
{
"deductionType": "DISCOUNT_CODE",
"discountCodeDeductionDetail": {
"totalDeduction": 0,
"totalPercentageDeduction": 0,
"totalAmountDeduction": 0,
"discountPercentageCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
],
"discountAmountCodes": [
{
"code": "string",
"campaignId": "string",
"campaignName": "string",
"deduction": 0,
"discountConfig": {
"currencyNamespace": "string",
"currencyCode": "string",
"discountType": "AMOUNT",
"discountPercentage": 0,
"discountAmount": 0,
"stackable": true,
"restrictType": "NONE",
"items": [
{
"itemId": "string",
"itemName": "string"
}
],
"categories": [
{
"categoryPath": "string",
"includeSubCategories": true
}
]
}
}
]
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}