Skip to content

Get campaigns

/products/campaign/search

Target audience: Developers

1
Release version: 4.5.9

Get campaigns

Introduction

Used for fetching multiple campaigns.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v4/products/campaign/search
Production https://backend.worldoftulo.com/external/api/v4/products/campaign/search

Requirements

Identity Scope
No /external/product/r

Parameters

Name Type Description Required
title_code String Title code a title.
Size range: 1..15 Allowed values: "/^[a-zA-Z-_0-9]+$/"
Yes
page_size Integer Size of result set
Size range: 1..25 Allowed values: Integer Default: 25
No
page_number Integer Skip given result sets
Size range: 1..1000 Allowed values: Integer Default: 1
No
packaged_product_code String The product code the campaign package should include.
Note that this is not the same as a package or campaign code.
No
tags String Retrieve only product for specific tags (case sensitive).
Size range: 1..100 Allowed values: "/^([a-zA-Z0-9]+,?\s*)+$/"
No
include_inactive Boolean Includes inactive products Allowed values: true/false Default: false No

Curl Example

Forth page with page size 3

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v4/products/campaign/search?page_size=3&page_number=4&title_code=TITLE_CODE \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \

Response

Successful response with page size 3 and page number 4 and title code TITLE_CODE

1
HTTP 200
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
{
  "page_info": {
    "page_size": 3,
    "page_number": 4,
    "more_results_available": true
  },
  "items": [
    {
      "id": "60af542709c04c52a1724a32",
      "valid_from": "2020-05-27T10:11:19+02:00",
      "valid_to": "2022-05-27T10:11:19+02:00",
      "expired": false,
      "product_code": "12",
      "integration_code": "campaign_integration_code",
      "title_code": "TITLE_CODE",
      "name": "Adeprimo summer campaign",
      "description": "Please buy our nice summer campaign, it is very nice and gives you news.",
      "additional_short_description": null,
      "image_url": "https://cdn_url/Image/adeprimo/12",
      "vat_code": 25,
      "type": "campaign",
      "transform_to_package": true,
      "customer_can_cancel": false,
      "rank": 0,
      "show_price_excluding_vat": false,
      "allow_gift_purchase": false,
      "allow_only_gift_purchase": false,
      "allow_voucher_purchase": false,
      "allow_only_voucher_purchase": false,
      "tags": [
        {
          "name": "package_tag",
          "type": "package"
        },
        {
          "name": "campaign_tag",
          "type": "package"
        }
      ],
      "price_periods": [
        {
          "id": "60af542709c04c52a1724a35",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 3,
          "iterations": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          },
          "price_description": {
            "period_id": "60af542709c04c52a1724a35",
            "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"
              }
            ],

            # Recursive object
            "transition_period": {
              "id": "60af542709c04c52a1724a35",
              "product_id": "529jfa98jfda9jfad98dfja",
              "product_code": "my_first_transition",
              "payment_method": "adyen",
              "type": "recurring",
              "enabled": true,
              "iteration_type": "month",
              "iteration_length": 3,
              "iterations": 1,
              "price": 210,
              "price_excluding_vat": 197.4,
              "vat": 6,
              "details": {
                "type": "scheme",
                "name": "Card"
              },
              "transition_period": {
                "id": "60af542709c04c52a1724b73",
                "product_id": "529jfa98jfda9jfad98dfja",
                "product_code": "my_second_transition",
                "payment_method": "adyen",
                "type": "recurring",
                "enabled": true,
                "iteration_type": "month",
                "iteration_length": 3,
                "iterations": 1,
                "price": 210,
                "price_excluding_vat": 197.4,
                "vat": 6,
                "details": {
                  "type": "scheme",
                  "name": "Card"
                },
                "transition_period": nil
              }
            }
          }
        }
      ],
      "based_on_package": {
        "id": "60af542609c04c52a17249d6",
        "valid_from": "2020-05-27T10:11:18+02:00",
        "valid_to": "2022-05-27T10:11:18+02:00",
        "expired": false,
        "product_code": "package_code",
        "integration_code": "package_integration_code",
        "title_code": "TITLE_CODE",
        "name": "Adeprimo summer package",
        "description": "Please buy our nice summer package, it is very nice and gives you news.",
        "additional_short_description": "Nice summer package",
        "image_url": "https://cdn_url/Image/adeprimo/package_code",
        "vat_code": 25,
        "type": "package",
        "customer_can_cancel": false,
        "rank": 0,
        "show_price_excluding_vat": false,
        "allow_gift_purchase": false,
        "allow_only_gift_purchase": false,
        "allow_voucher_purchase": false,
        "allow_only_voucher_purchase": false,
        "products": [
          {
            "id": "60af542609c04c52a17249d3",
            "product_code": "product_code",
            "type": "product",
            "name": "product_name",
            "description": "short_description",
            "image_url": "https://cdn_url/Image/organisation/product_code",
            "print_product": false
          }
        ],
        "tags": [
          {
            "name": "package_tag",
            "type": "package"
          }
        ],
        "price_periods": [
          {
            "id": "60af542609c04c52a17249d9",
            "payment_method": "adyen",
            "type": "recurring",
            "enabled": true,
            "iteration_type": "month",
            "iteration_length": 1,
            "price": 210,
            "price_description": {
              "period_id": "60af542709c04c52a1724a35",
              "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"
                }
              ]
            },
            "details": {
              "type": "scheme",
              "name": "Card"
            }
          }
        ]
      }
    }
  ]
}

Errors

This API uses the common error conventions of the Payway API

See common error responses