Skip to content

/active_products

/accounts/active_products

Target audience: Developers

1
Release version: 3.9.1

Introduction

This endpoint returns the active product codes for an account. If external plus-products is enabled, this endpoint will also return these product codes if any.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/accounts/active_products
Production https://backend.worldoftulo.com/external/api/v1/accounts/active_products

Requirements

Identity Scope
No /external/account/r

Parameters

Name Type Description
account_id String The id of the account.

Curl Example

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/accounts/active_products?account_id=1234567890 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Response

Example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
HTTP 200
{
    "item": {
        "id": "585a4768edce2c5e6f000001",
        "active_products": [
            "aaa_digital",
            "product_web",
            "product_plus"
        ]
    }
}

Example response with external plus

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
HTTP 200
{
    "item": {
        "id": "585a4768edce2c5e6f000001",
        "active_products": [
            "aaa_digital",
            "product_web",
            "product_plus"
        ],
        "external_plus_products": [
            "plus_adeprimo"
        ]
    }
}

Errors

Example error response

1
2
3
4
5
HTTP 400 Bad Request
{
    "code": "unknown_parameter",
    "message": "Unknown parameters: unknown_api_parameter_1,unknown_api_parameter_2"
}

HTTP 400 Bad Request

Name Type Description
unknown_parameter Object One or more of the fields in the posted json was not recognized

HTTP 404 Not Found

Name Type Description
not_found Object The account could not be found

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side