Skip to content

Get packages

/products/package/search

Target audience: Developers

1
Release version: 4.3.11

Get packages

Introduction

Used for fetching multiple packages.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v2/products/package/search
Production https://backend.worldoftulo.com/external/api/v2/products/package/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
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

Second page with 5 results

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

Response

Successful response with page size 5 and page number 2 and title code TITLE1

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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
{
  "page_info": {
    "page_size": 5,
    "page_number": 2,
    "more_results_available": true
  },
  "items": [
    {
      "id": "60af4cea09c04c44a97f60ff",
      "valid_from": "2020-05-27T09:40:26+02:00",
      "valid_to": "2022-05-27T09:40:26+02:00",
      "expired": false,
      "product_code": "10",
      "integration_code": "package_integration_code",
      "title_code": "TITLE1",
      "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/10",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60af4cea09c04c44a97f60fe",
          "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": "60af4cea09c04c44a97f6102",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          }
        }
      ]
    },
    {
      "id": "60af4cea09c04c44a97f6108",
      "valid_from": "2020-05-27T09:40:26+02:00",
      "valid_to": "2022-05-27T09:40:26+02:00",
      "expired": false,
      "product_code": "11",
      "integration_code": "package_integration_code",
      "title_code": "TITLE1",
      "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/11",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60af4cea09c04c44a97f6107",
          "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": "60af4cea09c04c44a97f610b",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          }
        }
      ]
    },
    {
      "id": "60af4cea09c04c44a97f6111",
      "valid_from": "2020-05-27T09:40:26+02:00",
      "valid_to": "2022-05-27T09:40:26+02:00",
      "expired": false,
      "product_code": "12",
      "integration_code": "package_integration_code",
      "title_code": "TITLE1",
      "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/12",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60af4cea09c04c44a97f6110",
          "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": "60af4cea09c04c44a97f6114",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          }
        }
      ]
    },
    {
      "id": "60af4cea09c04c44a97f611a",
      "valid_from": "2020-05-27T09:40:26+02:00",
      "valid_to": "2022-05-27T09:40:26+02:00",
      "expired": false,
      "product_code": "13",
      "integration_code": "package_integration_code",
      "title_code": "TITLE1",
      "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/13",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60af4cea09c04c44a97f6119",
          "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": "60af4cea09c04c44a97f611d",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          }
        }
      ]
    },
    {
      "id": "60af4cea09c04c44a97f6123",
      "valid_from": "2020-05-27T09:40:26+02:00",
      "valid_to": "2022-05-27T09:40:26+02:00",
      "expired": false,
      "product_code": "14",
      "integration_code": "package_integration_code",
      "title_code": "TITLE1",
      "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/14",
      "vat_code": 25,
      "type": "package",
      "customer_can_cancel": false,
      "products": [
        {
          "id": "60af4cea09c04c44a97f6122",
          "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": "60af4cea09c04c44a97f6126",
          "payment_method": "adyen",
          "type": "recurring",
          "enabled": true,
          "iteration_type": "month",
          "iteration_length": 1,
          "price": 210,
          "details": {
            "type": "scheme",
            "name": "Card"
          }
        }
      ]
    }
  ]
}

Errors

This API uses the common error conventions of the Payway API

See common error responses