AsyncAPI for order service 0.0.1 documentation

• Specification ID: urn:net:accelbyte:platform:order
• Protobuf File Spec: order.proto
• Default content type: application/json

Table of Contents

• Operations
  • PUB orderProcessing

Operations

PUB orderProcessing Operation

Accepts one of the following messages:

Message orderCreated

order status will be INIT after created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.order	object	-	-	-	additional properties are allowed
payload.order.orderNo	string	Order number	-	-	-
payload.order.paymentOrderNo	string	Payment order number	-	-	-
payload.order.namespace	string	Order namespace	-	-	-
payload.order.userId	string	User id	-	-	-
payload.order.itemId	string	Item id	-	-	-
payload.order.itemName	string	Item Name	-	-	-
payload.order.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.order.quantity	integer	Item quantity	-	format (int32)	-
payload.order.price	integer	Order price	-	format (int32)	-
payload.order.discountedPrice	integer	Order discounted price	-	format (int32)	-
payload.order.paymentProvider	string	Payment provider	-	-	-
payload.order.currency	object	Order currency info	-	-	additional properties are allowed
payload.order.currency.currencyCode	string	currency code	-	-	-
payload.order.currency.currencySymbol	string	currency symbol	-	-	-
payload.order.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.order.currency.namespace	string	namespace	-	-	-
payload.order.currency.decimals	integer	decimals	-	format (int32)	-
payload.order.region	string	-	-	-	-
payload.order.language	string	-	-	-	-
payload.order.status	string	Order status	-	-	-
payload.order.statusReason	string	Order status reason	-	-	-
payload.order.previousStatus	string	Order status before action	-	-	-
payload.order.orderBundleItemInfos	array<object>	flexible bundle item price details for order, included ownership info	-	-	-
payload.order.orderBundleItemInfos.price	integer	current available price per item	-	-	-
payload.order.orderBundleItemInfos.discountedPrice	integer	current available discounted price per item	-	-	-
payload.order.orderBundleItemInfos.itemName	string	item name	-	-	-
payload.order.orderBundleItemInfos.itemId	string	item id	-	-	-
payload.order.orderBundleItemInfos.itemSku	string	item sku	-	-	-
payload.order.orderBundleItemInfos.quantity	integer	quantity	-	-	-
payload.order.orderBundleItemInfos.purchased	boolean	whether this item has been purchased in this order	-	-	-
payload.order.deduction	integer	Total of deduction	-	format (int32)	-
payload.order.deductionDetails	array<object>	Deduction details, include every discount code actual deducted value	-	-	-
payload.order.deductionDetails.deductionType	string	deduction type	allowed ("DISCOUNT_CODE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail	object	discount code info	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.totalDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalPercentageDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.totalAmountDeduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountPercentageCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.code	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.campaignName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.deduction	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig	object	-	-	-	additional properties are allowed
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyNamespace	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.currencyCode	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountType	string	-	allowed ("AMOUNT", "PERCENTAGE")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountPercentage	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.discountAmount	integer	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.stackable	boolean	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.restrictType	string	-	allowed ("NONE", "ITEMS_AND_CATEGORIES")	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemId	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.items.itemName	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories	array<object>	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.categoryPath	string	-	-	-	-
payload.order.deductionDetails.discountCodeDeductionDetail.discountAmountCodes.discountConfig.categories.includeSubCategories	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session 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"
}