Skip to main content

AsyncAPI for catalog 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.

Table of Contents

Operations

PUB catalogManagement Operation

Accepts one of the following messages:

Message storeCreated

message is sent when store is created

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeobject---additional properties are allowed
payload.store.storeIdstringStore id---
payload.store.namespacestringThe namespace---
payload.store.titlestringStore title---
payload.store.descriptionstringStore description---
payload.store.publishedbooleanIf Store is published---
payload.store.supportedLanguagesarray<string>Store supported language---
payload.store.supportedLanguages (single item)string----
payload.store.supportedRegionsarray<string>Store supported regions---
payload.store.supportedRegions (single item)string----
payload.store.defaultRegionstringDefault region---
payload.store.defaultLanguagestringDefault language---
payload.store.publishedTimestringStore published time-format (date-time)-
payload.store.createdAtstring--format (date-time)-
payload.store.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"store": {
"storeId": "string",
"namespace": "string",
"title": "string",
"description": "string",
"published": true,
"supportedLanguages": [
"string"
],
"supportedRegions": [
"string"
],
"defaultRegion": "string",
"defaultLanguage": "string",
"publishedTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message storeUpdated

message is sent when store is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeobject---additional properties are allowed
payload.store.storeIdstringStore id---
payload.store.namespacestringThe namespace---
payload.store.titlestringStore title---
payload.store.descriptionstringStore description---
payload.store.publishedbooleanIf Store is published---
payload.store.supportedLanguagesarray<string>Store supported language---
payload.store.supportedLanguages (single item)string----
payload.store.supportedRegionsarray<string>Store supported regions---
payload.store.supportedRegions (single item)string----
payload.store.defaultRegionstringDefault region---
payload.store.defaultLanguagestringDefault language---
payload.store.publishedTimestringStore published time-format (date-time)-
payload.store.createdAtstring--format (date-time)-
payload.store.updatedAtstring--format (date-time)-
payload.oldStoreobject---additional properties are allowed
payload.oldStore.storeIdstringStore id---
payload.oldStore.namespacestringThe namespace---
payload.oldStore.titlestringStore title---
payload.oldStore.descriptionstringStore description---
payload.oldStore.publishedbooleanIf Store is published---
payload.oldStore.supportedLanguagesarray<string>Store supported language---
payload.oldStore.supportedLanguages (single item)string----
payload.oldStore.supportedRegionsarray<string>Store supported regions---
payload.oldStore.supportedRegions (single item)string----
payload.oldStore.defaultRegionstringDefault region---
payload.oldStore.defaultLanguagestringDefault language---
payload.oldStore.publishedTimestringStore published time-format (date-time)-
payload.oldStore.createdAtstring--format (date-time)-
payload.oldStore.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"store": {
"storeId": "string",
"namespace": "string",
"title": "string",
"description": "string",
"published": true,
"supportedLanguages": [
"string"
],
"supportedRegions": [
"string"
],
"defaultRegion": "string",
"defaultLanguage": "string",
"publishedTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"oldStore": {
"storeId": "string",
"namespace": "string",
"title": "string",
"description": "string",
"published": true,
"supportedLanguages": [
"string"
],
"supportedRegions": [
"string"
],
"defaultRegion": "string",
"defaultLanguage": "string",
"publishedTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message storeDeleted

message is sent when store is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeobject---additional properties are allowed
payload.store.storeIdstringStore id---
payload.store.namespacestringThe namespace---
payload.store.titlestringStore title---
payload.store.descriptionstringStore description---
payload.store.publishedbooleanIf Store is published---
payload.store.supportedLanguagesarray<string>Store supported language---
payload.store.supportedLanguages (single item)string----
payload.store.supportedRegionsarray<string>Store supported regions---
payload.store.supportedRegions (single item)string----
payload.store.defaultRegionstringDefault region---
payload.store.defaultLanguagestringDefault language---
payload.store.publishedTimestringStore published time-format (date-time)-
payload.store.createdAtstring--format (date-time)-
payload.store.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"store": {
"storeId": "string",
"namespace": "string",
"title": "string",
"description": "string",
"published": true,
"supportedLanguages": [
"string"
],
"supportedRegions": [
"string"
],
"defaultRegion": "string",
"defaultLanguage": "string",
"publishedTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message storeCloned

message is sent when clone a store

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.storeCloneobject---additional properties are allowed
payload.storeClone.targetStoreIdstringthe target store id---
payload.storeClone.publishedbooleantrue if the target store is a published store---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"storeClone": {
"targetStoreId": "string",
"published": 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"
}

Message storeRollbacked

message is sent when roll back a published store to a previous version

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string"
},
"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 storeExported

message is sent when store is exported

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string"
},
"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 storeImported

message is sent when store is imported

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string"
},
"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 storePublished

message is sent when publish store

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.storePublishSchemaobject---additional properties are allowed
payload.storePublishSchema.namespacestringnamespace---
payload.storePublishSchema.storeIdstringstore id---
payload.storePublishSchema.incrementalbooleana flag indicates whether publish store incrementally---
payload.storePublishSchema.catalogChangesarray<object>----
payload.storePublishSchema.catalogChanges.storeIdstringpublished store id---
payload.storePublishSchema.catalogChanges.changeIdstringid for this change---
payload.storePublishSchema.catalogChanges.itemTypestringtype of the item---
payload.storePublishSchema.catalogChanges.itemIdstringitem id if this is a item change---
payload.storePublishSchema.catalogChanges.skustringsku of item---
payload.storePublishSchema.catalogChanges.viewIdstringview id if this is a view change---
payload.storePublishSchema.catalogChanges.sectionIdstringsection id if this is a section change---
payload.storePublishSchema.catalogChanges.categoryPathstringcategory path if there is a category change---
payload.storePublishSchema.catalogChanges.actionstringchange action---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"storePublishSchema": {
"namespace": "string",
"storeId": "string",
"incremental": true,
"catalogChanges": [
{
"storeId": "string",
"changeId": "string",
"itemType": "string",
"itemId": "string",
"sku": "string",
"viewId": "string",
"sectionId": "string",
"categoryPath": "string",
"action": "string"
}
]
}
},
"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 categoryCreated

