Get marketplace
/marketing/marketplace
Target audience: Developers
Release version: 4.5.9
Get marketplace¶
Introduction¶
This endpoint returns a configured marketplace. Read more on marketplaces here.
Hierarchies¶
This endpoint has fields that are calculated based on a hierarchy. This means that we will attempt to find the value from several points if it is not found immediately.
Field: theme_id¶
| Priority | Case | Description |
|---|---|---|
| 1 | Marketplace has a set theme | theme_id from marketplace will be returned |
| 2 | Marketplace does not have a set theme. Marketplace group does. | theme_id from marketplace group will be returned |
| 3 | Both marketplace and marketplace group is missing a theme, but a theme set as default exists. | theme_id set as default will be returned |
Updated fields¶
This endpoint contains fields whose behaviour has drastically changed compared to previous versions. These changes should be taken into account as the results from previous versions of this endpoint may wary.
| Field | New behaviour | Old behaviour |
|---|---|---|
transform_to_package |
This property has been changed to calculate whether the subscription continues or automatically ends, after it has gone through it's entire campaign or flex campaign lifespan. | This property is toggled while editing the campaign in the PAP. Not compatible with flex campaigns and will as such always return false for these. |
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v6/marketing/marketplace |
| Production | https://backend.worldoftulo.com/external/api/v6/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]+$/" |
| title_code | No | String | The title code that should be used to filter the products available on the given marketplace Size range: 1..100 Allowed values: "/^[A-Z-_0-9]+$/" |
Curl Example¶
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v6/marketing/marketplace?group=MP&key=M1 \
--header 'accept: application/json' \
--header 'authorization: Bearer <access_token>'
Response¶
HTTP 200
{
"item": {
"group": {
"name": "marketplace",
"key": "MP",
"image_url": "image_url",
"image_link": "http://foobar.com",
"rgb": "#fff",
"header": "header",
"description": "description",
"theme_id": null
},
"marketplace": {
"name": "title",
"key": "KEY",
"image_url": "https://image_url",
"image_link": "http://foobar.com",
"rgb": "#fff",
"header": "header",
"description": "description",
"valid_from": "2021-12-01 00:00:00",
"valid_to": "2021-12-21 00:00:00",
"title_code": "ADEPRIMO",
"theme_id": null
},
"offers": [
{
"id": "60939c6409c04c02f15e9af2",
"valid_from": "2020-05-06T09:36:04+02:00",
"valid_to": "2022-05-06T09:36:04+02:00",
"fixed_valid_to": nil,
"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,
"transform_type": "ends|transform_to_package|flex_transform_to_package|flex_transform_to_campaign",
"customer_can_cancel": false,
"show_price_excluding_vat": false,
"rank": 0,
"tags": [
{
"name": "campaign_tag",
"type": "package"
}
],
"price_periods": [
{
"id": "60939c6409c04c02f15e9af3",
"payment_method": "creditcard",
"type": "recurring",
"enabled": true,
"iteration_type": "month",
"iteration_length": 1,
"iterations": 1,
"price": 210,
"price_description": {
"period_id": "60939c6409c04c02f15e9af3",
"price_details": [
{
"name": "Combo campaign",
"total_price": 210.0,
"price_excluding_vat": 157.5,
"vat": 25,
"price_specification": "",
"description_without_price": "första månaden, därefter avslutas prenumerationen",
"description_without_price_excluding_vat": "första månaden, därefter avslutas prenumerationen",
"localized_description": "210 första månaden, därefter avslutas prenumerationen",
"localized_description_excluding_vat": "157.5 kr första månaden, därefter avslutas prenumerationen",
"localized_per_type_description": "210 kr / månad",
"localized_per_type_description_excluding_vat": "157.5 kr / månad"
}
],
# Recursive object
"transition_period": {
"id": "60af542709c04c52a1724a35",
"product_id": "529jfa98jfda9jfad98dfja",
"product_code": "my_first_transition",
"payment_method": "adyen",
"type": "recurring",
"enabled": true,
"iteration_type": "month",
"iteration_length": 3,
"iterations": 1,
"price": 210,
"price_excluding_vat": 197.4,
"vat": 6,
"details": {
"type": "scheme",
"name": "Card"
},
"transition_period": {
"id": "60af542709c04c52a1724b73",
"product_id": "529jfa98jfda9jfad98dfja",
"product_code": "my_second_transition",
"payment_method": "adyen",
"type": "recurring",
"enabled": true,
"iteration_type": "month",
"iteration_length": 3,
"iterations": 1,
"price": 210,
"price_excluding_vat": 197.4,
"vat": 6,
"details": {
"type": "scheme",
"name": "Card"
},
"transition_period": null
}
}
},
"boutique_display_options": {}
],
"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,
"show_price_excluding_vat": false,
"rank": 0,
"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,
"loyalty_card_product": false
}
],
"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_details": [
{
"name": "Adeprimo Papper & Digital",
"total_price": 210.0,
"price_excluding_vat": 157.5,
"vat": 25,
"price_specification": "",
"localized_description": "Pris per månad"
}
]
},
"boutique_display_options": {}
}
]
},
"cheapest_price_period_id": "60939c6409c04c02f15e9af3",
"cheapest_based_on_package_price_period_id": "60939c6409c04c02f15e9ae6",
"popular_choice": {
"popular": true,
"text": "Populär"
}
},
{
"id": "60939c6409c04c02f15e9ae2",
"valid_from": "2020-05-06T09:36:04+02:00",
"valid_to": "2022-05-06T09:36:04+02:00",
"fixed_valid_to": nil,
"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",
"rank": 0,
"customer_can_cancel": false,
"show_price_excluding_vat": 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,
"loyalty_card_product": false
}
],
"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_details": [
{
"name": "Adeprimo Papper & Digital",
"total_price": 210.0,
"price_excluding_vat": 157.5,
"vat": 25,
"price_specification": "",
"localized_description": "Pris per månad"
}
]
},
"boutique_display_options": {}
}
],
"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",
"fixed_valid_to": nil,
"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",
"rank": 0,
"show_price_excluding_vat": false,
"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,
"loyalty_card_product": false
}
],
"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_details": [
{
"name": "Adeprimo Papper & Digital",
"total_price": 210.0,
"price_excluding_vat": 157.5,
"vat": 25,
"price_specification": "",
"localized_description": "Pris per månad"
}
]
},
"boutique_display_options": {}
}
],
"cheapest_price_period_id": "60939c6409c04c02f15e9b01"
}
}
}
Errors¶
This API uses the common error conventions of the Payway API