Skip to main content

AsyncAPI for order service 0.0.1 documentation

Published Messages (orderProcessing)

The service publishes one of these messages below.

orderCreated

Order status will be INIT after created. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderCancelled

Order status will be CLOSED after cancelled. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderFulfilled

Order status will be FULFILLED fulfilled. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderFulfillFailed

Order status will be FULFILL_FAILED fulfilled. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderCharged

Order status will be CHARGED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderRefunded

Order status will be REFUNDED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderRefundRequested

Order status will be REFUNDING/REFUNDED/REFUND_FAILED after refund requested. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderRefundFailed

Order status will be REFUND_FAILED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderChargeback

Order status will be CHARGEBACK. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderChargebackReversed

Order status will be CHARGEBACK_REVERSED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderExpired

Order status will be CLOSED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

orderStatusUpdated

Order status will be target status after updated. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
orderorder-

Schemas

discountCodeInfo

NameTypeDescription
codestring-
campaignIdstring-
campaignNamestring-
deductioninteger-
discountConfigobject-

discountConfig

NameTypeDescription
currencyNamespacestring-
currencyCodestring-
discountTypestring-
discountPercentageinteger-
discountAmountinteger-
stackableboolean-
restrictTypestring-
itemsarray<object>-
categoriesarray<object>-

discountConfig.items[number]

NameTypeDescription
itemIdstring-
itemNamestring-

discountConfig.categories[number]

NameTypeDescription
categoryPathstring-
includeSubCategoriesboolean-

order

NameTypeDescription
orderNostringOrder number
paymentOrderNostringPayment order number
namespacestringOrder namespace
userIdstringUser id
itemIdstringItem id
itemNamestringItem Name
sandboxbooleanisSandbox, indicate if order is sandbox
quantityinteger (int32)Item quantity
priceinteger (int32)Order price
discountedPriceinteger (int32)Order discounted price
paymentProviderstringPayment provider
currencyobjectOrder currency info
regionstring-
languagestring-
statusstringOrder status
statusReasonstringOrder status reason
previousStatusstringOrder status before action
orderBundleItemInfosarray<object>flexible bundle item price details for order, included ownership info
deductioninteger (int32)Total of deduction
deductionDetailsarray<object>Deduction details, include every discount code actual deducted value

currency

NameTypeDescription
currencyCodestringcurrency code
currencySymbolstringcurrency symbol
currencyTypestringcurrency type
namespacestringnamespace
decimalsinteger (int32)decimals

orderBundleItemInfos[number]

NameTypeDescription
priceintegercurrent available price per item
discountedPriceintegercurrent available discounted price per item
itemNamestringitem name
itemIdstringitem id
itemSkustringitem sku
quantityintegerquantity
purchasedbooleanwhether this item has been purchased in this order

deductionDetails[number]

NameTypeDescription
deductionTypestringdeduction type
discountCodeDeductionDetailobjectdiscount code info

deductionDetails[number].discountCodeDeductionDetail

NameTypeDescription
totalDeductioninteger-
totalPercentageDeductioninteger-
totalAmountDeductioninteger-
discountPercentageCodesarray<discountCodeInfo>-
discountAmountCodesarray<discountCodeInfo>-

event

NameTypeDescription
idstringevent id
versioninteger-
namestringevent name
namespacestringevent namespace
parentNamespacestring-
timestampstring (date-time)-
clientIdstringclient id
userIdstringthe operator id
traceIdstringtrace id
sessionIdstringsession id