Skip to content

Get marketplace groups

/marketing/marketplace/groups

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 groups

Introduction

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

URI

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

Requirements

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

Identity Scope
No /external/marketing/r

Parameters

Name Required Type Description

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/marketing/marketplace/groups \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token>'

Response

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

Errors

This API uses the common error conventions of the Payway API

See common error responses