Master Data Reference of GS2-Showcase
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]Product Name",
"metadata": "[string?]metadata",
"salesPeriodEventId": "[string?]GS2-Schedule events with sales periods for display shelves",
"displayItems": [
{
"displayItemId": "[string]Displayed Item ID",
"type": "[string]Type",
"salesItem": {
"name": "[string]Product Name",
"metadata": "[string?]metadata",
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the stamp task",
"request": "[string]JSON of the obtain request"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the stamp sheet",
"request": "[string]JSON of request"
}
]
},
"salesItemGroup": {
"name": "[string]Product Group Name",
"metadata": "[string?]metadata",
"salesItems": [
{
"name": "[string]Product Name",
"metadata": "[string?]metadata",
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the stamp task",
"request": "[string]JSON of the obtain request"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the stamp sheet",
"request": "[string]JSON of request"
}
]
}
]
},
"salesPeriodEventId": "[string?]GS2-Schedule events with product sales periods"
}
]
}
]
}
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
version | ✓ | 2019-04-04 | Format version of master data | ||
showcases | List<Showcase> |
SalesItem
Showcase
Set the price required to purchase the product and the reward earned for the purchase of the product.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Product Name | |
metadata | string | ~ 2048 chars | metadata | ||
consumeActions | List<ConsumeAction> | List of Consumption Action | |||
acquireActions | List<AcquireAction> | ✓ | List of Acquire Action |
SalesItemGroup
Product Group
A product group is an entity for display on a showcase. The first product that is determined to be available for purchase is actually displayed on the shelves. This can be used for products that are discounted only for the first time, or for a system in which the contents of products change depending on the number of times they are purchased, such as a step-up gacha.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Product Group Name | |
metadata | string | ~ 2048 chars | metadata | ||
salesItems | List<SalesItem> | ✓ | Products to be included in the product group |
Showcase
Showcase
The sales period can be set for the display shelf.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
showcaseId | string | ✓ | ~ 1024 chars | Showcase GRN | |
name | string | ✓ | ~ 128 chars | Product Name | |
metadata | string | ~ 2048 chars | metadata | ||
salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule events with sales periods for display shelves | ||
displayItems | List<DisplayItem> | ✓ | List of Products on display |
DisplayItem
Displayed Item
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID |
type | enum [‘salesItem’, ‘salesItemGroup’] | ✓ | ~ 128 chars | Type | |
salesItem | SalesItem | {type} == “salesItem” | Products to be displayed | ||
salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | Product group to be displayed | ||
salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule events with product sales periods |
DisplayItemMaster
Displayed Item
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID |
type | enum [‘salesItem’, ‘salesItemGroup’] | ✓ | ~ 128 chars | Type | |
salesItemName | string | {type} == “salesItem” | ~ 128 chars | Name of the product to be displayed | |
salesItemGroupName | string | {type} == “salesItemGroup” | ~ 128 chars | Name of the product group to be displayed | |
salesPeriodEventId | string | ~ 1024 chars | Product group to be displayed |
ConsumeAction
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
action | enum [] | ✓ | ~ 128 chars | Types of actions to be performed in the stamp task | |
request | string | ✓ | ~ 1048576 chars | JSON of the obtain request |
AcquireAction
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
action | enum [] | ✓ | ~ 128 chars | Types of actions to be performed in the stamp sheet | |
request | string | ✓ | ~ 1048576 chars | JSON of request |