Skip to content

Get landingpage

/marketing/landingpage

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 landingpage

Introduction

This endpoint returns a configured landingpage. Read more on landingpages here.

URI

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

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/landingpage?group=MP&key=M1 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token>'

Response

HTTP 200
{
  "item": {
    "group": {
      "name": "group 1",
      "key": "ADE"
    },
    "landingpage": {
      "name": "title",
      "header": "header",
      "description": "[länk](http://www.google.fi) with  \\nlinebreak",
      "key": "LP",
      "template": "template",
      "image_name": "image-name.jpg",
      "image_url": "https://cdn_url/Image/adeprimo/image-name.jpg"
    },
    "offers": [
      {
        "id": "6093a11609c04c0ad94a4b9b",
        "valid_from": "2020-05-06T09:56:06+02:00",
        "valid_to": "2022-05-06T09:56:06+02:00",
        "expired": false,
        "product_code": "campaign_code",
        "integration_code": "campaign_integration_code",
        "title_code": "TITLE_CODE",
        "name": "Adeprimo summer campaign",
        "description": "Please buy our nice summer campaign, it is very nice and gives you news.",
        "additional_short_description": null,
        "image_url": "https://cdn_url/Image/adeprimo/campaign_code",
        "vat_code": 25,
        "type": "campaign",
        "transform_to_package": false,
        "customer_can_cancel": false,
        "tags": [],
        "price_periods": [
          {
            "id": "6093a11609c04c0ad94a4b9e",
            "payment_method": "invoice",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "6093a11609c04c0ad94a4b9e",
              "transition_period_id": null,
              "price": "210 kr",
              "price_specification": "",
              "total_price": "210 kr",
              "description_without_price": "första månaden, därefter avslutas prenumerationen",
              "localized_description": "210 kr första månaden, därefter avslutas prenumerationen",
              "localized_per_type_description": "210 kr / månad"
            }
          }
        ],
        "based_on_package": {
          "id": "6093a11609c04c0ad94a4b95",
          "valid_from": "2020-05-06T09:56:06+02:00",
          "valid_to": "2022-05-06T09:56:06+02:00",
          "expired": false,
          "product_code": "package_code",
          "integration_code": "package_integration_code",
          "title_code": "TITLE_CODE",
          "name": "Adeprimo summer package",
          "description": "Please buy our nice summer package, it is very nice and gives you news.",
          "additional_short_description": "Nice summer package",
          "image_url": "https://cdn_url/Image/adeprimo/package_code",
          "vat_code": 25,
          "type": "package",
          "customer_can_cancel": false,
          "products": [
            {
              "id": "6093a11609c04c0ad94a4b92",
              "product_code": "product_code",
              "name": "product_name",
              "description": "short_description",
              "image_url": "https://cdn_url/Image/organisation/product_code",
              "print_product": false
            }
          ],
          "tags": [],
          "price_periods": [
            {
              "id": "6093a11609c04c0ad94a4b97",
              "payment_method": "creditcard",
              "type": "recurring",
              "enabled": true,
              "iteration_type": "month",
              "iteration_length": 1,
              "price": 210,
              "price_description": {
                "period_id": "6093a11609c04c0ad94a4b97",
                "price": "210 kr",
                "price_specification": "",
                "localized_description": "Pris per månad"
              }
            }
          ]
        },
        "cheapest_price_period_id": "6093a11609c04c0ad94a4b9e",
        "cheapest_based_on_package_price_period_id": "6093a11609c04c0ad94a4b97"
      }
    ]
  }
}

Errors

This API uses the common error conventions of the Payway API

See common error responses