AsyncAPI for order service 0.0.1 documentation

Specification ID: urn:net:accelbyte:platform:order
Default content type: application/json

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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "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<any>	flexible bundle item price details for order, included ownership info	-	-	-
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	-	-	-

{
  "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": []
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

AsyncAPI for order service 0.0.1 documentation

Table of Contents​

Operations​

PUB orderProcessing Operation​

Message orderCreated​

Payload​

Message orderCancelled​

Payload​

Message orderFulfilled​

Payload​

Message orderFulfillFailed​

Payload​

Message orderCharged​

Payload​

Message orderRefunded​

Payload​

Message orderRefundRequested​

Payload​

Message orderRefundFailed​

Payload​

Message orderChargeback​

Payload​

Message orderChargebackReversed​

Payload​

Message orderExpired​

Payload​

Message orderStatusUpdated​

Payload​

Table of Contents

Operations

PUB `orderProcessing` Operation

Message `orderCreated`

Payload

Message `orderCancelled`

Payload

Message `orderFulfilled`

Payload

Message `orderFulfillFailed`

Payload

Message `orderCharged`

Payload

Message `orderRefunded`

Payload

Message `orderRefundRequested`

Payload

Message `orderRefundFailed`

Payload

Message `orderChargeback`

Payload

Message `orderChargebackReversed`

Payload

Message `orderExpired`

Payload

Message `orderStatusUpdated`

Payload