Last updated on October 14, 2025
AsyncAPI for order service 0.0.1 documentation
- Protobuf File Spec: ecommerce.proto
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
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
}
]
}
}
]
}
}
],
"actualPaid": 0
},
"timestamp": "2019-08-24T14:15:22Z"
},
"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
| Name | Type | Description |
|---|---|---|
| order | order | - |
| timestamp | string (date-time) | - |
Schemas
discountCodeInfo
| Name | Type | Description |
|---|---|---|
| code | string | - |
| campaignId | string | - |
| campaignName | string | - |
| deduction | integer | - |
| discountConfig | object | - |
discountConfig
| Name | Type | Description |
|---|---|---|
| currencyNamespace | string | - |
| currencyCode | string | - |
| discountType | string | - |
| discountPercentage | integer | - |
| discountAmount | integer | - |
| stackable | boolean | - |
| restrictType | string | - |
| items | array<object> | - |
| categories | array<object> | - |
discountConfig.items[number]
| Name | Type | Description |
|---|---|---|
| itemId | string | - |
| itemName | string | - |
discountConfig.categories[number]
| Name | Type | Description |
|---|---|---|
| categoryPath | string | - |
| includeSubCategories | boolean | - |
order
| Name | Type | Description |
|---|---|---|
| orderNo | string | Order number |
| paymentOrderNo | string | Payment order number |
| namespace | string | Order namespace |
| userId | string | User id |
| itemId | string | Item id |
| itemName | string | Item Name |
| sandbox | boolean | isSandbox, indicate if order is sandbox |
| quantity | integer (int32) | Item quantity |
| price | integer (int32) | Order price |
| discountedPrice | integer (int32) | Order discounted price |
| paymentProvider | string | Payment provider |
| currency | object | Order currency info |
| region | string | - |
| language | string | - |
| status | string | Order status |
| statusReason | string | Order status reason |
| previousStatus | string | Order status before action |
| orderBundleItemInfos | array<object> | flexible bundle item price details for order, included ownership info |
| deduction | integer (int32) | Total of deduction |
| deductionDetails | array<object> | Deduction details, include every discount code actual deducted value |
| actualPaid | integer (int32) | Final paid price of the order |
currency
| Name | Type | Description |
|---|---|---|
| currencyCode | string | currency code |
| currencySymbol | string | currency symbol |
| currencyType | string | currency type |
| namespace | string | namespace |
| decimals | integer (int32) | decimals |
orderBundleItemInfos[number]
| Name | Type | Description |
|---|---|---|
| price | integer | current available price per item |
| discountedPrice | integer | current available discounted price per item |
| itemName | string | item name |
| itemId | string | item id |
| itemSku | string | item sku |
| quantity | integer | quantity |
| purchased | boolean | whether this item has been purchased in this order |
deductionDetails[number]
| Name | Type | Description |
|---|---|---|
| deductionType | string | deduction type |
| discountCodeDeductionDetail | object | discount code info |
deductionDetails[number].discountCodeDeductionDetail
| Name | Type | Description |
|---|---|---|
| totalDeduction | integer | - |
| totalPercentageDeduction | integer | - |
| totalAmountDeduction | integer | - |
| discountPercentageCodes | array of discountCodeInfo | - |
| discountAmountCodes | array of discountCodeInfo | - |
event
| Name | Type | Description |
|---|---|---|
| id | string | event id |
| version | integer | - |
| name | string | event name |
| namespace | string | event namespace |
| parentNamespace | string | - |
| timestamp | string (date-time) | - |
| clientId | string | client id |
| userId | string | the operator id |
| traceId | string | trace id |
| sessionId | string | session id |