Market Product

Description

A market product.

Properties

Property Description
bundleProducts

If isBundle is true, bundleProducts will contain an array of market products. If there are no bundle products, this will be false.

created

The date and time at which the order was made.

currencyCode

Identifies the currency represented in price.

description

A description that provides more information about this market product.

hasPurchased

Whether the studio has previously purchased this market product.

id

The identifier for this market product.

isBundle

Whether this market product is a bundle of multiple market products.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

marketDepartment

The human-readable name for the market department for this market product.

marketDepartmentId

The numeric identifier for the market department for this market product.

marketProductIconUrl

The URL for an icon representing this market product.

marketProductStatusId

The numeric identifier for the market product status.

marketProductType

The human-readable name for the market product type.

marketProductTypeId

The numeric identifier for the market product type.

marketVendor

The human-readable name for the market vendor for this market product.

marketVendorId

The numeric identifier for the market vendor for this market product.

name

The name of this market product.

price

The price of this market product in the currency identified in currencyCode.

type

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A market product.",
  "properties": {
    "bundleProducts": {
      "description": "If `isBundle` is `true`, `bundleProducts` will contain an array of\nmarket products. If there are no bundle products, this will be\n`false`.",
      "oneOf": [
        {
          "items": {
            "$ref": "#/components/schemas/MarketProduct"
          },
          "title": "Market Product",
          "type": "array"
        },
        {
          "description": "If this is not a bundle of products, `bundleProducts` will be `false`.",
          "type": "boolean"
        }
      ]
    },
    "created": {
      "description": "The date and time at which the order was made.",
      "format": "date-time",
      "type": "string"
    },
    "currencyCode": {
      "description": "Identifies the currency represented in `price`.",
      "type": "string"
    },
    "description": {
      "description": "A description that provides more information about this market\nproduct.",
      "type": "string"
    },
    "hasPurchased": {
      "description": "Whether the studio has previously purchased this market product.",
      "type": "boolean"
    },
    "id": {
      "description": "The identifier for this market product.",
      "type": "integer"
    },
    "isBundle": {
      "description": "Whether this market product is a bundle of multiple market products.",
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "marketDepartment": {
      "description": "The human-readable name for the market department for this market\nproduct.",
      "type": "string"
    },
    "marketDepartmentId": {
      "description": "The numeric identifier for the market department for this market\nproduct.",
      "type": "integer"
    },
    "marketProductIconUrl": {
      "description": "The URL for an icon representing this market product.",
      "format": "uri",
      "type": "string"
    },
    "marketProductStatusId": {
      "description": "The numeric identifier for the market product status.",
      "type": "integer"
    },
    "marketProductType": {
      "description": "The human-readable name for the market product type.",
      "type": "string"
    },
    "marketProductTypeId": {
      "description": "The numeric identifier for the market product type.",
      "type": "integer"
    },
    "marketVendor": {
      "description": "The human-readable name for the market vendor for this market\nproduct.",
      "type": "string"
    },
    "marketVendorId": {
      "description": "The numeric identifier for the market vendor for this market\nproduct.",
      "type": "integer"
    },
    "name": {
      "description": "The name of this market product.",
      "type": "string"
    },
    "price": {
      "description": "The price of this market product in the currency identified in\n`currencyCode`.",
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "market-product"
      ],
      "type": "string"
    }
  },
  "title": "Market Product",
  "type": "object"
}