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"
        }
      ]
    }
  ]
}
TypeRequireDefaultLimitationDescription
version2019-04-04Format version of master data
showcasesList<Showcase>

SalesItem

Showcase

Set the price required to purchase the product and the reward earned for the purchase of the product.

TypeRequireDefaultLimitationDescription
namestring~ 128 charsProduct Name
metadatastring~ 2048 charsmetadata
consumeActionsList<ConsumeAction>List of Consumption Action
acquireActionsList<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.

TypeRequireDefaultLimitationDescription
namestring~ 128 charsProduct Group Name
metadatastring~ 2048 charsmetadata
salesItemsList<SalesItem>Products to be included in the product group

Showcase

Showcase

The sales period can be set for the display shelf.

TypeRequireDefaultLimitationDescription
showcaseIdstring~ 1024 charsShowcase GRN
namestring~ 128 charsProduct Name
metadatastring~ 2048 charsmetadata
salesPeriodEventIdstring~ 1024 charsGS2-Schedule events with sales periods for display shelves
displayItemsList<DisplayItem>List of Products on display

DisplayItem

Displayed Item

TypeRequireDefaultLimitationDescription
displayItemIdstringUUID~ 128 charsDisplayed Item ID
typeenum [‘salesItem’, ‘salesItemGroup’]~ 128 charsType
salesItemSalesItem{type} == “salesItem”Products to be displayed
salesItemGroupSalesItemGroup{type} == “salesItemGroup”Product group to be displayed
salesPeriodEventIdstring~ 1024 charsGS2-Schedule events with product sales periods

DisplayItemMaster

Displayed Item

TypeRequireDefaultLimitationDescription
displayItemIdstringUUID~ 128 charsDisplayed Item ID
typeenum [‘salesItem’, ‘salesItemGroup’]~ 128 charsType
salesItemNamestring{type} == “salesItem”~ 128 charsName of the product to be displayed
salesItemGroupNamestring{type} == “salesItemGroup”~ 128 charsName of the product group to be displayed
salesPeriodEventIdstring~ 1024 charsProduct group to be displayed

ConsumeAction

TypeRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp task
requeststring~ 1048576 charsJSON of the obtain request

AcquireAction

TypeRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request