message is sent when category is created

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstring----
payload.categoryobject---additional properties are allowed
payload.category.namespacestringCategory namespace---
payload.category.parentCategoryPathstringParent category path---
payload.category.categoryPathstringCategory path---
payload.category.isRootboolean----
payload.category.localizationDisplayNamesobjectCategory localization display name---
payload.category.localizationDisplayNames (additional properties)string----
payload.category.createdAtstring--format (date-time)-
payload.category.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"category": {
"namespace": "string",
"parentCategoryPath": "string",
"categoryPath": "string",
"isRoot": true,
"localizationDisplayNames": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message categoryUpdated

message is sent when category is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstring----
payload.categoryobject---additional properties are allowed
payload.category.namespacestringCategory namespace---
payload.category.parentCategoryPathstringParent category path---
payload.category.categoryPathstringCategory path---
payload.category.isRootboolean----
payload.category.localizationDisplayNamesobjectCategory localization display name---
payload.category.localizationDisplayNames (additional properties)string----
payload.category.createdAtstring--format (date-time)-
payload.category.updatedAtstring--format (date-time)-
payload.oldCategoryobject---additional properties are allowed
payload.oldCategory.namespacestringCategory namespace---
payload.oldCategory.parentCategoryPathstringParent category path---
payload.oldCategory.categoryPathstringCategory path---
payload.oldCategory.isRootboolean----
payload.oldCategory.localizationDisplayNamesobjectCategory localization display name---
payload.oldCategory.localizationDisplayNames (additional properties)string----
payload.oldCategory.createdAtstring--format (date-time)-
payload.oldCategory.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"category": {
"namespace": "string",
"parentCategoryPath": "string",
"categoryPath": "string",
"isRoot": true,
"localizationDisplayNames": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"oldCategory": {
"namespace": "string",
"parentCategoryPath": "string",
"categoryPath": "string",
"isRoot": true,
"localizationDisplayNames": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message categoryDeleted

message is sent when category is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.categoryobject---additional properties are allowed
payload.category.namespacestringCategory namespace---
payload.category.parentCategoryPathstringParent category path---
payload.category.categoryPathstringCategory path---
payload.category.isRootboolean----
payload.category.localizationDisplayNamesobjectCategory localization display name---
payload.category.localizationDisplayNames (additional properties)string----
payload.category.createdAtstring--format (date-time)-
payload.category.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"category": {
"namespace": "string",
"parentCategoryPath": "string",
"categoryPath": "string",
"isRoot": true,
"localizationDisplayNames": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "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"
}

Message itemCreated

message is sent when item is created

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstring----
payload.itemobject---additional properties are allowed
payload.item.itemIdstringItem id---
payload.item.appIdstringApp id---
payload.item.appTypestringApp type---
payload.item.baseAppIdstringBase app id---
payload.item.baseAppItemIdstringItem id of base app---
payload.item.namespacestringItem namespace---
payload.item.skustringSku---
payload.item.namestringName---
payload.item.entitlementTypestringEntitlement type---
payload.item.useCountintegerItem use count-format (int32)-
payload.item.stackablebooleanWhether stack the CONSUMABLE entitlement---
payload.item.categoryPathstringItem category path---
payload.item.imagesarray<object>images---
payload.item.images.asstringimage for---
payload.item.images.captionstringimage caption---
payload.item.images.heightintegerheight-format (int32)required
payload.item.images.widthintegerwidth-format (int32)required
payload.item.images.imageUrlstringimageUrl--required
payload.item.images.smallImageUrlstringsmallImageUrl--required
payload.item.thumbnailUrlstringthumbnail url---
payload.item.localizationsobjectItem localizations---
payload.item.localizations (additional properties)object---additional properties are allowed
payload.item.localizations.titlestringtitle info--required
payload.item.localizations.descriptionstringdescription info---
payload.item.localizations.longDescriptionstringlong description info---
payload.item.localizations.localExtobject----
payload.item.localizations.localExt (additional properties)object---additional properties are allowed
payload.item.statusstringItem status---
payload.item.listablebooleanwhether it is visible in Store for public user---
payload.item.purchasablebooleanwhether it can be purchased---
payload.item.sectionExclusivebooleanwhether this item is sold in section only---
payload.item.itemTypestringItem type---
payload.item.targetNamespacestringThe target namespace of a cross namespace item---
payload.item.targetCurrencyCodestringThe target currency code of coin Item---
payload.item.targetItemIdstringTarget item id if this item is mapping from game namespace---
payload.item.regionDataobjectItem region data---
payload.item.regionData (additional properties)array<object>----
payload.item.regionData.priceinteger--format (int32)required
payload.item.regionData.discountPercentageinteger--format (int32), [ 0 .. 100 ]-
payload.item.regionData.discountAmountinteger--format (int32), >= 0-
payload.item.regionData.discountedPriceinteger--format (int32)-
payload.item.regionData.currencyCodestringcurrency code--required
payload.item.regionData.currencyTypestringcurrency type--required
payload.item.regionData.currencyNamespacestringcurrency namespace--required
payload.item.regionData.purchaseAtstringPurchaseAt-format (date-time)-
payload.item.regionData.expireAtstringExpireAt-format (date-time)-
payload.item.regionData.discountPurchaseAtstringDiscount purchase date time-format (date-time)-
payload.item.regionData.discountExpireAtstringDiscount expire date time-format (date-time)-
payload.item.itemIdsarray<string>Bundle item's item ids---
payload.item.itemIds (single item)string----
payload.item.itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"---
payload.item.itemQty (additional properties)integer--format (int32)-
payload.item.tagsarray<string>Tags---
payload.item.tags (single item)string----
payload.item.featuresarray<string>Features---
payload.item.features (single item)string----
payload.item.maxCountPerUserintegerMax count per user-format (int32)-
payload.item.maxCountintegerMax count-format (int32)-
payload.item.clazzstringcustomized item clazz---
payload.item.extobjectcustomized item properties---
payload.item.ext (additional properties)object---additional properties are allowed
payload.item.boothNamestringbooth name to get tickets while it's item type is CODE---
payload.item.ticketBoothIdstringbooth id while item type is CODE---
payload.item.displayOrderintegerdisplay order-format (int32)-
payload.item.createdAtstringcreated at-format (date-time)-
payload.item.updatedAtstringupdated at-format (date-time)-
payload.item.purchaseConditionobjectpurchase condition--additional properties are allowed
payload.item.optionBoxConfigobjectoption box configurations--additional properties are allowed
payload.item.flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"item": {
"itemId": "string",
"appId": "string",
"appType": "string",
"baseAppId": "string",
"baseAppItemId": "string",
"namespace": "string",
"sku": "string",
"name": "string",
"entitlementType": "string",
"useCount": 0,
"stackable": true,
"categoryPath": "string",
"images": [
{
"as": "string",
"caption": "string",
"height": 0,
"width": 0,
"imageUrl": "string",
"smallImageUrl": "string"
}
],
"thumbnailUrl": "string",
"localizations": {
"property1": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
}
},
"status": "string",
"listable": true,
"purchasable": true,
"sectionExclusive": true,
"itemType": "string",
"targetNamespace": "string",
"targetCurrencyCode": "string",
"targetItemId": "string",
"regionData": {
"property1": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
]
},
"itemIds": [
"string"
],
"itemQty": {
"property1": 0,
"property2": 0
},
"tags": [
"string"
],
"features": [
"string"
],
"maxCountPerUser": 0,
"maxCount": 0,
"clazz": "string",
"ext": {
"property1": {},
"property2": {}
},
"boothName": "string",
"ticketBoothId": "string",
"displayOrder": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"purchaseCondition": {},
"optionBoxConfig": {},
"flexible": 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"
}

Message itemUpdated

message is sent when item is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.itemobject---additional properties are allowed
payload.item.itemIdstringItem id---
payload.item.appIdstringApp id---
payload.item.appTypestringApp type---
payload.item.baseAppIdstringBase app id---
payload.item.baseAppItemIdstringItem id of base app---
payload.item.namespacestringItem namespace---
payload.item.skustringSku---
payload.item.namestringName---
payload.item.entitlementTypestringEntitlement type---
payload.item.useCountintegerItem use count-format (int32)-
payload.item.stackablebooleanWhether stack the CONSUMABLE entitlement---
payload.item.categoryPathstringItem category path---
payload.item.imagesarray<object>images---
payload.item.images.asstringimage for---
payload.item.images.captionstringimage caption---
payload.item.images.heightintegerheight-format (int32)required
payload.item.images.widthintegerwidth-format (int32)required
payload.item.images.imageUrlstringimageUrl--required
payload.item.images.smallImageUrlstringsmallImageUrl--required
payload.item.thumbnailUrlstringthumbnail url---
payload.item.localizationsobjectItem localizations---
payload.item.localizations (additional properties)object---additional properties are allowed
payload.item.localizations.titlestringtitle info--required
payload.item.localizations.descriptionstringdescription info---
payload.item.localizations.longDescriptionstringlong description info---
payload.item.localizations.localExtobject----
payload.item.localizations.localExt (additional properties)object---additional properties are allowed
payload.item.statusstringItem status---
payload.item.listablebooleanwhether it is visible in Store for public user---
payload.item.purchasablebooleanwhether it can be purchased---
payload.item.sectionExclusivebooleanwhether this item is sold in section only---
payload.item.itemTypestringItem type---
payload.item.targetNamespacestringThe target namespace of a cross namespace item---
payload.item.targetCurrencyCodestringThe target currency code of coin Item---
payload.item.targetItemIdstringTarget item id if this item is mapping from game namespace---
payload.item.regionDataobjectItem region data---
payload.item.regionData (additional properties)array<object>----
payload.item.regionData.priceinteger--format (int32)required
payload.item.regionData.discountPercentageinteger--format (int32), [ 0 .. 100 ]-
payload.item.regionData.discountAmountinteger--format (int32), >= 0-
payload.item.regionData.discountedPriceinteger--format (int32)-
payload.item.regionData.currencyCodestringcurrency code--required
payload.item.regionData.currencyTypestringcurrency type--required
payload.item.regionData.currencyNamespacestringcurrency namespace--required
payload.item.regionData.purchaseAtstringPurchaseAt-format (date-time)-
payload.item.regionData.expireAtstringExpireAt-format (date-time)-
payload.item.regionData.discountPurchaseAtstringDiscount purchase date time-format (date-time)-
payload.item.regionData.discountExpireAtstringDiscount expire date time-format (date-time)-
payload.item.itemIdsarray<string>Bundle item's item ids---
payload.item.itemIds (single item)string----
payload.item.itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"---
payload.item.itemQty (additional properties)integer--format (int32)-
payload.item.tagsarray<string>Tags---
payload.item.tags (single item)string----
payload.item.featuresarray<string>Features---
payload.item.features (single item)string----
payload.item.maxCountPerUserintegerMax count per user-format (int32)-
payload.item.maxCountintegerMax count-format (int32)-
payload.item.clazzstringcustomized item clazz---
payload.item.extobjectcustomized item properties---
payload.item.ext (additional properties)object---additional properties are allowed
payload.item.boothNamestringbooth name to get tickets while it's item type is CODE---
payload.item.ticketBoothIdstringbooth id while item type is CODE---
payload.item.displayOrderintegerdisplay order-format (int32)-
payload.item.createdAtstringcreated at-format (date-time)-
payload.item.updatedAtstringupdated at-format (date-time)-
payload.item.purchaseConditionobjectpurchase condition--additional properties are allowed
payload.item.optionBoxConfigobjectoption box configurations--additional properties are allowed
payload.item.flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE---
payload.oldItemobject---additional properties are allowed
payload.oldItem.itemIdstringItem id---
payload.oldItem.appIdstringApp id---
payload.oldItem.appTypestringApp type---
payload.oldItem.baseAppIdstringBase app id---
payload.oldItem.baseAppItemIdstringItem id of base app---
payload.oldItem.namespacestringItem namespace---
payload.oldItem.skustringSku---
payload.oldItem.namestringName---
payload.oldItem.entitlementTypestringEntitlement type---
payload.oldItem.useCountintegerItem use count-format (int32)-
payload.oldItem.stackablebooleanWhether stack the CONSUMABLE entitlement---
payload.oldItem.categoryPathstringItem category path---
payload.oldItem.imagesarray<object>images---
payload.oldItem.images.asstringimage for---
payload.oldItem.images.captionstringimage caption---
payload.oldItem.images.heightintegerheight-format (int32)required
payload.oldItem.images.widthintegerwidth-format (int32)required
payload.oldItem.images.imageUrlstringimageUrl--required
payload.oldItem.images.smallImageUrlstringsmallImageUrl--required
payload.oldItem.thumbnailUrlstringthumbnail url---
payload.oldItem.localizationsobjectItem localizations---
payload.oldItem.localizations (additional properties)object---additional properties are allowed
payload.oldItem.localizations.titlestringtitle info--required
payload.oldItem.localizations.descriptionstringdescription info---
payload.oldItem.localizations.longDescriptionstringlong description info---
payload.oldItem.localizations.localExtobject----
payload.oldItem.localizations.localExt (additional properties)object---additional properties are allowed
payload.oldItem.statusstringItem status---
payload.oldItem.listablebooleanwhether it is visible in Store for public user---
payload.oldItem.purchasablebooleanwhether it can be purchased---
payload.oldItem.sectionExclusivebooleanwhether this item is sold in section only---
payload.oldItem.itemTypestringItem type---
payload.oldItem.targetNamespacestringThe target namespace of a cross namespace item---
payload.oldItem.targetCurrencyCodestringThe target currency code of coin Item---
payload.oldItem.targetItemIdstringTarget item id if this item is mapping from game namespace---
payload.oldItem.regionDataobjectItem region data---
payload.oldItem.regionData (additional properties)array<object>----
payload.oldItem.regionData.priceinteger--format (int32)required
payload.oldItem.regionData.discountPercentageinteger--format (int32), [ 0 .. 100 ]-
payload.oldItem.regionData.discountAmountinteger--format (int32), >= 0-
payload.oldItem.regionData.discountedPriceinteger--format (int32)-
payload.oldItem.regionData.currencyCodestringcurrency code--required
payload.oldItem.regionData.currencyTypestringcurrency type--required
payload.oldItem.regionData.currencyNamespacestringcurrency namespace--required
payload.oldItem.regionData.purchaseAtstringPurchaseAt-format (date-time)-
payload.oldItem.regionData.expireAtstringExpireAt-format (date-time)-
payload.oldItem.regionData.discountPurchaseAtstringDiscount purchase date time-format (date-time)-
payload.oldItem.regionData.discountExpireAtstringDiscount expire date time-format (date-time)-
payload.oldItem.itemIdsarray<string>Bundle item's item ids---
payload.oldItem.itemIds (single item)string----
payload.oldItem.itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"---
payload.oldItem.itemQty (additional properties)integer--format (int32)-
payload.oldItem.tagsarray<string>Tags---
payload.oldItem.tags (single item)string----
payload.oldItem.featuresarray<string>Features---
payload.oldItem.features (single item)string----
payload.oldItem.maxCountPerUserintegerMax count per user-format (int32)-
payload.oldItem.maxCountintegerMax count-format (int32)-
payload.oldItem.clazzstringcustomized item clazz---
payload.oldItem.extobjectcustomized item properties---
payload.oldItem.ext (additional properties)object---additional properties are allowed
payload.oldItem.boothNamestringbooth name to get tickets while it's item type is CODE---
payload.oldItem.ticketBoothIdstringbooth id while item type is CODE---
payload.oldItem.displayOrderintegerdisplay order-format (int32)-
payload.oldItem.createdAtstringcreated at-format (date-time)-
payload.oldItem.updatedAtstringupdated at-format (date-time)-
payload.oldItem.purchaseConditionobjectpurchase condition--additional properties are allowed
payload.oldItem.optionBoxConfigobjectoption box configurations--additional properties are allowed
payload.oldItem.flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"item": {
"itemId": "string",
"appId": "string",
"appType": "string",
"baseAppId": "string",
"baseAppItemId": "string",
"namespace": "string",
"sku": "string",
"name": "string",
"entitlementType": "string",
"useCount": 0,
"stackable": true,
"categoryPath": "string",
"images": [
{
"as": "string",
"caption": "string",
"height": 0,
"width": 0,
"imageUrl": "string",
"smallImageUrl": "string"
}
],
"thumbnailUrl": "string",
"localizations": {
"property1": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
}
},
"status": "string",
"listable": true,
"purchasable": true,
"sectionExclusive": true,
"itemType": "string",
"targetNamespace": "string",
"targetCurrencyCode": "string",
"targetItemId": "string",
"regionData": {
"property1": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
]
},
"itemIds": [
"string"
],
"itemQty": {
"property1": 0,
"property2": 0
},
"tags": [
"string"
],
"features": [
"string"
],
"maxCountPerUser": 0,
"maxCount": 0,
"clazz": "string",
"ext": {
"property1": {},
"property2": {}
},
"boothName": "string",
"ticketBoothId": "string",
"displayOrder": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"purchaseCondition": {},
"optionBoxConfig": {},
"flexible": true
},
"oldItem": {
"itemId": "string",
"appId": "string",
"appType": "string",
"baseAppId": "string",
"baseAppItemId": "string",
"namespace": "string",
"sku": "string",
"name": "string",
"entitlementType": "string",
"useCount": 0,
"stackable": true,
"categoryPath": "string",
"images": [
{
"as": "string",
"caption": "string",
"height": 0,
"width": 0,
"imageUrl": "string",
"smallImageUrl": "string"
}
],
"thumbnailUrl": "string",
"localizations": {
"property1": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
}
},
"status": "string",
"listable": true,
"purchasable": true,
"sectionExclusive": true,
"itemType": "string",
"targetNamespace": "string",
"targetCurrencyCode": "string",
"targetItemId": "string",
"regionData": {
"property1": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
]
},
"itemIds": [
"string"
],
"itemQty": {
"property1": 0,
"property2": 0
},
"tags": [
"string"
],
"features": [
"string"
],
"maxCountPerUser": 0,
"maxCount": 0,
"clazz": "string",
"ext": {
"property1": {},
"property2": {}
},
"boothName": "string",
"ticketBoothId": "string",
"displayOrder": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"purchaseCondition": {},
"optionBoxConfig": {},
"flexible": 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"
}

