Skip to main content

Partner Activatable Products

Details on the products you are currently selling in your store.

idstringrequired

Unique identifier of the record.

Example: MP-1234:EDITION-123
typestringrequired

Should always be partnerActivatableProducts.

Possible values: [partnerActivatableProducts]

Default value: partnerActivatableProducts
relationships object
allowedCountries object

Allowed list of countries as 2-letter codes where the product can be sold. If empty, its allowed for any country. Country name from the code can be obtained with Countries API

data object[]
  • Array [
    • idstring
    Example: US
    typestring

    Possible values: [countries]

    Default value: countries
  • ]
    • requiredProducts object

    List of IDs of the products to be activated before activating this product.

    data object[]
  • Array [
    • idstring
    Example: ABC:default:MP-456:EDITION-456
    typestring

    Possible values: [partnerActivatableProducts]

    Default value: partnerActivatableProducts
  • ]
    • attributes object
    skustring

    The unique identifier of a product, product edition or package. It can be obtained by following this guide.

    Example: MP-1234:EDITION-123
    namestring

    Vendor provided name for the product.

    Example: Product Name
    whiteLabelNamestring

    Custom name for the product set by the Partner.

    Example: Custom Product Name
    iconUrluri

    Product logo url. Url to the jpg or png image with 1:1 aspect ratio. (Recommended: 240px x 240px).

    taglinestring

    Briefly describes what the product does.

    Example: Short Description
    bannerImageUrluri

    Url to access the large rectangular image at the top of the marketing page.

    prices object[]

    Describes the price of the product.

  • Array [
    • frequencystring

    Billing frequency of the product.

    typestring

    Denotes the type of price.

    Example: retail
    currencyCodestring

    Type of currency (code) of the price.

    Example: CAD
    amountnumber

    The cost of the product.

    Example: 42
  • ]
    • Partner Activatable Products
    {
      "id": "MP-1234:EDITION-123",
      "type": "partnerActivatableProducts",
      "relationships": {
        "allowedCountries": {
          "data": [
            {
              "id": "US",
              "type": "countries"
            }
          ]
        },
        "requiredProducts": {
          "data": [
            {
              "id": "ABC:default:MP-456:EDITION-456",
              "type": "partnerActivatableProducts"
            }
          ]
        }
      },
      "attributes": {
        "sku": "MP-1234:EDITION-123",
        "name": "Product Name",
        "whiteLabelName": "Custom Product Name",
        "iconUrl": "string",
        "tagline": "Short Description",
        "bannerImageUrl": "string",
        "prices": [
          {
            "frequency": "string",
            "type": "retail",
            "currencyCode": "CAD",
            "amount": 42
          }
        ]
      }
    }