Get packages
/products/package/search
Target audience: Developers
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¶
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¶
HTTP 200
{
"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,
"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": "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,
"price_description": {
"period_id": "60af542709c04c52a1724a35",
"price": 210,
"price_specification": null,
"localized_description": "Pris per månad",
},
"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,
"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": "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,
"price_description": {
"period_id": "60af542709c04c52a1724a35",
"price": 210,
"price_specification": null,
"localized_description": "Pris per månad",
},
"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,
"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": "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,
"price_description": {
"period_id": "60af542709c04c52a1724a35",
"price": 210,
"price_specification": null,
"localized_description": "Pris per månad",
},
"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,
"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": "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,
"price_description": {
"period_id": "60af542709c04c52a1724a35",
"price": 210,
"price_specification": null,
"localized_description": "Pris per månad",
},
"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,
"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": "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,
"price_description": {
"period_id": "60af542709c04c52a1724a35",
"price": 210,
"price_specification": null,
"localized_description": "Pris per månad",
},
"details": {
"type": "scheme",
"name": "Card"
}
}
]
}
]
}
Errors¶
This API uses the common error conventions of the Payway API