Message itemDeleted

message is sent when item is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.itemobject---additional properties are allowed
payload.item.itemIdstringItem id---
payload.item.appIdstringApp id---
payload.item.appTypestringApp type---
payload.item.baseAppIdstringBase app id---
payload.item.baseAppItemIdstringItem id of base app---
payload.item.namespacestringItem namespace---
payload.item.skustringSku---
payload.item.namestringName---
payload.item.entitlementTypestringEntitlement type---
payload.item.useCountintegerItem use count-format (int32)-
payload.item.stackablebooleanWhether stack the CONSUMABLE entitlement---
payload.item.categoryPathstringItem category path---
payload.item.imagesarray<object>images---
payload.item.images.asstringimage for---
payload.item.images.captionstringimage caption---
payload.item.images.heightintegerheight-format (int32)required
payload.item.images.widthintegerwidth-format (int32)required
payload.item.images.imageUrlstringimageUrl--required
payload.item.images.smallImageUrlstringsmallImageUrl--required
payload.item.thumbnailUrlstringthumbnail url---
payload.item.localizationsobjectItem localizations---
payload.item.localizations (additional properties)object---additional properties are allowed
payload.item.localizations.titlestringtitle info--required
payload.item.localizations.descriptionstringdescription info---
payload.item.localizations.longDescriptionstringlong description info---
payload.item.localizations.localExtobject----
payload.item.localizations.localExt (additional properties)object---additional properties are allowed
payload.item.statusstringItem status---
payload.item.listablebooleanwhether it is visible in Store for public user---
payload.item.purchasablebooleanwhether it can be purchased---
payload.item.sectionExclusivebooleanwhether this item is sold in section only---
payload.item.itemTypestringItem type---
payload.item.targetNamespacestringThe target namespace of a cross namespace item---
payload.item.targetCurrencyCodestringThe target currency code of coin Item---
payload.item.targetItemIdstringTarget item id if this item is mapping from game namespace---
payload.item.regionDataobjectItem region data---
payload.item.regionData (additional properties)array<object>----
payload.item.regionData.priceinteger--format (int32)required
payload.item.regionData.discountPercentageinteger--format (int32), [ 0 .. 100 ]-
payload.item.regionData.discountAmountinteger--format (int32), >= 0-
payload.item.regionData.discountedPriceinteger--format (int32)-
payload.item.regionData.currencyCodestringcurrency code--required
payload.item.regionData.currencyTypestringcurrency type--required
payload.item.regionData.currencyNamespacestringcurrency namespace--required
payload.item.regionData.purchaseAtstringPurchaseAt-format (date-time)-
payload.item.regionData.expireAtstringExpireAt-format (date-time)-
payload.item.regionData.discountPurchaseAtstringDiscount purchase date time-format (date-time)-
payload.item.regionData.discountExpireAtstringDiscount expire date time-format (date-time)-
payload.item.itemIdsarray<string>Bundle item's item ids---
payload.item.itemIds (single item)string----
payload.item.itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"---
payload.item.itemQty (additional properties)integer--format (int32)-
payload.item.tagsarray<string>Tags---
payload.item.tags (single item)string----
payload.item.featuresarray<string>Features---
payload.item.features (single item)string----
payload.item.maxCountPerUserintegerMax count per user-format (int32)-
payload.item.maxCountintegerMax count-format (int32)-
payload.item.clazzstringcustomized item clazz---
payload.item.extobjectcustomized item properties---
payload.item.ext (additional properties)object---additional properties are allowed
payload.item.boothNamestringbooth name to get tickets while it's item type is CODE---
payload.item.ticketBoothIdstringbooth id while item type is CODE---
payload.item.displayOrderintegerdisplay order-format (int32)-
payload.item.createdAtstringcreated at-format (date-time)-
payload.item.updatedAtstringupdated at-format (date-time)-
payload.item.purchaseConditionobjectpurchase condition--additional properties are allowed
payload.item.optionBoxConfigobjectoption box configurations--additional properties are allowed
payload.item.flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"item": {
"itemId": "string",
"appId": "string",
"appType": "string",
"baseAppId": "string",
"baseAppItemId": "string",
"namespace": "string",
"sku": "string",
"name": "string",
"entitlementType": "string",
"useCount": 0,
"stackable": true,
"categoryPath": "string",
"images": [
{
"as": "string",
"caption": "string",
"height": 0,
"width": 0,
"imageUrl": "string",
"smallImageUrl": "string"
}
],
"thumbnailUrl": "string",
"localizations": {
"property1": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
}
},
"status": "string",
"listable": true,
"purchasable": true,
"sectionExclusive": true,
"itemType": "string",
"targetNamespace": "string",
"targetCurrencyCode": "string",
"targetItemId": "string",
"regionData": {
"property1": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
]
},
"itemIds": [
"string"
],
"itemQty": {
"property1": 0,
"property2": 0
},
"tags": [
"string"
],
"features": [
"string"
],
"maxCountPerUser": 0,
"maxCount": 0,
"clazz": "string",
"ext": {
"property1": {},
"property2": {}
},
"boothName": "string",
"ticketBoothId": "string",
"displayOrder": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"purchaseCondition": {},
"optionBoxConfig": {},
"flexible": 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"
}

