AsyncAPI for catalog service 0.0.1 documentation
- Protobuf File Spec: ecommerce.proto
Published Messages (catalogManagement)
The service publishes one of these messages below.
storeCreated
Message is sent when store is created. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
store | store | - |
storeUpdated
Message is sent when store is updated. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
store | store | - |
oldStore | store | - |
storeDeleted
Message is sent when store is deleted. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
store | store | - |
storeCloned
Message is sent when clone a store. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
storeClone | object | - |
payload.storeClone
Name | Type | Description |
---|---|---|
targetStoreId | string | the target store id |
published | boolean | true if the target store is a published store |
storeRollbacked
Message is sent when roll back a published store to a previous version. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
storeExported
Message is sent when store is exported. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
storeImported
Message is sent when store is imported. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
storePublished
Message is sent when publish store. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
storePublishSchema | object | - |
payload.storePublishSchema
Name | Type | Description |
---|---|---|
namespace | string | namespace |
storeId | string | store id |
incremental | boolean | a flag indicates whether publish store incrementally |
catalogChanges | array<object> | - |
payload.storePublishSchema.catalogChanges[number]
Name | Type | Description |
---|---|---|
storeId | string | published store id |
changeId | string | id for this change |
itemType | string | type of the item |
itemId | string | item id if this is a item change |
sku | string | sku of item |
viewId | string | view id if this is a view change |
sectionId | string | section id if this is a section change |
categoryPath | string | category path if there is a category change |
action | string | change action |
categoryCreated
Message is sent when category is created. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | - |
category | category | - |
categoryUpdated
Message is sent when category is updated. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | - |
category | category | - |
oldCategory | category | - |
categoryDeleted
Message is sent when category is deleted. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
category | category | - |
itemCreated
Message is sent when item is created. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | - |
item | item | - |
itemUpdated
Message is sent when item is updated. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
item | item | - |
oldItem | item | - |
itemDeleted
Message is sent when item is deleted. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
item | item | - |
inGameItemSynced
Message is sent when sync in game item from game namespace to publisher namespace. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
item | item | - |
itemDisabled
Message is sent when item is disabled. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | store id |
itemStatusChange | itemStatusChange | - |
itemEnabled
Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | - |
itemStatusChange | itemStatusChange | - |
appUpdated
Message is sent when an app is updated. Contains fields from event and the following payload.
Example value
{
"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"
}
payload
Name | Type | Description |
---|---|---|
storeId | string | - |
app | app | - |
oldApp | app | - |
Schemas
conditionGroups
Name | Type | Description |
---|---|---|
predicates | array<object> | - |
operator | string | - |
predicates[number]
Name | Type | Description |
---|---|---|
name | string | predicate name |
predicateType | string | predicate type |
comparison | string | comparison |
anyOf | integer | anyOf, only available if comparison is includes or excludes |
values | array<object> | values, when predicateType is EntitlementPredicate or SeasonPassPredicate |
value | string | value, when predicateType is SeasonTierPredicate |
predicates[number].values[number]
This is a free-form object.
store
Name | Type | Description |
---|---|---|
storeId | string | Store id |
namespace | string | The namespace |
title | string | Store title |
description | string | Store description |
published | boolean | If Store is published |
supportedLanguages | array | Store supported language |
supportedRegions | array | Store supported regions |
defaultRegion | string | Default region |
defaultLanguage | string | Default language |
publishedTime | string (date-time) | Store published time |
createdAt | string (date-time) | - |
updatedAt | string (date-time) | - |
category
Name | Type | Description |
---|---|---|
namespace | string | Category namespace |
parentCategoryPath | string | Parent category path |
categoryPath | string | Category path |
isRoot | boolean | - |
localizationDisplayNames | object | Category localization display name |
createdAt | string (date-time) | - |
updatedAt | string (date-time) | - |
localizationDisplayNames
This is a free-form object.
item
Name | Type | Description |
---|---|---|
itemId | string | Item id |
appId | string | App id |
appType | string | App type |
baseAppId | string | Base app id |
baseAppItemId | string | Item id of base app |
namespace | string | Item namespace |
sku | string | Sku |
name | string | Name |
entitlementType | string | Entitlement type |
useCount | integer (int32) | Item use count |
stackable | boolean | Whether stack the CONSUMABLE entitlement |
categoryPath | string | Item category path |
images | array<object> | images |
thumbnailUrl | string | thumbnail url |
localizations | object | Item localizations |
status | string | Item status |
listable | boolean | whether it is visible in Store for public user |
purchasable | boolean | whether it can be purchased |
sectionExclusive | boolean | whether this item is sold in section only |
itemType | string | Item type |
targetNamespace | string | The target namespace of a cross namespace item |
targetCurrencyCode | string | The target currency code of coin Item |
targetItemId | string | Target item id if this item is mapping from game namespace |
regionData | object | Item region data |
itemIds | array | Bundle item's item ids |
itemQty | object | itemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE" |
tags | array | Tags |
features | array | Features |
maxCountPerUser | integer (int32) | Max count per user |
maxCount | integer (int32) | Max count |
clazz | string | customized item clazz |
ext | object | customized item properties |
boothName | string | booth name to get tickets while it's item type is CODE |
ticketBoothId | string | booth id while item type is CODE |
displayOrder | integer (int32) | display order |
createdAt | string (date-time) | created at |
updatedAt | string (date-time) | updated at |
purchaseCondition | object | purchase condition |
optionBoxConfig | object | option box configurations |
flexible | boolean | whether flexible pricing applied, only applied if itemType is BUNDLE |
images[number]
Name | Type | Description |
---|---|---|
as | string | image for |
caption | string | image caption |
height | integer (int32) | height |
width | integer (int32) | width |
imageUrl | string | imageUrl |
smallImageUrl | string | smallImageUrl |
localizations
This is a free-form object.
regionData
This is a free-form object.
itemQty
This is a free-form object.
ext
This is a free-form object.
purchaseCondition
This is a free-form object.
optionBoxConfig
This is a free-form object.
itemStatusChange
Name | Type | Description |
---|---|---|
itemId | string | item id |
itemName | string | item name |
status | string | item status |
previousStatus | string | item status before change |
app
Name | Type | Description |
---|---|---|
itemId | string | item id |
namespace | string | namespace |
carousel | array<object> | - |
developer | string | developer info |
publisher | string | publisher info |
websiteUrl | string | website url |
forumUrl | string | forum url |
platforms | array | platform info, Windows/MacOS/Linux/IOS/Android |
platformRequirements | object | platform requirements |
localizations | object | localization info |
primaryGenre | string | primary genre type |
genres | array | genre types |
players | array | player type |
releaseDate | string (date-time) | release date |
carousel[number]
Name | Type | Description |
---|---|---|
type | string | slide type |
videoSource | string | video source |
url | string | video url |
alt | string | - |
thumbnailUrl | string | thumbnail url |
previewUrl | string | preview url |
platformRequirements
This is a free-form object.
localizations
This is a free-form object.
event
Name | Type | Description |
---|---|---|
id | string | event id |
version | integer | - |
name | string | event name |
namespace | string | event namespace |
parentNamespace | string | - |
timestamp | string (date-time) | - |
clientId | string | client id |
userId | string | the operator id |
traceId | string | trace id |
sessionId | string | session id |