AsyncAPI for catalog service 0.0.1 documentation
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:catalog
- Protobuf File Spec: catalog.proto
- Default content type: application/json
Table of Contents
Operations
PUB catalogManagement
Operation
Accepts one of the following messages:
Message storeCreated
message is sent when store is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.store | object | - | - | - | additional properties are allowed |
payload.store.storeId | string | Store id | - | - | - |
payload.store.namespace | string | The namespace | - | - | - |
payload.store.title | string | Store title | - | - | - |
payload.store.description | string | Store description | - | - | - |
payload.store.published | boolean | If Store is published | - | - | - |
payload.store.supportedLanguages | array<string> | Store supported language | - | - | - |
payload.store.supportedLanguages (single item) | string | - | - | - | - |
payload.store.supportedRegions | array<string> | Store supported regions | - | - | - |
payload.store.supportedRegions (single item) | string | - | - | - | - |
payload.store.defaultRegion | string | Default region | - | - | - |
payload.store.defaultLanguage | string | Default language | - | - | - |
payload.store.publishedTime | string | Store published time | - | format (date-time ) | - |
payload.store.createdAt | string | - | - | format (date-time ) | - |
payload.store.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.store | object | - | - | - | additional properties are allowed |
payload.store.storeId | string | Store id | - | - | - |
payload.store.namespace | string | The namespace | - | - | - |
payload.store.title | string | Store title | - | - | - |
payload.store.description | string | Store description | - | - | - |
payload.store.published | boolean | If Store is published | - | - | - |
payload.store.supportedLanguages | array<string> | Store supported language | - | - | - |
payload.store.supportedLanguages (single item) | string | - | - | - | - |
payload.store.supportedRegions | array<string> | Store supported regions | - | - | - |
payload.store.supportedRegions (single item) | string | - | - | - | - |
payload.store.defaultRegion | string | Default region | - | - | - |
payload.store.defaultLanguage | string | Default language | - | - | - |
payload.store.publishedTime | string | Store published time | - | format (date-time ) | - |
payload.store.createdAt | string | - | - | format (date-time ) | - |
payload.store.updatedAt | string | - | - | format (date-time ) | - |
payload.oldStore | object | - | - | - | additional properties are allowed |
payload.oldStore.storeId | string | Store id | - | - | - |
payload.oldStore.namespace | string | The namespace | - | - | - |
payload.oldStore.title | string | Store title | - | - | - |
payload.oldStore.description | string | Store description | - | - | - |
payload.oldStore.published | boolean | If Store is published | - | - | - |
payload.oldStore.supportedLanguages | array<string> | Store supported language | - | - | - |
payload.oldStore.supportedLanguages (single item) | string | - | - | - | - |
payload.oldStore.supportedRegions | array<string> | Store supported regions | - | - | - |
payload.oldStore.supportedRegions (single item) | string | - | - | - | - |
payload.oldStore.defaultRegion | string | Default region | - | - | - |
payload.oldStore.defaultLanguage | string | Default language | - | - | - |
payload.oldStore.publishedTime | string | Store published time | - | format (date-time ) | - |
payload.oldStore.createdAt | string | - | - | format (date-time ) | - |
payload.oldStore.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.store | object | - | - | - | additional properties are allowed |
payload.store.storeId | string | Store id | - | - | - |
payload.store.namespace | string | The namespace | - | - | - |
payload.store.title | string | Store title | - | - | - |
payload.store.description | string | Store description | - | - | - |
payload.store.published | boolean | If Store is published | - | - | - |
payload.store.supportedLanguages | array<string> | Store supported language | - | - | - |
payload.store.supportedLanguages (single item) | string | - | - | - | - |
payload.store.supportedRegions | array<string> | Store supported regions | - | - | - |
payload.store.supportedRegions (single item) | string | - | - | - | - |
payload.store.defaultRegion | string | Default region | - | - | - |
payload.store.defaultLanguage | string | Default language | - | - | - |
payload.store.publishedTime | string | Store published time | - | format (date-time ) | - |
payload.store.createdAt | string | - | - | format (date-time ) | - |
payload.store.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.storeClone | object | - | - | - | additional properties are allowed |
payload.storeClone.targetStoreId | string | the target store id | - | - | - |
payload.storeClone.published | boolean | true if the target store is a published store | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.storePublishSchema | object | - | - | - | additional properties are allowed |
payload.storePublishSchema.namespace | string | namespace | - | - | - |
payload.storePublishSchema.storeId | string | store id | - | - | - |
payload.storePublishSchema.incremental | boolean | a flag indicates whether publish store incrementally | - | - | - |
payload.storePublishSchema.catalogChanges | array<object> | - | - | - | - |
payload.storePublishSchema.catalogChanges.storeId | string | published store id | - | - | - |
payload.storePublishSchema.catalogChanges.changeId | string | id for this change | - | - | - |
payload.storePublishSchema.catalogChanges.itemType | string | type of the item | - | - | - |
payload.storePublishSchema.catalogChanges.itemId | string | item id if this is a item change | - | - | - |
payload.storePublishSchema.catalogChanges.sku | string | sku of item | - | - | - |
payload.storePublishSchema.catalogChanges.viewId | string | view id if this is a view change | - | - | - |
payload.storePublishSchema.catalogChanges.sectionId | string | section id if this is a section change | - | - | - |
payload.storePublishSchema.catalogChanges.categoryPath | string | category path if there is a category change | - | - | - |
payload.storePublishSchema.catalogChanges.action | string | change action | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | - | - | - | - |
payload.category | object | - | - | - | additional properties are allowed |
payload.category.namespace | string | Category namespace | - | - | - |
payload.category.parentCategoryPath | string | Parent category path | - | - | - |
payload.category.categoryPath | string | Category path | - | - | - |
payload.category.isRoot | boolean | - | - | - | - |
payload.category.localizationDisplayNames | object | Category localization display name | - | - | - |
payload.category.localizationDisplayNames (additional properties) | string | - | - | - | - |
payload.category.createdAt | string | - | - | format (date-time ) | - |
payload.category.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | - | - | - | - |
payload.category | object | - | - | - | additional properties are allowed |
payload.category.namespace | string | Category namespace | - | - | - |
payload.category.parentCategoryPath | string | Parent category path | - | - | - |
payload.category.categoryPath | string | Category path | - | - | - |
payload.category.isRoot | boolean | - | - | - | - |
payload.category.localizationDisplayNames | object | Category localization display name | - | - | - |
payload.category.localizationDisplayNames (additional properties) | string | - | - | - | - |
payload.category.createdAt | string | - | - | format (date-time ) | - |
payload.category.updatedAt | string | - | - | format (date-time ) | - |
payload.oldCategory | object | - | - | - | additional properties are allowed |
payload.oldCategory.namespace | string | Category namespace | - | - | - |
payload.oldCategory.parentCategoryPath | string | Parent category path | - | - | - |
payload.oldCategory.categoryPath | string | Category path | - | - | - |
payload.oldCategory.isRoot | boolean | - | - | - | - |
payload.oldCategory.localizationDisplayNames | object | Category localization display name | - | - | - |
payload.oldCategory.localizationDisplayNames (additional properties) | string | - | - | - | - |
payload.oldCategory.createdAt | string | - | - | format (date-time ) | - |
payload.oldCategory.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.category | object | - | - | - | additional properties are allowed |
payload.category.namespace | string | Category namespace | - | - | - |
payload.category.parentCategoryPath | string | Parent category path | - | - | - |
payload.category.categoryPath | string | Category path | - | - | - |
payload.category.isRoot | boolean | - | - | - | - |
payload.category.localizationDisplayNames | object | Category localization display name | - | - | - |
payload.category.localizationDisplayNames (additional properties) | string | - | - | - | - |
payload.category.createdAt | string | - | - | format (date-time ) | - |
payload.category.updatedAt | string | - | - | format (date-time ) | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | - | - | - | - |
payload.item | object | - | - | - | additional properties are allowed |
payload.item.itemId | string | Item id | - | - | - |
payload.item.appId | string | App id | - | - | - |
payload.item.appType | string | App type | - | - | - |
payload.item.baseAppId | string | Base app id | - | - | - |
payload.item.baseAppItemId | string | Item id of base app | - | - | - |
payload.item.namespace | string | Item namespace | - | - | - |
payload.item.sku | string | Sku | - | - | - |
payload.item.name | string | Name | - | - | - |
payload.item.entitlementType | string | Entitlement type | - | - | - |
payload.item.useCount | integer | Item use count | - | format (int32 ) | - |
payload.item.stackable | boolean | Whether stack the CONSUMABLE entitlement | - | - | - |
payload.item.categoryPath | string | Item category path | - | - | - |
payload.item.images | array<object> | images | - | - | - |
payload.item.images.as | string | image for | - | - | - |
payload.item.images.caption | string | image caption | - | - | - |
payload.item.images.height | integer | height | - | format (int32 ) | required |
payload.item.images.width | integer | width | - | format (int32 ) | required |
payload.item.images.imageUrl | string | imageUrl | - | - | required |
payload.item.images.smallImageUrl | string | smallImageUrl | - | - | required |
payload.item.thumbnailUrl | string | thumbnail url | - | - | - |
payload.item.localizations | object | Item localizations | - | - | - |
payload.item.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.localizations.title | string | title info | - | - | required |
payload.item.localizations.description | string | description info | - | - | - |
payload.item.localizations.longDescription | string | long description info | - | - | - |
payload.item.localizations.localExt | object | - | - | - | - |
payload.item.localizations.localExt (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.status | string | Item status | - | - | - |
payload.item.listable | boolean | whether it is visible in Store for public user | - | - | - |
payload.item.purchasable | boolean | whether it can be purchased | - | - | - |
payload.item.sectionExclusive | boolean | whether this item is sold in section only | - | - | - |
payload.item.itemType | string | Item type | - | - | - |
payload.item.targetNamespace | string | The target namespace of a cross namespace item | - | - | - |
payload.item.targetCurrencyCode | string | The target currency code of coin Item | - | - | - |
payload.item.targetItemId | string | Target item id if this item is mapping from game namespace | - | - | - |
payload.item.regionData | object | Item region data | - | - | - |
payload.item.regionData (additional properties) | array<object> | - | - | - | - |
payload.item.regionData.price | integer | - | - | format (int32 ) | required |
payload.item.regionData.discountPercentage | integer | - | - | format (int32 ), [ 0 .. 100 ] | - |
payload.item.regionData.discountAmount | integer | - | - | format (int32 ), >= 0 | - |
payload.item.regionData.discountedPrice | integer | - | - | format (int32 ) | - |
payload.item.regionData.currencyCode | string | currency code | - | - | required |
payload.item.regionData.currencyType | string | currency type | - | - | required |
payload.item.regionData.currencyNamespace | string | currency namespace | - | - | required |
payload.item.regionData.purchaseAt | string | PurchaseAt | - | format (date-time ) | - |
payload.item.regionData.expireAt | string | ExpireAt | - | format (date-time ) | - |
payload.item.regionData.discountPurchaseAt | string | Discount purchase date time | - | format (date-time ) | - |
payload.item.regionData.discountExpireAt | string | Discount expire date time | - | format (date-time ) | - |
payload.item.itemIds | array<string> | Bundle item's item ids | - | - | - |
payload.item.itemIds (single item) | string | - | - | - | - |
payload.item.itemQty | object | itemQty, 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.tags | array<string> | Tags | - | - | - |
payload.item.tags (single item) | string | - | - | - | - |
payload.item.features | array<string> | Features | - | - | - |
payload.item.features (single item) | string | - | - | - | - |
payload.item.maxCountPerUser | integer | Max count per user | - | format (int32 ) | - |
payload.item.maxCount | integer | Max count | - | format (int32 ) | - |
payload.item.clazz | string | customized item clazz | - | - | - |
payload.item.ext | object | customized item properties | - | - | - |
payload.item.ext (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.boothName | string | booth name to get tickets while it's item type is CODE | - | - | - |
payload.item.ticketBoothId | string | booth id while item type is CODE | - | - | - |
payload.item.displayOrder | integer | display order | - | format (int32 ) | - |
payload.item.createdAt | string | created at | - | format (date-time ) | - |
payload.item.updatedAt | string | updated at | - | format (date-time ) | - |
payload.item.purchaseCondition | object | purchase condition | - | - | additional properties are allowed |
payload.item.optionBoxConfig | object | option box configurations | - | - | additional properties are allowed |
payload.item.flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.item | object | - | - | - | additional properties are allowed |
payload.item.itemId | string | Item id | - | - | - |
payload.item.appId | string | App id | - | - | - |
payload.item.appType | string | App type | - | - | - |
payload.item.baseAppId | string | Base app id | - | - | - |
payload.item.baseAppItemId | string | Item id of base app | - | - | - |
payload.item.namespace | string | Item namespace | - | - | - |
payload.item.sku | string | Sku | - | - | - |
payload.item.name | string | Name | - | - | - |
payload.item.entitlementType | string | Entitlement type | - | - | - |
payload.item.useCount | integer | Item use count | - | format (int32 ) | - |
payload.item.stackable | boolean | Whether stack the CONSUMABLE entitlement | - | - | - |
payload.item.categoryPath | string | Item category path | - | - | - |
payload.item.images | array<object> | images | - | - | - |
payload.item.images.as | string | image for | - | - | - |
payload.item.images.caption | string | image caption | - | - | - |
payload.item.images.height | integer | height | - | format (int32 ) | required |
payload.item.images.width | integer | width | - | format (int32 ) | required |
payload.item.images.imageUrl | string | imageUrl | - | - | required |
payload.item.images.smallImageUrl | string | smallImageUrl | - | - | required |
payload.item.thumbnailUrl | string | thumbnail url | - | - | - |
payload.item.localizations | object | Item localizations | - | - | - |
payload.item.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.localizations.title | string | title info | - | - | required |
payload.item.localizations.description | string | description info | - | - | - |
payload.item.localizations.longDescription | string | long description info | - | - | - |
payload.item.localizations.localExt | object | - | - | - | - |
payload.item.localizations.localExt (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.status | string | Item status | - | - | - |
payload.item.listable | boolean | whether it is visible in Store for public user | - | - | - |
payload.item.purchasable | boolean | whether it can be purchased | - | - | - |
payload.item.sectionExclusive | boolean | whether this item is sold in section only | - | - | - |
payload.item.itemType | string | Item type | - | - | - |
payload.item.targetNamespace | string | The target namespace of a cross namespace item | - | - | - |
payload.item.targetCurrencyCode | string | The target currency code of coin Item | - | - | - |
payload.item.targetItemId | string | Target item id if this item is mapping from game namespace | - | - | - |
payload.item.regionData | object | Item region data | - | - | - |
payload.item.regionData (additional properties) | array<object> | - | - | - | - |
payload.item.regionData.price | integer | - | - | format (int32 ) | required |
payload.item.regionData.discountPercentage | integer | - | - | format (int32 ), [ 0 .. 100 ] | - |
payload.item.regionData.discountAmount | integer | - | - | format (int32 ), >= 0 | - |
payload.item.regionData.discountedPrice | integer | - | - | format (int32 ) | - |
payload.item.regionData.currencyCode | string | currency code | - | - | required |
payload.item.regionData.currencyType | string | currency type | - | - | required |
payload.item.regionData.currencyNamespace | string | currency namespace | - | - | required |
payload.item.regionData.purchaseAt | string | PurchaseAt | - | format (date-time ) | - |
payload.item.regionData.expireAt | string | ExpireAt | - | format (date-time ) | - |
payload.item.regionData.discountPurchaseAt | string | Discount purchase date time | - | format (date-time ) | - |
payload.item.regionData.discountExpireAt | string | Discount expire date time | - | format (date-time ) | - |
payload.item.itemIds | array<string> | Bundle item's item ids | - | - | - |
payload.item.itemIds (single item) | string | - | - | - | - |
payload.item.itemQty | object | itemQty, 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.tags | array<string> | Tags | - | - | - |
payload.item.tags (single item) | string | - | - | - | - |
payload.item.features | array<string> | Features | - | - | - |
payload.item.features (single item) | string | - | - | - | - |
payload.item.maxCountPerUser | integer | Max count per user | - | format (int32 ) | - |
payload.item.maxCount | integer | Max count | - | format (int32 ) | - |
payload.item.clazz | string | customized item clazz | - | - | - |
payload.item.ext | object | customized item properties | - | - | - |
payload.item.ext (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.boothName | string | booth name to get tickets while it's item type is CODE | - | - | - |
payload.item.ticketBoothId | string | booth id while item type is CODE | - | - | - |
payload.item.displayOrder | integer | display order | - | format (int32 ) | - |
payload.item.createdAt | string | created at | - | format (date-time ) | - |
payload.item.updatedAt | string | updated at | - | format (date-time ) | - |
payload.item.purchaseCondition | object | purchase condition | - | - | additional properties are allowed |
payload.item.optionBoxConfig | object | option box configurations | - | - | additional properties are allowed |
payload.item.flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE | - | - | - |
payload.oldItem | object | - | - | - | additional properties are allowed |
payload.oldItem.itemId | string | Item id | - | - | - |
payload.oldItem.appId | string | App id | - | - | - |
payload.oldItem.appType | string | App type | - | - | - |
payload.oldItem.baseAppId | string | Base app id | - | - | - |
payload.oldItem.baseAppItemId | string | Item id of base app | - | - | - |
payload.oldItem.namespace | string | Item namespace | - | - | - |
payload.oldItem.sku | string | Sku | - | - | - |
payload.oldItem.name | string | Name | - | - | - |
payload.oldItem.entitlementType | string | Entitlement type | - | - | - |
payload.oldItem.useCount | integer | Item use count | - | format (int32 ) | - |
payload.oldItem.stackable | boolean | Whether stack the CONSUMABLE entitlement | - | - | - |
payload.oldItem.categoryPath | string | Item category path | - | - | - |
payload.oldItem.images | array<object> | images | - | - | - |
payload.oldItem.images.as | string | image for | - | - | - |
payload.oldItem.images.caption | string | image caption | - | - | - |
payload.oldItem.images.height | integer | height | - | format (int32 ) | required |
payload.oldItem.images.width | integer | width | - | format (int32 ) | required |
payload.oldItem.images.imageUrl | string | imageUrl | - | - | required |
payload.oldItem.images.smallImageUrl | string | smallImageUrl | - | - | required |
payload.oldItem.thumbnailUrl | string | thumbnail url | - | - | - |
payload.oldItem.localizations | object | Item localizations | - | - | - |
payload.oldItem.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.oldItem.localizations.title | string | title info | - | - | required |
payload.oldItem.localizations.description | string | description info | - | - | - |
payload.oldItem.localizations.longDescription | string | long description info | - | - | - |
payload.oldItem.localizations.localExt | object | - | - | - | - |
payload.oldItem.localizations.localExt (additional properties) | object | - | - | - | additional properties are allowed |
payload.oldItem.status | string | Item status | - | - | - |
payload.oldItem.listable | boolean | whether it is visible in Store for public user | - | - | - |
payload.oldItem.purchasable | boolean | whether it can be purchased | - | - | - |
payload.oldItem.sectionExclusive | boolean | whether this item is sold in section only | - | - | - |
payload.oldItem.itemType | string | Item type | - | - | - |
payload.oldItem.targetNamespace | string | The target namespace of a cross namespace item | - | - | - |
payload.oldItem.targetCurrencyCode | string | The target currency code of coin Item | - | - | - |
payload.oldItem.targetItemId | string | Target item id if this item is mapping from game namespace | - | - | - |
payload.oldItem.regionData | object | Item region data | - | - | - |
payload.oldItem.regionData (additional properties) | array<object> | - | - | - | - |
payload.oldItem.regionData.price | integer | - | - | format (int32 ) | required |
payload.oldItem.regionData.discountPercentage | integer | - | - | format (int32 ), [ 0 .. 100 ] | - |
payload.oldItem.regionData.discountAmount | integer | - | - | format (int32 ), >= 0 | - |
payload.oldItem.regionData.discountedPrice | integer | - | - | format (int32 ) | - |
payload.oldItem.regionData.currencyCode | string | currency code | - | - | required |
payload.oldItem.regionData.currencyType | string | currency type | - | - | required |
payload.oldItem.regionData.currencyNamespace | string | currency namespace | - | - | required |
payload.oldItem.regionData.purchaseAt | string | PurchaseAt | - | format (date-time ) | - |
payload.oldItem.regionData.expireAt | string | ExpireAt | - | format (date-time ) | - |
payload.oldItem.regionData.discountPurchaseAt | string | Discount purchase date time | - | format (date-time ) | - |
payload.oldItem.regionData.discountExpireAt | string | Discount expire date time | - | format (date-time ) | - |
payload.oldItem.itemIds | array<string> | Bundle item's item ids | - | - | - |
payload.oldItem.itemIds (single item) | string | - | - | - | - |
payload.oldItem.itemQty | object | itemQty, 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.tags | array<string> | Tags | - | - | - |
payload.oldItem.tags (single item) | string | - | - | - | - |
payload.oldItem.features | array<string> | Features | - | - | - |
payload.oldItem.features (single item) | string | - | - | - | - |
payload.oldItem.maxCountPerUser | integer | Max count per user | - | format (int32 ) | - |
payload.oldItem.maxCount | integer | Max count | - | format (int32 ) | - |
payload.oldItem.clazz | string | customized item clazz | - | - | - |
payload.oldItem.ext | object | customized item properties | - | - | - |
payload.oldItem.ext (additional properties) | object | - | - | - | additional properties are allowed |
payload.oldItem.boothName | string | booth name to get tickets while it's item type is CODE | - | - | - |
payload.oldItem.ticketBoothId | string | booth id while item type is CODE | - | - | - |
payload.oldItem.displayOrder | integer | display order | - | format (int32 ) | - |
payload.oldItem.createdAt | string | created at | - | format (date-time ) | - |
payload.oldItem.updatedAt | string | updated at | - | format (date-time ) | - |
payload.oldItem.purchaseCondition | object | purchase condition | - | - | additional properties are allowed |
payload.oldItem.optionBoxConfig | object | option box configurations | - | - | additional properties are allowed |
payload.oldItem.flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.item | object | - | - | - | additional properties are allowed |
payload.item.itemId | string | Item id | - | - | - |
payload.item.appId | string | App id | - | - | - |
payload.item.appType | string | App type | - | - | - |
payload.item.baseAppId | string | Base app id | - | - | - |
payload.item.baseAppItemId | string | Item id of base app | - | - | - |
payload.item.namespace | string | Item namespace | - | - | - |
payload.item.sku | string | Sku | - | - | - |
payload.item.name | string | Name | - | - | - |
payload.item.entitlementType | string | Entitlement type | - | - | - |
payload.item.useCount | integer | Item use count | - | format (int32 ) | - |
payload.item.stackable | boolean | Whether stack the CONSUMABLE entitlement | - | - | - |
payload.item.categoryPath | string | Item category path | - | - | - |
payload.item.images | array<object> | images | - | - | - |
payload.item.images.as | string | image for | - | - | - |
payload.item.images.caption | string | image caption | - | - | - |
payload.item.images.height | integer | height | - | format (int32 ) | required |
payload.item.images.width | integer | width | - | format (int32 ) | required |
payload.item.images.imageUrl | string | imageUrl | - | - | required |
payload.item.images.smallImageUrl | string | smallImageUrl | - | - | required |
payload.item.thumbnailUrl | string | thumbnail url | - | - | - |
payload.item.localizations | object | Item localizations | - | - | - |
payload.item.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.localizations.title | string | title info | - | - | required |
payload.item.localizations.description | string | description info | - | - | - |
payload.item.localizations.longDescription | string | long description info | - | - | - |
payload.item.localizations.localExt | object | - | - | - | - |
payload.item.localizations.localExt (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.status | string | Item status | - | - | - |
payload.item.listable | boolean | whether it is visible in Store for public user | - | - | - |
payload.item.purchasable | boolean | whether it can be purchased | - | - | - |
payload.item.sectionExclusive | boolean | whether this item is sold in section only | - | - | - |
payload.item.itemType | string | Item type | - | - | - |
payload.item.targetNamespace | string | The target namespace of a cross namespace item | - | - | - |
payload.item.targetCurrencyCode | string | The target currency code of coin Item | - | - | - |
payload.item.targetItemId | string | Target item id if this item is mapping from game namespace | - | - | - |
payload.item.regionData | object | Item region data | - | - | - |
payload.item.regionData (additional properties) | array<object> | - | - | - | - |
payload.item.regionData.price | integer | - | - | format (int32 ) | required |
payload.item.regionData.discountPercentage | integer | - | - | format (int32 ), [ 0 .. 100 ] | - |
payload.item.regionData.discountAmount | integer | - | - | format (int32 ), >= 0 | - |
payload.item.regionData.discountedPrice | integer | - | - | format (int32 ) | - |
payload.item.regionData.currencyCode | string | currency code | - | - | required |
payload.item.regionData.currencyType | string | currency type | - | - | required |
payload.item.regionData.currencyNamespace | string | currency namespace | - | - | required |
payload.item.regionData.purchaseAt | string | PurchaseAt | - | format (date-time ) | - |
payload.item.regionData.expireAt | string | ExpireAt | - | format (date-time ) | - |
payload.item.regionData.discountPurchaseAt | string | Discount purchase date time | - | format (date-time ) | - |
payload.item.regionData.discountExpireAt | string | Discount expire date time | - | format (date-time ) | - |
payload.item.itemIds | array<string> | Bundle item's item ids | - | - | - |
payload.item.itemIds (single item) | string | - | - | - | - |
payload.item.itemQty | object | itemQty, 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.tags | array<string> | Tags | - | - | - |
payload.item.tags (single item) | string | - | - | - | - |
payload.item.features | array<string> | Features | - | - | - |
payload.item.features (single item) | string | - | - | - | - |
payload.item.maxCountPerUser | integer | Max count per user | - | format (int32 ) | - |
payload.item.maxCount | integer | Max count | - | format (int32 ) | - |
payload.item.clazz | string | customized item clazz | - | - | - |
payload.item.ext | object | customized item properties | - | - | - |
payload.item.ext (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.boothName | string | booth name to get tickets while it's item type is CODE | - | - | - |
payload.item.ticketBoothId | string | booth id while item type is CODE | - | - | - |
payload.item.displayOrder | integer | display order | - | format (int32 ) | - |
payload.item.createdAt | string | created at | - | format (date-time ) | - |
payload.item.updatedAt | string | updated at | - | format (date-time ) | - |
payload.item.purchaseCondition | object | purchase condition | - | - | additional properties are allowed |
payload.item.optionBoxConfig | object | option box configurations | - | - | additional properties are allowed |
payload.item.flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.item | object | - | - | - | additional properties are allowed |
payload.item.itemId | string | Item id | - | - | - |
payload.item.appId | string | App id | - | - | - |
payload.item.appType | string | App type | - | - | - |
payload.item.baseAppId | string | Base app id | - | - | - |
payload.item.baseAppItemId | string | Item id of base app | - | - | - |
payload.item.namespace | string | Item namespace | - | - | - |
payload.item.sku | string | Sku | - | - | - |
payload.item.name | string | Name | - | - | - |
payload.item.entitlementType | string | Entitlement type | - | - | - |
payload.item.useCount | integer | Item use count | - | format (int32 ) | - |
payload.item.stackable | boolean | Whether stack the CONSUMABLE entitlement | - | - | - |
payload.item.categoryPath | string | Item category path | - | - | - |
payload.item.images | array<object> | images | - | - | - |
payload.item.images.as | string | image for | - | - | - |
payload.item.images.caption | string | image caption | - | - | - |
payload.item.images.height | integer | height | - | format (int32 ) | required |
payload.item.images.width | integer | width | - | format (int32 ) | required |
payload.item.images.imageUrl | string | imageUrl | - | - | required |
payload.item.images.smallImageUrl | string | smallImageUrl | - | - | required |
payload.item.thumbnailUrl | string | thumbnail url | - | - | - |
payload.item.localizations | object | Item localizations | - | - | - |
payload.item.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.localizations.title | string | title info | - | - | required |
payload.item.localizations.description | string | description info | - | - | - |
payload.item.localizations.longDescription | string | long description info | - | - | - |
payload.item.localizations.localExt | object | - | - | - | - |
payload.item.localizations.localExt (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.status | string | Item status | - | - | - |
payload.item.listable | boolean | whether it is visible in Store for public user | - | - | - |
payload.item.purchasable | boolean | whether it can be purchased | - | - | - |
payload.item.sectionExclusive | boolean | whether this item is sold in section only | - | - | - |
payload.item.itemType | string | Item type | - | - | - |
payload.item.targetNamespace | string | The target namespace of a cross namespace item | - | - | - |
payload.item.targetCurrencyCode | string | The target currency code of coin Item | - | - | - |
payload.item.targetItemId | string | Target item id if this item is mapping from game namespace | - | - | - |
payload.item.regionData | object | Item region data | - | - | - |
payload.item.regionData (additional properties) | array<object> | - | - | - | - |
payload.item.regionData.price | integer | - | - | format (int32 ) | required |
payload.item.regionData.discountPercentage | integer | - | - | format (int32 ), [ 0 .. 100 ] | - |
payload.item.regionData.discountAmount | integer | - | - | format (int32 ), >= 0 | - |
payload.item.regionData.discountedPrice | integer | - | - | format (int32 ) | - |
payload.item.regionData.currencyCode | string | currency code | - | - | required |
payload.item.regionData.currencyType | string | currency type | - | - | required |
payload.item.regionData.currencyNamespace | string | currency namespace | - | - | required |
payload.item.regionData.purchaseAt | string | PurchaseAt | - | format (date-time ) | - |
payload.item.regionData.expireAt | string | ExpireAt | - | format (date-time ) | - |
payload.item.regionData.discountPurchaseAt | string | Discount purchase date time | - | format (date-time ) | - |
payload.item.regionData.discountExpireAt | string | Discount expire date time | - | format (date-time ) | - |
payload.item.itemIds | array<string> | Bundle item's item ids | - | - | - |
payload.item.itemIds (single item) | string | - | - | - | - |
payload.item.itemQty | object | itemQty, 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.tags | array<string> | Tags | - | - | - |
payload.item.tags (single item) | string | - | - | - | - |
payload.item.features | array<string> | Features | - | - | - |
payload.item.features (single item) | string | - | - | - | - |
payload.item.maxCountPerUser | integer | Max count per user | - | format (int32 ) | - |
payload.item.maxCount | integer | Max count | - | format (int32 ) | - |
payload.item.clazz | string | customized item clazz | - | - | - |
payload.item.ext | object | customized item properties | - | - | - |
payload.item.ext (additional properties) | object | - | - | - | additional properties are allowed |
payload.item.boothName | string | booth name to get tickets while it's item type is CODE | - | - | - |
payload.item.ticketBoothId | string | booth id while item type is CODE | - | - | - |
payload.item.displayOrder | integer | display order | - | format (int32 ) | - |
payload.item.createdAt | string | created at | - | format (date-time ) | - |
payload.item.updatedAt | string | updated at | - | format (date-time ) | - |
payload.item.purchaseCondition | object | purchase condition | - | - | additional properties are allowed |
payload.item.optionBoxConfig | object | option box configurations | - | - | additional properties are allowed |
payload.item.flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE | - | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | store id | - | - | - |
payload.itemStatusChange | object | - | - | - | additional properties are allowed |
payload.itemStatusChange.itemId | string | item id | - | - | - |
payload.itemStatusChange.itemName | string | item name | - | - | - |
payload.itemStatusChange.status | string | item status | allowed ("ACTIVE" , "INACTIVE" ) | - | - |
payload.itemStatusChange.previousStatus | string | item status before change | allowed ("ACTIVE" , "INACTIVE" ) | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | - | - | - | - |
payload.itemStatusChange | object | - | - | - | additional properties are allowed |
payload.itemStatusChange.itemId | string | item id | - | - | - |
payload.itemStatusChange.itemName | string | item name | - | - | - |
payload.itemStatusChange.status | string | item status | allowed ("ACTIVE" , "INACTIVE" ) | - | - |
payload.itemStatusChange.previousStatus | string | item status before change | allowed ("ACTIVE" , "INACTIVE" ) | - | - |
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": {
"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
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.storeId | string | - | - | - | - |
payload.app | object | - | - | - | additional properties are allowed |
payload.app.itemId | string | item id | - | - | - |
payload.app.namespace | string | namespace | - | - | - |
payload.app.carousel | array<object> | - | - | - | - |
payload.app.carousel.type | string | slide type | allowed ("image" , "video" ) | - | - |
payload.app.carousel.videoSource | string | video source | allowed ("generic" , "youtube" , "vimeo" ) | - | - |
payload.app.carousel.url | string | video url | - | - | - |
payload.app.carousel.alt | string | - | - | - | - |
payload.app.carousel.thumbnailUrl | string | thumbnail url | - | - | - |
payload.app.carousel.previewUrl | string | preview url | - | - | - |
payload.app.developer | string | developer info | - | - | - |
payload.app.publisher | string | publisher info | - | - | - |
payload.app.websiteUrl | string | website url | - | - | - |
payload.app.forumUrl | string | forum url | - | - | - |
payload.app.platforms | array<string> | platform info, Windows/MacOS/Linux/IOS/Android | - | - | - |
payload.app.platforms (single item) | string | - | - | - | - |
payload.app.platformRequirements | object | platform requirements | - | - | - |
payload.app.platformRequirements (additional properties) | array<object> | - | - | - | - |
payload.app.platformRequirements.label | string | label, value can be:minimum,recommended | - | - | required |
payload.app.platformRequirements.osVersion | string | OS version | - | - | - |
payload.app.platformRequirements.processor | string | processor | - | - | - |
payload.app.platformRequirements.ram | string | RAM | - | - | - |
payload.app.platformRequirements.graphics | string | graphics | - | - | - |
payload.app.platformRequirements.directXVersion | string | directX version | - | - | - |
payload.app.platformRequirements.diskSpace | string | disk space | - | - | - |
payload.app.platformRequirements.soundCard | string | sound card | - | - | - |
payload.app.platformRequirements.additionals | string | other requirement | - | - | - |
payload.app.localizations | object | localization info | - | - | - |
payload.app.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.app.localizations.slogan | string | - | - | - | - |
payload.app.localizations.announcement | string | - | - | - | - |
payload.app.primaryGenre | string | primary genre type | allowed ("Action" , "Adventure" , "Casual" , "FreeToPlay" , "Indie" , "MassivelyMultiplayer" , "Racing" , "RPG" , "Simulation" , "Sports" , "Strategy" ) | - | - |
payload.app.genres | array<string> | genre types | - | - | - |
payload.app.genres (single item) | string | - | - | - | - |
payload.app.players | array<string> | player type | - | - | - |
payload.app.players (single item) | string | - | allowed ("Single" , "Multi" , "CrossPlatformMulti" , "MMO" , "Coop" , "LocalCoop" ) | - | - |
payload.app.releaseDate | string | release date | - | format (date-time ) | - |
payload.oldApp | object | - | - | - | additional properties are allowed |
payload.oldApp.itemId | string | item id | - | - | - |
payload.oldApp.namespace | string | namespace | - | - | - |
payload.oldApp.carousel | array<object> | - | - | - | - |
payload.oldApp.carousel.type | string | slide type | allowed ("image" , "video" ) | - | - |
payload.oldApp.carousel.videoSource | string | video source | allowed ("generic" , "youtube" , "vimeo" ) | - | - |
payload.oldApp.carousel.url | string | video url | - | - | - |
payload.oldApp.carousel.alt | string | - | - | - | - |
payload.oldApp.carousel.thumbnailUrl | string | thumbnail url | - | - | - |
payload.oldApp.carousel.previewUrl | string | preview url | - | - | - |
payload.oldApp.developer | string | developer info | - | - | - |
payload.oldApp.publisher | string | publisher info | - | - | - |
payload.oldApp.websiteUrl | string | website url | - | - | - |
payload.oldApp.forumUrl | string | forum url | - | - | - |
payload.oldApp.platforms | array<string> | platform info, Windows/MacOS/Linux/IOS/Android | - | - | - |
payload.oldApp.platforms (single item) | string | - | - | - | - |
payload.oldApp.platformRequirements | object | platform requirements | - | - | - |
payload.oldApp.platformRequirements (additional properties) | array<object> | - | - | - | - |
payload.oldApp.platformRequirements.label | string | label, value can be:minimum,recommended | - | - | required |
payload.oldApp.platformRequirements.osVersion | string | OS version | - | - | - |
payload.oldApp.platformRequirements.processor | string | processor | - | - | - |
payload.oldApp.platformRequirements.ram | string | RAM | - | - | - |
payload.oldApp.platformRequirements.graphics | string | graphics | - | - | - |
payload.oldApp.platformRequirements.directXVersion | string | directX version | - | - | - |
payload.oldApp.platformRequirements.diskSpace | string | disk space | - | - | - |
payload.oldApp.platformRequirements.soundCard | string | sound card | - | - | - |
payload.oldApp.platformRequirements.additionals | string | other requirement | - | - | - |
payload.oldApp.localizations | object | localization info | - | - | - |
payload.oldApp.localizations (additional properties) | object | - | - | - | additional properties are allowed |
payload.oldApp.localizations.slogan | string | - | - | - | - |
payload.oldApp.localizations.announcement | string | - | - | - | - |
payload.oldApp.primaryGenre | string | primary genre type | allowed ("Action" , "Adventure" , "Casual" , "FreeToPlay" , "Indie" , "MassivelyMultiplayer" , "Racing" , "RPG" , "Simulation" , "Sports" , "Strategy" ) | - | - |
payload.oldApp.genres | array<string> | genre types | - | - | - |
payload.oldApp.genres (single item) | string | - | - | - | - |
payload.oldApp.players | array<string> | player type | - | - | - |
payload.oldApp.players (single item) | string | - | allowed ("Single" , "Multi" , "CrossPlatformMulti" , "MMO" , "Coop" , "LocalCoop" ) | - | - |
payload.oldApp.releaseDate | string | release date | - | format (date-time ) | - |
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": {
"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"
}