Message inGameItemSynced

message is sent when sync in game item from game namespace to publisher namespace

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.itemobject---additional properties are allowed
payload.item.itemIdstringItem id---
payload.item.appIdstringApp id---
payload.item.appTypestringApp type---
payload.item.baseAppIdstringBase app id---
payload.item.baseAppItemIdstringItem id of base app---
payload.item.namespacestringItem namespace---
payload.item.skustringSku---
payload.item.namestringName---
payload.item.entitlementTypestringEntitlement type---
payload.item.useCountintegerItem use count-format (int32)-
payload.item.stackablebooleanWhether stack the CONSUMABLE entitlement---
payload.item.categoryPathstringItem category path---
payload.item.imagesarray<object>images---
payload.item.images.asstringimage for---
payload.item.images.captionstringimage caption---
payload.item.images.heightintegerheight-format (int32)required
payload.item.images.widthintegerwidth-format (int32)required
payload.item.images.imageUrlstringimageUrl--required
payload.item.images.smallImageUrlstringsmallImageUrl--required
payload.item.thumbnailUrlstringthumbnail url---
payload.item.localizationsobjectItem localizations---
payload.item.localizations (additional properties)object---additional properties are allowed
payload.item.localizations.titlestringtitle info--required
payload.item.localizations.descriptionstringdescription info---
payload.item.localizations.longDescriptionstringlong description info---
payload.item.localizations.localExtobject----
payload.item.localizations.localExt (additional properties)object---additional properties are allowed
payload.item.statusstringItem status---
payload.item.listablebooleanwhether it is visible in Store for public user---
payload.item.purchasablebooleanwhether it can be purchased---
payload.item.sectionExclusivebooleanwhether this item is sold in section only---
payload.item.itemTypestringItem type---
payload.item.targetNamespacestringThe target namespace of a cross namespace item---
payload.item.targetCurrencyCodestringThe target currency code of coin Item---
payload.item.targetItemIdstringTarget item id if this item is mapping from game namespace---
payload.item.regionDataobjectItem region data---
payload.item.regionData (additional properties)array<object>----
payload.item.regionData.priceinteger--format (int32)required
payload.item.regionData.discountPercentageinteger--format (int32), [ 0 .. 100 ]-
payload.item.regionData.discountAmountinteger--format (int32), >= 0-
payload.item.regionData.discountedPriceinteger--format (int32)-
payload.item.regionData.currencyCodestringcurrency code--required
payload.item.regionData.currencyTypestringcurrency type--required
payload.item.regionData.currencyNamespacestringcurrency namespace--required
payload.item.regionData.purchaseAtstringPurchaseAt-format (date-time)-
payload.item.regionData.expireAtstringExpireAt-format (date-time)-
payload.item.regionData.discountPurchaseAtstringDiscount purchase date time-format (date-time)-
payload.item.regionData.discountExpireAtstringDiscount expire date time-format (date-time)-
payload.item.itemIdsarray<string>Bundle item's item ids---
payload.item.itemIds (single item)string----
payload.item.itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"---
payload.item.itemQty (additional properties)integer--format (int32)-
payload.item.tagsarray<string>Tags---
payload.item.tags (single item)string----
payload.item.featuresarray<string>Features---
payload.item.features (single item)string----
payload.item.maxCountPerUserintegerMax count per user-format (int32)-
payload.item.maxCountintegerMax count-format (int32)-
payload.item.clazzstringcustomized item clazz---
payload.item.extobjectcustomized item properties---
payload.item.ext (additional properties)object---additional properties are allowed
payload.item.boothNamestringbooth name to get tickets while it's item type is CODE---
payload.item.ticketBoothIdstringbooth id while item type is CODE---
payload.item.displayOrderintegerdisplay order-format (int32)-
payload.item.createdAtstringcreated at-format (date-time)-
payload.item.updatedAtstringupdated at-format (date-time)-
payload.item.purchaseConditionobjectpurchase condition--additional properties are allowed
payload.item.optionBoxConfigobjectoption box configurations--additional properties are allowed
payload.item.flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE---
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"item": {
"itemId": "string",
"appId": "string",
"appType": "string",
"baseAppId": "string",
"baseAppItemId": "string",
"namespace": "string",
"sku": "string",
"name": "string",
"entitlementType": "string",
"useCount": 0,
"stackable": true,
"categoryPath": "string",
"images": [
{
"as": "string",
"caption": "string",
"height": 0,
"width": 0,
"imageUrl": "string",
"smallImageUrl": "string"
}
],
"thumbnailUrl": "string",
"localizations": {
"property1": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"description": "string",
"longDescription": "string",
"localExt": {
"property1": {},
"property2": {}
}
}
},
"status": "string",
"listable": true,
"purchasable": true,
"sectionExclusive": true,
"itemType": "string",
"targetNamespace": "string",
"targetCurrencyCode": "string",
"targetItemId": "string",
"regionData": {
"property1": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"price": 0,
"discountPercentage": 0,
"discountAmount": 0,
"discountedPrice": 0,
"currencyCode": "USD",
"currencyType": "string",
"currencyNamespace": "string",
"purchaseAt": "2019-08-24T14:15:22Z",
"expireAt": "2019-08-24T14:15:22Z",
"discountPurchaseAt": "2019-08-24T14:15:22Z",
"discountExpireAt": "2019-08-24T14:15:22Z"
}
]
},
"itemIds": [
"string"
],
"itemQty": {
"property1": 0,
"property2": 0
},
"tags": [
"string"
],
"features": [
"string"
],
"maxCountPerUser": 0,
"maxCount": 0,
"clazz": "string",
"ext": {
"property1": {},
"property2": {}
},
"boothName": "string",
"ticketBoothId": "string",
"displayOrder": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"purchaseCondition": {},
"optionBoxConfig": {},
"flexible": 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"
}

