Skip to main content

AsyncAPI for catalog service 0.0.1 documentation

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

NameTypeDescription
storestore-

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

NameTypeDescription
storestore-
oldStorestore-

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

NameTypeDescription
storestore-

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

NameTypeDescription
storeIdstringstore id
storeCloneobject-
payload.storeClone
NameTypeDescription
targetStoreIdstringthe target store id
publishedbooleantrue 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

NameTypeDescription
storeIdstringstore 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

NameTypeDescription
storeIdstringstore 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

NameTypeDescription
storeIdstringstore 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

NameTypeDescription
storeIdstringstore id
storePublishSchemaobject-
payload.storePublishSchema
NameTypeDescription
namespacestringnamespace
storeIdstringstore id
incrementalbooleana flag indicates whether publish store incrementally
catalogChangesarray<object>-
payload.storePublishSchema.catalogChanges[number]
NameTypeDescription
storeIdstringpublished store id
changeIdstringid for this change
itemTypestringtype of the item
itemIdstringitem id if this is a item change
skustringsku of item
viewIdstringview id if this is a view change
sectionIdstringsection id if this is a section change
categoryPathstringcategory path if there is a category change
actionstringchange 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

NameTypeDescription
storeIdstring-
categorycategory-

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

NameTypeDescription
storeIdstring-
categorycategory-
oldCategorycategory-

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

NameTypeDescription
storeIdstringstore id
categorycategory-

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

NameTypeDescription
storeIdstring-
itemitem-

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

NameTypeDescription
storeIdstringstore id
itemitem-
oldItemitem-

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

NameTypeDescription
storeIdstringstore id
itemitem-

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

NameTypeDescription
storeIdstringstore id
itemitem-

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

NameTypeDescription
storeIdstringstore id
itemStatusChangeitemStatusChange-

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

NameTypeDescription
storeIdstring-
itemStatusChangeitemStatusChange-

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

NameTypeDescription
storeIdstring-
appapp-
oldAppapp-

Schemas

conditionGroups

NameTypeDescription
predicatesarray<object>-
operatorstring-

predicates[number]

NameTypeDescription
namestringpredicate name
predicateTypestringpredicate type
comparisonstringcomparison
anyOfintegeranyOf, only available if comparison is includes or excludes
valuesarray<object>values, when predicateType is EntitlementPredicate or SeasonPassPredicate
valuestringvalue, when predicateType is SeasonTierPredicate

predicates[number].values[number]

This is a free-form object.

store

NameTypeDescription
storeIdstringStore id
namespacestringThe namespace
titlestringStore title
descriptionstringStore description
publishedbooleanIf Store is published
supportedLanguagesarrayStore supported language
supportedRegionsarrayStore supported regions
defaultRegionstringDefault region
defaultLanguagestringDefault language
publishedTimestring (date-time)Store published time
createdAtstring (date-time)-
updatedAtstring (date-time)-

category

NameTypeDescription
namespacestringCategory namespace
parentCategoryPathstringParent category path
categoryPathstringCategory path
isRootboolean-
localizationDisplayNamesobjectCategory localization display name
createdAtstring (date-time)-
updatedAtstring (date-time)-

localizationDisplayNames

This is a free-form object.

item

NameTypeDescription
itemIdstringItem id
appIdstringApp id
appTypestringApp type
baseAppIdstringBase app id
baseAppItemIdstringItem id of base app
namespacestringItem namespace
skustringSku
namestringName
entitlementTypestringEntitlement type
useCountinteger (int32)Item use count
stackablebooleanWhether stack the CONSUMABLE entitlement
categoryPathstringItem category path
imagesarray<object>images
thumbnailUrlstringthumbnail url
localizationsobjectItem localizations
statusstringItem status
listablebooleanwhether it is visible in Store for public user
purchasablebooleanwhether it can be purchased
sectionExclusivebooleanwhether this item is sold in section only
itemTypestringItem type
targetNamespacestringThe target namespace of a cross namespace item
targetCurrencyCodestringThe target currency code of coin Item
targetItemIdstringTarget item id if this item is mapping from game namespace
regionDataobjectItem region data
itemIdsarrayBundle item's item ids
itemQtyobjectitemQty, the quantity of item in itemIds, default 1, should be empty if item type is not "BUNDLE"
tagsarrayTags
featuresarrayFeatures
maxCountPerUserinteger (int32)Max count per user
maxCountinteger (int32)Max count
clazzstringcustomized item clazz
extobjectcustomized item properties
boothNamestringbooth name to get tickets while it's item type is CODE
ticketBoothIdstringbooth id while item type is CODE
displayOrderinteger (int32)display order
createdAtstring (date-time)created at
updatedAtstring (date-time)updated at
purchaseConditionobjectpurchase condition
optionBoxConfigobjectoption box configurations
flexiblebooleanwhether flexible pricing applied, only applied if itemType is BUNDLE

images[number]

NameTypeDescription
asstringimage for
captionstringimage caption
heightinteger (int32)height
widthinteger (int32)width
imageUrlstringimageUrl
smallImageUrlstringsmallImageUrl

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

NameTypeDescription
itemIdstringitem id
itemNamestringitem name
statusstringitem status
previousStatusstringitem status before change

app

NameTypeDescription
itemIdstringitem id
namespacestringnamespace
carouselarray<object>-
developerstringdeveloper info
publisherstringpublisher info
websiteUrlstringwebsite url
forumUrlstringforum url
platformsarrayplatform info, Windows/MacOS/Linux/IOS/Android
platformRequirementsobjectplatform requirements
localizationsobjectlocalization info
primaryGenrestringprimary genre type
genresarraygenre types
playersarrayplayer type
releaseDatestring (date-time)release date

carousel[number]

NameTypeDescription
typestringslide type
videoSourcestringvideo source
urlstringvideo url
altstring-
thumbnailUrlstringthumbnail url
previewUrlstringpreview url

platformRequirements

This is a free-form object.

localizations

This is a free-form object.

event

NameTypeDescription
idstringevent id
versioninteger-
namestringevent name
namespacestringevent namespace
parentNamespacestring-
timestampstring (date-time)-
clientIdstringclient id
userIdstringthe operator id
traceIdstringtrace id
sessionIdstringsession id