Get marketplace
/marketing/marketplace
Target audience: Developers
Release version: 4.4.7
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: html_template_id¶
| Priority | Case | Description |
|---|---|---|
| 1 | Marketplace has a set HTML template | HTML template from marketplace will be returned |
| 2 | Marketplace does not have a set HTML template. Marketplace group does | HTML template from marketplace group will be returned |
| 3 | No HTML template is set. HTML template set as default exists | HTML template marked as default will be returned |
Field: css_template_id¶
| Priority | Case | Description |
|---|---|---|
| 1 | Marketplace has a set CSS template | CSS template from marketplace will be returned |
| 2 | Marketplace does not have a set CSS template. Marketplace group does. | CSS template from marketplace group will be returned |
| 3 | No CSS template is set. CSS template set as default exists | CSS template marked as default will be returned |
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v4/marketing/marketplace |
| Production | https://backend.worldoftulo.com/external/api/v4/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/v4/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",
"html_template_id": null,
"css_template_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",
"html_template_id": null,
"css_template_id": null
},
"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,
"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,
"transition_price_period_id": "60939c6409c04c02f15e9ae6",
"price_description": {
"period_id": "60939c6409c04c02f15e9af3",
"transition_period_id": "60939c6409c04c02f15e9ae6",
"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"
}
]
},
"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
}
],
"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"
},
{
"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",
"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
}
],
"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",
"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
}
],
"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