Get marketplace group

/marketing/marketplace/group

Target audience: Developers

Release version: 4.4.7

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: `html_template_id`¶

Priority	Case	Description
1	Marketplace group has a set HTML template	HTML template from marketplace group will be returned
2	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 group has a set CSS template	CSS template from marketplace group will be returned
2	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/v3/marketing/marketplace/group
Production	https://backend.worldoftulo.com/external/api/v3/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 group to fetch

Curl Example¶

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v3/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",
      "html_template_id": null,
      "css_template_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