Message itemDisabled

message is sent when item is disabled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstringstore id---
payload.itemStatusChangeobject---additional properties are allowed
payload.itemStatusChange.itemIdstringitem id---
payload.itemStatusChange.itemNamestringitem name---
payload.itemStatusChange.statusstringitem statusallowed ("ACTIVE", "INACTIVE")--
payload.itemStatusChange.previousStatusstringitem status before changeallowed ("ACTIVE", "INACTIVE")--
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"itemStatusChange": {
"itemId": "string",
"itemName": "string",
"status": "ACTIVE",
"previousStatus": "ACTIVE"
}
},
"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 itemEnabled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstring----
payload.itemStatusChangeobject---additional properties are allowed
payload.itemStatusChange.itemIdstringitem id---
payload.itemStatusChange.itemNamestringitem name---
payload.itemStatusChange.statusstringitem statusallowed ("ACTIVE", "INACTIVE")--
payload.itemStatusChange.previousStatusstringitem status before changeallowed ("ACTIVE", "INACTIVE")--
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"itemStatusChange": {
"itemId": "string",
"itemName": "string",
"status": "ACTIVE",
"previousStatus": "ACTIVE"
}
},
"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 appUpdated

message is sent when an app is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.storeIdstring----
payload.appobject---additional properties are allowed
payload.app.itemIdstringitem id---
payload.app.namespacestringnamespace---
payload.app.carouselarray<object>----
payload.app.carousel.typestringslide typeallowed ("image", "video")--
payload.app.carousel.videoSourcestringvideo sourceallowed ("generic", "youtube", "vimeo")--
payload.app.carousel.urlstringvideo url---
payload.app.carousel.altstring----
payload.app.carousel.thumbnailUrlstringthumbnail url---
payload.app.carousel.previewUrlstringpreview url---
payload.app.developerstringdeveloper info---
payload.app.publisherstringpublisher info---
payload.app.websiteUrlstringwebsite url---
payload.app.forumUrlstringforum url---
payload.app.platformsarray<string>platform info, Windows/MacOS/Linux/IOS/Android---
payload.app.platforms (single item)string----
payload.app.platformRequirementsobjectplatform requirements---
payload.app.platformRequirements (additional properties)array<object>----
payload.app.platformRequirements.labelstringlabel, value can be:minimum,recommended--required
payload.app.platformRequirements.osVersionstringOS version---
payload.app.platformRequirements.processorstringprocessor---
payload.app.platformRequirements.ramstringRAM---
payload.app.platformRequirements.graphicsstringgraphics---
payload.app.platformRequirements.directXVersionstringdirectX version---
payload.app.platformRequirements.diskSpacestringdisk space---
payload.app.platformRequirements.soundCardstringsound card---
payload.app.platformRequirements.additionalsstringother requirement---
payload.app.localizationsobjectlocalization info---
payload.app.localizations (additional properties)object---additional properties are allowed
payload.app.localizations.sloganstring----
payload.app.localizations.announcementstring----
payload.app.primaryGenrestringprimary genre typeallowed ("Action", "Adventure", "Casual", "FreeToPlay", "Indie", "MassivelyMultiplayer", "Racing", "RPG", "Simulation", "Sports", "Strategy")--
payload.app.genresarray<string>genre types---
payload.app.genres (single item)string----
payload.app.playersarray<string>player type---
payload.app.players (single item)string-allowed ("Single", "Multi", "CrossPlatformMulti", "MMO", "Coop", "LocalCoop")--
payload.app.releaseDatestringrelease date-format (date-time)-
payload.oldAppobject---additional properties are allowed
payload.oldApp.itemIdstringitem id---
payload.oldApp.namespacestringnamespace---
payload.oldApp.carouselarray<object>----
payload.oldApp.carousel.typestringslide typeallowed ("image", "video")--
payload.oldApp.carousel.videoSourcestringvideo sourceallowed ("generic", "youtube", "vimeo")--
payload.oldApp.carousel.urlstringvideo url---
payload.oldApp.carousel.altstring----
payload.oldApp.carousel.thumbnailUrlstringthumbnail url---
payload.oldApp.carousel.previewUrlstringpreview url---
payload.oldApp.developerstringdeveloper info---
payload.oldApp.publisherstringpublisher info---
payload.oldApp.websiteUrlstringwebsite url---
payload.oldApp.forumUrlstringforum url---
payload.oldApp.platformsarray<string>platform info, Windows/MacOS/Linux/IOS/Android---
payload.oldApp.platforms (single item)string----
payload.oldApp.platformRequirementsobjectplatform requirements---
payload.oldApp.platformRequirements (additional properties)array<object>----
payload.oldApp.platformRequirements.labelstringlabel, value can be:minimum,recommended--required
payload.oldApp.platformRequirements.osVersionstringOS version---
payload.oldApp.platformRequirements.processorstringprocessor---
payload.oldApp.platformRequirements.ramstringRAM---
payload.oldApp.platformRequirements.graphicsstringgraphics---
payload.oldApp.platformRequirements.directXVersionstringdirectX version---
payload.oldApp.platformRequirements.diskSpacestringdisk space---
payload.oldApp.platformRequirements.soundCardstringsound card---
payload.oldApp.platformRequirements.additionalsstringother requirement---
payload.oldApp.localizationsobjectlocalization info---
payload.oldApp.localizations (additional properties)object---additional properties are allowed
payload.oldApp.localizations.sloganstring----
payload.oldApp.localizations.announcementstring----
payload.oldApp.primaryGenrestringprimary genre typeallowed ("Action", "Adventure", "Casual", "FreeToPlay", "Indie", "MassivelyMultiplayer", "Racing", "RPG", "Simulation", "Sports", "Strategy")--
payload.oldApp.genresarray<string>genre types---
payload.oldApp.genres (single item)string----
payload.oldApp.playersarray<string>player type---
payload.oldApp.players (single item)string-allowed ("Single", "Multi", "CrossPlatformMulti", "MMO", "Coop", "LocalCoop")--
payload.oldApp.releaseDatestringrelease date-format (date-time)-
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"storeId": "string",
"app": {
"itemId": "string",
"namespace": "string",
"carousel": [
{
"type": "image",
"videoSource": "generic",
"url": "string",
"alt": "string",
"thumbnailUrl": "string",
"previewUrl": "string"
}
],
"developer": "string",
"publisher": "string",
"websiteUrl": "string",
"forumUrl": "string",
"platforms": [
"string"
],
"platformRequirements": {
"property1": [
{
"label": "string",
"osVersion": "string",
"processor": "string",
"ram": "string",
"graphics": "string",
"directXVersion": "string",
"diskSpace": "string",
"soundCard": "string",
"additionals": "string"
}
],
"property2": [
{
"label": "string",
"osVersion": "string",
"processor": "string",
"ram": "string",
"graphics": "string",
"directXVersion": "string",
"diskSpace": "string",
"soundCard": "string",
"additionals": "string"
}
]
},
"localizations": {
"property1": {
"slogan": "string",
"announcement": "string"
},
"property2": {
"slogan": "string",
"announcement": "string"
}
},
"primaryGenre": "Action",
"genres": [
"string"
],
"players": [
"Single"
],
"releaseDate": "2019-08-24T14:15:22Z"
},
"oldApp": {
"itemId": "string",
"namespace": "string",
"carousel": [
{
"type": "image",
"videoSource": "generic",
"url": "string",
"alt": "string",
"thumbnailUrl": "string",
"previewUrl": "string"
}
],
"developer": "string",
"publisher": "string",
"websiteUrl": "string",
"forumUrl": "string",
"platforms": [
"string"
],
"platformRequirements": {
"property1": [
{
"label": "string",
"osVersion": "string",
"processor": "string",
"ram": "string",
"graphics": "string",
"directXVersion": "string",
"diskSpace": "string",
"soundCard": "string",
"additionals": "string"
}
],
"property2": [
{
"label": "string",
"osVersion": "string",
"processor": "string",
"ram": "string",
"graphics": "string",
"directXVersion": "string",
"diskSpace": "string",
"soundCard": "string",
"additionals": "string"
}
]
},
"localizations": {
"property1": {
"slogan": "string",
"announcement": "string"
},
"property2": {
"slogan": "string",
"announcement": "string"
}
},
"primaryGenre": "Action",
"genres": [
"string"
],
"players": [
"Single"
],
"releaseDate": "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"
}