Skip to main content

AsyncAPI for fulfillment service 0.0.1 documentation

Published Messages (fulfillment)

The service publishes one of these messages below.

fulfillmentCompleted

Message is sent when fulfillment is completed. Contains fields from and the following payload.

Example value
{
"payload": {
"fulfillment": {
"userId": "string",
"orderNo": "string",
"code": "string",
"source": "PURCHASE",
"fulfillItems": [
{
"itemId": "string",
"itemName": "string",
"quantity": 0,
"storeId": "string",
"itemSku": "string",
"extraSubscriptionDays": 0,
"itemType": "string"
}
],
"grantedItemIds": [
"string"
],
"entitlementSummaries": [
{
"id": "string",
"namespace": "string",
"userId": "string",
"clazz": "APP",
"type": "DURABLE",
"stackable": true,
"stackedUseCount": 0,
"storeId": "string",
"itemId": "string",
"grantedCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}
],
"creditSummaries": [
{
"walletId": "string",
"namespace": "string",
"userId": "string",
"amount": 0
}
],
"status": "string",
"fulfillmentError": {
"httpStatus": 0,
"code": 0,
"message": "string"
},
"metadata": {}
}
},
"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
fulfillmentobject-
payload.fulfillment
NameTypeDescription
userIdstringuserId
orderNostringorderNo
codestringredeemed code
sourcestring-
fulfillItemsarray<object>items should do fulfillment
grantedItemIdsarrayitem ids already granted
entitlementSummariesarray<object>entitlement granted
creditSummariesarray<object>credit granted
statusstringfulfillment status
fulfillmentErrorobject-
metadataobject-
payload.fulfillment.fulfillItems[number]
NameTypeDescription
itemIdstringitem id
itemNamestringitem name
quantityinteger (int32)item quantity
storeIdstringstore id
itemSkustringitem sku
extraSubscriptionDaysinteger (int32)extra subscription days
itemTypestringitem type
payload.fulfillment.entitlementSummaries[number]
NameTypeDescription
idstringentitlement id
namespacestringentitlement namespace
userIdstringuser id
clazzstringentitlement clazz
typestringentitlement type
stackablebooleana flag indicates whether the consumable entitlement is stackable
stackedUseCountinteger (int32)consumable entitlement stacked use count
storeIdstringstore id
itemIdstringitem id
grantedCodestringgranted code
createdAtstring (date-time)-
updatedAtstring (date-time)-
startDatestring (date-time)time when the entitlement becomes active
endDatestring (date-time)time when the entitlement becomes expired
payload.fulfillment.creditSummaries[number]
NameTypeDescription
walletIdstringwallet id
namespacestringnamespace
userIdstringuser id
amountinteger (int64)amount to be paid
payload.fulfillment.fulfillmentError
NameTypeDescription
httpStatusinteger (int32)http status
codeinteger (int32)error code
messagestringerror message
payload.fulfillment.metadata

This is a free-form object.

Schemas