Stash Documentation
Integration GuidesAPI ReferencePartner with usChangelog

Get offer details

Retrieves detailed information about a specific offer, including reward details and tabbed content with structured data tables for each item.

GET
/api/v1/catalog/offer

Authorization

x-stash-hmac-signature<token>

Versioned HMAC-SHA256 signature for server-to-server communication between game backends and Stash services. Recommended over the deprecated legacyHmac scheme for the best security. Header format: v1;{shopId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} signed with your Egress API key, where {requestBody} is the compact request JSON. The timestamp must be within 5 minutes of Stash server time. Your shopId is your immutable shop identifier; it and your Egress API key are available in Stash Studio under Project Settings > API Secrets.

In: header

Query Parameters

guidstring

The offer/product UUID (auto-generated UUID v5 if not provided in catalog response)

productIdstring

The unique product identifier/SKU

platform?string

Optional platform filter to get platform-specific catalog offer details

  • CATALOG_PLATFORM_UNSPECIFIED: Default unknown platform
Value in"CATALOG_PLATFORM_UNSPECIFIED" | "CATALOG_PLATFORM_IOS" | "CATALOG_PLATFORM_ANDROID" | "CATALOG_PLATFORM_WEBSTORE"
region?string

Optional region filter using ISO-3166-1 alpha-2 country code (e.g., 'US', 'EU', 'JP')

language?string

Optional language code filter using ISO 639-1 code (e.g., 'en', 'es', 'fr', 'de')

playerId?string

Optional player ID filter to get player-specific catalog items

shopId?string

The originating Stash shop identifier (mirrors the shopId sent in webhooks)

environment?string

Payment environment for the request

Value in"PAYMENT_ENVIRONMENT_UNSPECIFIED" | "PAYMENT_ENVIRONMENT_TEST" | "PAYMENT_ENVIRONMENT_PRODUCTION"

Response Body

curl -X GET "https://loading/api/v1/catalog/offer?guid=string&productId=string&platform=CATALOG_PLATFORM_UNSPECIFIED&region=string&language=string&playerId=string&shopId=string&environment=PAYMENT_ENVIRONMENT_UNSPECIFIED"
{
  "items": [
    {
      "guid": "string",
      "title": {
        "defaultText": "string",
        "localizationKey": "string",
        "localizedText": "string"
      },
      "subtitle": {
        "defaultText": "string",
        "localizationKey": "string",
        "localizedText": "string"
      },
      "description": {
        "defaultText": "string",
        "localizationKey": "string",
        "localizedText": "string"
      },
      "image": "string",
      "iconImageUrl": "string",
      "detailSections": [
        {
          "header": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "subheader": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "rows": [
            {
              "backgroundStyle": {
                "property1": "string",
                "property2": "string"
              },
              "cells": [
                {
                  "text": {
                    "defaultText": "string",
                    "localizationKey": "string",
                    "localizedText": "string"
                  },
                  "iconImageUrl": "string",
                  "relativeWidthFractionalUnits": 0,
                  "backgroundStyle": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "textStyle": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "align": "CELL_ALIGNMENT_UNSPECIFIED"
                }
              ]
            }
          ]
        }
      ],
      "tabs": [
        {
          "title": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "default": true,
          "tables": [
            {
              "headers": [
                {
                  "text": {
                    "defaultText": "string",
                    "localizationKey": "string",
                    "localizedText": "string"
                  },
                  "relativeWidthFractionalUnits": 0,
                  "backgroundStyle": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "textStyle": {
                    "property1": "string",
                    "property2": "string"
                  }
                }
              ],
              "rows": [
                {
                  "backgroundStyle": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "cells": [
                    {
                      "text": {
                        "defaultText": "string",
                        "localizationKey": "string",
                        "localizedText": "string"
                      },
                      "subText": {
                        "defaultText": "string",
                        "localizationKey": "string",
                        "localizedText": "string"
                      },
                      "iconImageUrl": "string",
                      "backgroundStyle": {
                        "property1": "string",
                        "property2": "string"
                      },
                      "textStyle": {
                        "property1": "string",
                        "property2": "string"
                      },
                      "align": "CELL_ALIGNMENT_UNSPECIFIED"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "tabsHeader": {
        "defaultText": "string",
        "localizationKey": "string",
        "localizedText": "string"
      },
      "rewards": [
        {
          "title": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "subtitle": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "description": {
            "defaultText": "string",
            "localizationKey": "string",
            "localizedText": "string"
          },
          "image": "string",
          "featured": true,
          "primaryBackground": {
            "imageUrl": "string",
            "backgroundStyle": "string"
          },
          "secondaryBackground": {
            "imageUrl": "string",
            "backgroundStyle": "string"
          },
          "statistics": {
            "text": {
              "defaultText": "string",
              "localizationKey": "string",
              "localizedText": "string"
            },
            "textStyle": {
              "property1": "string",
              "property2": "string"
            },
            "iconImageUrl": "string"
          }
        }
      ],
      "lastUpdatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "rewardsHeader": {
    "title": {
      "defaultText": "string",
      "localizationKey": "string",
      "localizedText": "string"
    },
    "description": {
      "defaultText": "string",
      "localizationKey": "string",
      "localizedText": "string"
    },
    "iconImageUrl": "string"
  }
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?