Catalogs

Catalogs are where players can purchase items for their in-game account - they are assigned to a store and also include additional information such as a promotion image. On this page we'll dive into the different catalog endpoints you can use to manage catalogs programmatically.

The catalog model

The catalog model contains all the information about the active catalogs for stores.

Properties

Name
id
Type
integer
Description
Unique identifier for the catalog.
Name
name
Type
string
Description
Name for the catalog.
Name
promotion_image_url
Type
string
Description
Promotion image for the catalog.
Name
currencies
Type
array
Description
An array of currency objects associated with the catalog.

GET/catalogs/:id

Retrieve a catalog

This endpoint allows you to retrieve a catalog by providing the catalog id. Only catalogs that are currently assigned to a store are retrievable. Refer to the list at the top of this page to see which properties are included with catalog objects.

Request

GET

/catalogs/1

curl https://prod-app.themeparkshark.com/api/catalogs/1 \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"

Response

{
  "data": {
    "id": 1,
    "currencies": [
      {
        "id": 1,
        "name": "Coins",
        "singular_name": "Coin",
        "icon_url": "https://assets.themeparkshark.com/mobile/production/assets/image.png"
      }
    ],
    "name": "January Catalog",
    "promotion_image_url": "https://assets.themeparkshark.com/mobile/production/assets/image.png"
  }
}