Skip to content

Get marketplace group

/marketing/marketplace/group

Target audience: Developers

Release version: 4.5.6

Get marketplace groups

Introduction

This endpoint returns a singular marketplace groups based on a given ID. 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 grouping has a set theme. theme_id from marketplace grouping will be returned
2 Marketplace grouping is missing a theme, but a theme set as default exists. theme_id set as default will be returned

URI

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

Requirements

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

Identity Scope
No /external/marketing/r

Parameters

Name Required Type Description
key Yes String Key of the marketplace grouping to fetch

Curl Example

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

Response

HTTP 200
{
  "item": {
      "name": "group 1",
      "key": "G1",
      "image_url": "image_url",
      "image_link": "http://foobar.com",
      "rgb": "#fff",
      "header": "header",
      "description": "description",
      "theme_id": null,
      "markets": [
        {
          "name": "market 1",
          "key": "M1"
        },
        {
          "name": "market 2",
          "key": "M2"
        }
      ]
    }
}

Errors

This API uses the common error conventions of the Payway API

See common error responses