AsyncAPI for fulfillment service 0.0.1 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

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

Table of Contents

• Operations
  • PUB fulfillment

Operations

PUB fulfillment Operation

Message fulfillmentCompleted

message is sent when fulfillment is completed

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.fulfillment	object	-	-	-	additional properties are allowed
payload.fulfillment.userId	string	userId	-	-	-
payload.fulfillment.orderNo	string	orderNo	-	-	-
payload.fulfillment.code	string	redeemed code	-	-	-
payload.fulfillment.source	string	-	allowed ("PURCHASE", "IAP", "PROMOTION", "ACHIEVEMENT", "REFERRAL_BONUS", "REDEEM_CODE", "REWARD", "GIFT", "DLC", "OTHER")	-	-
payload.fulfillment.fulfillItems	array<object>	items should do fulfillment	-	-	-
payload.fulfillment.fulfillItems.itemId	string	item id	-	-	-
payload.fulfillment.fulfillItems.itemName	string	item name	-	-	-
payload.fulfillment.fulfillItems.quantity	integer	item quantity	-	format (int32)	-
payload.fulfillment.fulfillItems.storeId	string	store id	-	-	-
payload.fulfillment.fulfillItems.itemSku	string	item sku	-	-	-
payload.fulfillment.fulfillItems.extraSubscriptionDays	integer	extra subscription days	-	format (int32)	-
payload.fulfillment.fulfillItems.itemType	string	item type	-	-	-
payload.fulfillment.grantedItemIds	array<string>	item ids already granted	-	-	-
payload.fulfillment.grantedItemIds (single item)	string	-	-	-	-
payload.fulfillment.entitlementSummaries	array<object>	entitlement granted	-	-	-
payload.fulfillment.entitlementSummaries.id	string	entitlement id	-	-	-
payload.fulfillment.entitlementSummaries.namespace	string	entitlement namespace	-	-	-
payload.fulfillment.entitlementSummaries.userId	string	user id	-	-	-
payload.fulfillment.entitlementSummaries.clazz	string	entitlement clazz	allowed ("APP", "ENTITLEMENT", "CODE", "SUBSCRIPTION", "MEDIA", "OPTIONBOX", "LOOTBOX")	-	-
payload.fulfillment.entitlementSummaries.type	string	entitlement type	allowed ("DURABLE", "CONSUMABLE")	-	-
payload.fulfillment.entitlementSummaries.stackable	boolean	a flag indicates whether the consumable entitlement is stackable	-	-	-
payload.fulfillment.entitlementSummaries.stackedUseCount	integer	consumable entitlement stacked use count	-	format (int32)	-
payload.fulfillment.entitlementSummaries.storeId	string	store id	-	-	-
payload.fulfillment.entitlementSummaries.itemId	string	item id	-	-	-
payload.fulfillment.entitlementSummaries.grantedCode	string	granted code	-	-	-
payload.fulfillment.entitlementSummaries.createdAt	string	-	-	format (date-time)	-
payload.fulfillment.entitlementSummaries.updatedAt	string	-	-	format (date-time)	-
payload.fulfillment.entitlementSummaries.startDate	string	time when the entitlement becomes active	-	format (date-time)	-
payload.fulfillment.entitlementSummaries.endDate	string	time when the entitlement becomes expired	-	format (date-time)	-
payload.fulfillment.creditSummaries	array<object>	credit granted	-	-	-
payload.fulfillment.creditSummaries.walletId	string	wallet id	-	-	-
payload.fulfillment.creditSummaries.namespace	string	namespace	-	-	-
payload.fulfillment.creditSummaries.userId	string	user id	-	-	-
payload.fulfillment.creditSummaries.amount	integer	amount to be paid	-	format (int64)	-
payload.fulfillment.status	string	fulfillment status	-	-	-
payload.fulfillment.fulfillmentError	object	-	-	-	additional properties are allowed
payload.fulfillment.fulfillmentError.httpStatus	integer	http status	-	format (int32)	-
payload.fulfillment.fulfillmentError.code	integer	error code	-	format (int32)	-
payload.fulfillment.fulfillmentError.message	string	error message	-	-	-
payload.fulfillment.metadata	object	-	-	-	additional properties are allowed
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "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"
}