Skip to content

Get marketplace

/marketing/marketplace

Target audience: Developers

Release version: 4.3.8

Attention

This API is still in active development and changes may occur to the response received.

Get marketplace

Introduction

This endpoint returns a configured marketplace. Read more on marketplaces here.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v2/marketing/marketplace
Production https://backend.worldoftulo.com/external/api/v2/marketing/marketplace

Requirements

Feature needs to be enabled by Adeprimo. Please contact support to enable.

Identity Scope
No /external/marketing/r

Parameters

Name Required Type Description
group Yes String The group key
Size range: 1..50 Allowed values: "/^[a-zA-Z-_.0-9]+$/"
key Yes String The marketplace key
Size range: 1..50 Allowed values: "/^[a-zA-Z-_.0-9]+$/"

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/marketing/marketplace?group=MP&key=M1 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token>'

Response

HTTP 200
{
  "item": {
    "group": {
      "name": "marketplace",
      "key": "MP"
    },
    "marketplace": {
      "name": "title",
      "key": "KEY",
      "image_url": "https://image_url",
      "image_link": "http://foobar.com",
      "rgb": "#fff",
      "header": "header",
      "description": "description"
    },
    "offers": [
      {
        "id": "60939c6409c04c02f15e9af2",
        "valid_from": "2020-05-06T09:36:04+02:00",
        "valid_to": "2022-05-06T09:36:04+02:00",
        "expired": false,
        "product_code": "campaign_code",
        "integration_code": "campaign_integration_code",
        "title_code": "TITLE_CODE",
        "name": "product_name",
        "description": "short_description",
        "additional_short_description": "additional_short_description",
        "image_url": "https://cdn_url/Image/adeprimo/campaign_code",
        "vat_code": 25,
        "type": "campaign",
        "transform_to_package": true,
        "customer_can_cancel": false,
        "tags": [
          {
            "name": "campaign_tag",
            "type": "package"
          }
        ],
        "price_periods": [
          {
            "id": "60939c6409c04c02f15e9af3",
            "payment_method": "creditcard",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9af3",
              "transition_period_id": "60939c6409c04c02f15e9ae6",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "total_price": "210 kr",
              "description_without_price": "första månaden, därefter 210 kr / månad",
              "localized_description": "210 kr första månaden, därefter 210 kr / månad",
              "localized_per_type_description": "210 kr / månad"
            },
            "transition_price_period_id": "60939c6409c04c02f15e9ae6"
          },
          {
            "id": "60939c6409c04c02f15e9af6",
            "payment_method": "adyen",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9af6",
              "transition_period_id": "60939c6409c04c02f15e9aec",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "total_price": "210 kr",
              "description_without_price": "/ månad första tre månaderna, därefter 210 kr / månad",
              "localized_description": "210 kr / månad första tre månaderna, därefter 210 kr / månad",
              "localized_per_type_description": "210 kr / månad"
            },
            "transition_price_period_id": "60939c6409c04c02f15e9aec"
          },
          {
            "id": "60939c6409c04c02f15e9af9",
            "payment_method": "klarna_payments",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9af9",
              "transition_period_id": "60939c6409c04c02f15e9ae9",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "total_price": "210 kr",
              "description_without_price": "/ månad första två månaderna, därefter 210 kr / månad",
              "localized_description": "210 kr / månad första två månaderna, därefter 210 kr / månad",
              "localized_per_type_description": "210 kr / månad"
            },
            "transition_price_period_id": "60939c6409c04c02f15e9ae9"
          },
          {
            "id": "60939c6409c04c02f15e9afc",
            "payment_method": "invoice",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9afc",
              "transition_period_id": null,
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "total_price": "210 kr",
              "description_without_price": "första månaden, därefter ordinarie pris",
              "localized_description": "210 kr första månaden, därefter ordinarie pris",
              "localized_per_type_description": "210 kr / månad"
            }
          }
        ],
        "based_on_package": {
          "id": "60939c6409c04c02f15e9ae2",
          "valid_from": "2020-05-06T09:36:04+02:00",
          "valid_to": "2022-05-06T09:36:04+02:00",
          "expired": false,
          "product_code": "package_code",
          "integration_code": "package_integration_code",
          "title_code": "TITLE_CODE",
          "name": "product_name",
          "description": "short_description",
          "additional_short_description": "additional_short_description",
          "image_url": "https://cdn_url/Image/adeprimo/package_code",
          "vat_code": 25,
          "type": "package",
          "customer_can_cancel": false,
          "products": [
            {
              "id": "60939c6409c04c02f15e9ae3",
              "product_code": "embedded_product_code",
              "name": "product_name",
              "description": "short_description",
              "image_url": "https://cdn_url/Image/organisation/embedded_product_code",
              "print_product": true
            }
          ],
          "tags": [
            {
              "name": "package_tag",
              "type": "package"
            }
          ],
          "price_periods": [
            {
              "id": "60939c6409c04c02f15e9ae6",
              "payment_method": "creditcard",
              "type": "recurring",
              "enabled": true,
              "iteration_type": "month",
              "iteration_length": 1,
              "price": 210,
              "price_description": {
                "period_id": "60939c6409c04c02f15e9ae6",
                "price": "210 kr",
                "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
                "localized_description": "Pris per månad"
              }
            },
            {
              "id": "60939c6409c04c02f15e9ae9",
              "payment_method": "klarna_payments",
              "type": "recurring",
              "enabled": true,
              "iteration_type": "month",
              "iteration_length": 1,
              "price": 210,
              "price_description": {
                "period_id": "60939c6409c04c02f15e9ae9",
                "price": "210 kr",
                "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
                "localized_description": "Pris per månad"
              }
            },
            {
              "id": "60939c6409c04c02f15e9aec",
              "payment_method": "adyen",
              "type": "recurring",
              "enabled": true,
              "iteration_type": "month",
              "iteration_length": 1,
              "price": 210,
              "price_description": {
                "period_id": "60939c6409c04c02f15e9aec",
                "price": "210 kr",
                "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
                "localized_description": "Pris per månad"
              }
            },
            {
              "id": "60939c6409c04c02f15e9aef",
              "payment_method": "klarna_payments",
              "type": "limited",
              "enabled": true,
              "iteration_type": "day",
              "iteration_length": 30,
              "price": 210,
              "price_description": {
                "period_id": "60939c6409c04c02f15e9aef",
                "price": "210 kr",
                "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
                "localized_description": "Pris per 30 dagar"
              }
            }
          ]
        },
        "cheapest_price_period_id": "60939c6409c04c02f15e9af3",
        "cheapest_based_on_package_price_period_id": "60939c6409c04c02f15e9ae6"
      },
      {
        "id": "60939c6409c04c02f15e9ae2",
        "valid_from": "2020-05-06T09:36:04+02:00",
        "valid_to": "2022-05-06T09:36:04+02:00",
        "expired": false,
        "product_code": "package_code",
        "integration_code": "package_integration_code",
        "title_code": "TITLE_CODE",
        "name": "product_name",
        "description": "short_description",
        "additional_short_description": "additional_short_description",
        "image_url": "https://cdn_url/Image/adeprimo/package_code",
        "vat_code": 25,
        "type": "package",
        "customer_can_cancel": false,
        "products": [
          {
            "id": "60939c6409c04c02f15e9ae3",
            "product_code": "embedded_product_code",
            "name": "product_name",
            "description": "short_description",
            "image_url": "https://cdn_url/Image/organisation/embedded_product_code",
            "print_product": true
          }
        ],
        "tags": [
          {
            "name": "package_tag",
            "type": "package"
          }
        ],
        "price_periods": [
          {
            "id": "60939c6409c04c02f15e9ae6",
            "payment_method": "creditcard",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9ae6",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "localized_description": "Pris per månad"
            }
          },
          {
            "id": "60939c6409c04c02f15e9ae9",
            "payment_method": "klarna_payments",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9ae9",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "localized_description": "Pris per månad"
            }
          },
          {
            "id": "60939c6409c04c02f15e9aec",
            "payment_method": "adyen",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9aec",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "localized_description": "Pris per månad"
            }
          },
          {
            "id": "60939c6409c04c02f15e9aef",
            "payment_method": "klarna_payments",
            "type": "limited",
            "enabled": true,
            "iteration_type": "day",
            "iteration_length": 30,
            "price": 210,
            "price_description": {
              "period_id": "60939c6409c04c02f15e9aef",
              "price": "210 kr",
              "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
              "localized_description": "Pris per 30 dagar"
            }
          }
        ],
        "cheapest_price_period_id": "60939c6409c04c02f15e9ae6"
      }
    ],
    "promotial_offer": {
      "id": "60939c6409c04c02f15e9aff",
      "valid_from": "2020-05-06T09:36:04+02:00",
      "valid_to": "2022-05-06T09:36:04+02:00",
      "expired": false,
      "product_code": "package_code",
      "integration_code": "package_integration_code",
      "title_code": "TITLE_CODE",
      "name": "product_name",
      "description": "short_description",
      "additional_short_description": "additional_short_description",
      "image_url": "https://cdn_url/Image/adeprimo/package_code",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60939c6409c04c02f15e9b00",
          "product_code": "embedded_product_code",
          "name": "product_name",
          "description": "short_description",
          "image_url": "https://cdn_url/Image/organisation/embedded_product_code",
          "print_product": true
        }
      ],
      "tags": [],
      "price_periods": [
        {
          "id": "60939c6409c04c02f15e9b01",
          "payment_method": "creditcard",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "price_description": {
            "period_id": "60939c6409c04c02f15e9b01",
            "price": "210 kr",
            "price_specification": "Inklusive moms 25%: 20.00 SEK, 10%: 10.00 SEK",
            "localized_description": "Pris per månad"
          }
        }
      ],
      "cheapest_price_period_id": "60939c6409c04c02f15e9b01"
    }
  }
}

Errors

This API uses the common error conventions of the Payway API

See common error responses