Merchandise
Description
A list of Merchandise single items purchased by users using the Mobile APP or the WebShop Portal.
Items are linked to Users through the User ID (merchandise.user_id => user.id
).
Items can be grouped as single Orders using merchandise.id_order
.
NOTE: The items fields include in some cases {key}_txt to provide a better description of the meaning of some values like for instance order_status
.
Example: order_status
and order_status_txt
GET Merchandise
Endpoint returning a list of single purchased Merchandise items
Endpoint
GET https://{systemURL}/api/merchandise
QUERY Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
date_init |
last_update Date from | Unix Timestamp | no | all |
date_end |
last_update Date to | Unix Timestamp | no | all |
count_elements |
Number of elements per response | int (max = 200) | no | 10 |
page |
Response Page # | int | no | 1 |
order |
Response | ASC , DESC by last_update |
no | DESC |
RESPONSE Schema
Key | Type | Description |
---|---|---|
count |
Integer | Total Number of Items |
page |
Integer | Defined by QUERY parameter page or "" |
items |
Array | Array of Merchandise Items Objects |
Fields
Items
Key | Type | Description |
---|---|---|
id |
Integer | Unique identifier for the sale Item. |
vat |
Float | Value-added tax (VAT) amount for the order. |
vat_percentage |
Integer | VAT percentage applied to the order. |
id_order |
String | Unique identifier for the sale_order. |
last_update |
DateTime | Timestamp of the last update. |
user_id |
Integer | Unique identifier for the user. |
order_amount |
String | Total amount of the order. |
payment_code |
String | Unique code for the payment transaction. |
order_datetime |
DateTime | Date and time when the order was placed. |
username |
String | Username associated with the order. |
recovery_mail_address |
String | Recovery email address for the user. |
phone_number |
String | Phone number associated with the order. |
recovery_phone_number |
String | Recovery phone number for the user. |
phone_guest |
String | Phone number of a guest user (if any). |
pickup_data |
String | Data related to order pickup (if any). |
user_address |
String | Address of the user. |
user_city |
String | City of the user. |
user_country |
String | Country of the user. |
user_zip_code |
String | Zip code of the user. |
user_created |
DateTime | Timestamp of when the user account was created. |
user_last_login |
DateTime | Timestamp of the user's last login. |
id_transaction_status |
Integer | Status identifier of the transaction. |
id_transaction |
Integer | Unique identifier for the transaction. |
order_no |
Integer | Order number. |
in_app_transaction |
Boolean | Indicates if the transaction was made in-app. |
redeem_status |
Integer | Status of the redemption. |
name_redeemed |
String | Name of the person who redeemed the item (if any). |
note_redeemed |
String | Note associated with the redemption (if any). |
from_redeemed |
String | Source from which the item was redeemed (if any). |
id_external_transaction |
String | External identifier for the transaction. |
notater_ticket |
String | Notes related to the ticket (if any). |
date_redeemed |
DateTime | Date and time when the item was redeemed (if any). |
from_redeemed_txt |
String | Text description of the redemption source. |
redeem_status_txt |
String | Text description of the redemption status. |
order_type |
Integer | Type of the order. |
order_type_txt |
String | Text description of the order type. |
order_status |
Integer | Status of the order. |
order_status_txt |
String | Text description of the order status. |
payment_type |
Integer | Type of the payment. |
payment_type_txt |
String | Text description of the payment type. |
sale_channel_txt |
String | Text description of the sales channel. |
result |
String | Result of the transaction (e.g., "OK"). |
refund_detail |
String | Details of the refund (if any). |
refunded_amount |
String | Amount refunded (if any). |
cancel_detail |
String | Details of the cancellation (if any). |
prod_id |
Integer | Product identifier. |
prod_name |
String | Name of the product. |
prod_size |
String | Size of the product (if any). |
prod_conf |
Object | Configuration details of the product. |
prod_base_price |
Integer | Base price of the product. |
prod_additional |
Integer | Additional cost associated with the product. |
prod_disccount |
Integer | Discount applied to the product. |
prod_min_price |
Integer | Minimum price of the product. |
prod_max_price |
Integer | Maximum price of the product. |
price_subtotal |
Float | Subtotal price before VAT. |
vat_category |
String | VAT category of the product. |
order_final_price |
Integer | Final price of the order after VAT and discounts. |
Example
- System: AE Handball
- System URL: aehandball.woow.no
Request
GET https://aehandball.woow.no/api/merchandise?page=2&order=ASC&count_elements=5
Authorization: Basic your_access_token,
Content-Type: application/json
CURL
curl -X GET "https://aehandball.woow.no/api/merchandise?page=2&order=ASC&count_elements=5" \
-H "Authorization: Basic your_access_token"
Tri it here
Ticketing API Merchandise Endpoint
Response
200 OK
{
"count": "1418",
"page": "2",
"items": [
{
"id": 1629035,
"vat": 7.4,
"vat_percentage": 8,
"id_order": "4ec96430-ea6a-49a3-a610-0aafdda0269a",
"last_update": "2024-08-16T09:30:01.488Z",
"user_id": 1412742,
"order_amount": "100",
"payment_code": "4ec96430ea6a49a3a6100aafdda026",
"order_datetime": "2024-08-11T16:30:01.804Z",
"username": "AEH Account",
"recovery_mail_address": "cjespelet@gmail.com",
"phone_number": "+4793474748",
"recovery_phone_number": "+4793474748",
"phone_guest": null,
"pickup_data": null,
"user_address": "",
"user_city": "",
"user_country": "",
"user_zip_code": "7001",
"user_created": "2023-10-11T16:59:28.218Z",
"user_last_login": "2023-10-11T16:59:28.218Z",
"id_transaction_status": 1,
"id_transaction": 1629033,
"order_no": 4479,
"in_app_transaction": true,
"redeem_status": 3,
"name_redeemed": null,
"note_redeemed": null,
"from_redeemed": null,
"id_external_transaction": "4ec96430ea6a49a3a6100aafdda026",
"notater_ticket": null,
"date_redeemed": null,
"from_redeemed_txt": "",
"redeem_status_txt": "PENDING_DELIVERY",
"order_type": 8,
"order_type_txt": "MERCHANDISE",
"order_status": 2,
"order_status_txt": "PAID",
"payment_type": 8,
"payment_type_txt": "VIPPS",
"sale_channel_txt": "PHONE",
"result": "OK",
"refund_detail": null,
"refunded_amount": "0",
"cancel_detail": null,
"prod_id": 263,
"prod_name": "Lojalitetskort",
"prod_size": "",
"prod_conf": {},
"prod_base_price": 100,
"prod_additional": 0,
"prod_disccount": 0,
"prod_min_price": 0,
"prod_max_price": 0,
"price_subtotal": 92.6,
"vat_category": "PLAYERVOTES",
"order_final_price": 100
},
{
"id": 1629032,
"vat": 7.4,
"vat_percentage": 8,
"id_order": "28c5261f-5e85-492b-915a-f5ff033d8435",
"last_update": "2024-08-16T09:20:01.109Z",
"user_id": 1412742,
"order_amount": "100",
"payment_code": "28c5261f5e85492b915af5ff033d84",
"order_datetime": "2024-08-11T16:30:01.655Z",
"username": "AEH Account",
"recovery_mail_address": "cjespelet@gmail.com",
"phone_number": "+4793474748",
"recovery_phone_number": "+4793474748",
"phone_guest": null,
"pickup_data": null,
"user_address": "",
"user_city": "",
"user_country": "",
"user_zip_code": "7001",
"user_created": "2023-10-11T16:59:28.218Z",
"user_last_login": "2023-10-11T16:59:28.218Z",
"id_transaction_status": 1,
"id_transaction": 1629030,
"order_no": 4478,
"in_app_transaction": true,
"redeem_status": 3,
"name_redeemed": null,
"note_redeemed": null,
"from_redeemed": null,
"id_external_transaction": "28c5261f5e85492b915af5ff033d84",
"notater_ticket": null,
"date_redeemed": null,
"from_redeemed_txt": "",
"redeem_status_txt": "PENDING_DELIVERY",
"order_type": 8,
"order_type_txt": "MERCHANDISE",
"order_status": 2,
"order_status_txt": "PAID",
"payment_type": 8,
"payment_type_txt": "VIPPS",
"sale_channel_txt": "PHONE",
"result": "OK",
"refund_detail": null,
"refunded_amount": "0",
"cancel_detail": null,
"prod_id": 263,
"prod_name": "Lojalitetskort",
"prod_size": "",
"prod_conf": {},
"prod_base_price": 100,
"prod_additional": 0,
"prod_disccount": 0,
"prod_min_price": 0,
"prod_max_price": 0,
"price_subtotal": 92.6,
"vat_category": "PLAYERVOTES",
"order_final_price": 100
},
{
"id": 1629029,
"vat": 7.4,
"vat_percentage": 8,
"id_order": "5e388dcc-4a3c-4b8d-a8be-a0e6cc04bdda",
"last_update": "2024-08-16T09:10:01.147Z",
"user_id": 1412742,
"order_amount": "100",
"payment_code": "5e388dcc4a3c4b8da8bea0e6cc04bd",
"order_datetime": "2024-08-11T16:30:01.174Z",
"username": "AEH Account",
"recovery_mail_address": "cjespelet@gmail.com",
"phone_number": "+4793474748",
"recovery_phone_number": "+4793474748",
"phone_guest": null,
"pickup_data": null,
"user_address": "",
"user_city": "",
"user_country": "",
"user_zip_code": "7001",
"user_created": "2023-10-11T16:59:28.218Z",
"user_last_login": "2023-10-11T16:59:28.218Z",
"id_transaction_status": 1,
"id_transaction": 1629027,
"order_no": 4477,
"in_app_transaction": true,
"redeem_status": 3,
"name_redeemed": null,
"note_redeemed": null,
"from_redeemed": null,
"id_external_transaction": "5e388dcc4a3c4b8da8bea0e6cc04bd",
"notater_ticket": null,
"date_redeemed": null,
"from_redeemed_txt": "",
"redeem_status_txt": "PENDING_DELIVERY",
"order_type": 8,
"order_type_txt": "MERCHANDISE",
"order_status": 2,
"order_status_txt": "PAID",
"payment_type": 8,
"payment_type_txt": "VIPPS",
"sale_channel_txt": "PHONE",
"result": "OK",
"refund_detail": null,
"refunded_amount": "0",
"cancel_detail": null,
"prod_id": 263,
"prod_name": "Lojalitetskort",
"prod_size": "",
"prod_conf": {},
"prod_base_price": 100,
"prod_additional": 0,
"prod_disccount": 0,
"prod_min_price": 0,
"prod_max_price": 0,
"price_subtotal": 92.6,
"vat_category": "PLAYERVOTES",
"order_final_price": 100
},
{
"id": 1629026,
"vat": 7.4,
"vat_percentage": 8,
"id_order": "57af245a-3e39-42b8-970a-7f32ff8bec84",
"last_update": "2024-08-16T09:00:01.171Z",
"user_id": 1412742,
"order_amount": "100",
"payment_code": "57af245a3e3942b8970a7f32ff8bec",
"order_datetime": "2024-08-11T15:30:01.834Z",
"username": "AEH Account",
"recovery_mail_address": "cjespelet@gmail.com",
"phone_number": "+4793474748",
"recovery_phone_number": "+4793474748",
"phone_guest": null,
"pickup_data": null,
"user_address": "",
"user_city": "",
"user_country": "",
"user_zip_code": "7001",
"user_created": "2023-10-11T16:59:28.218Z",
"user_last_login": "2023-10-11T16:59:28.218Z",
"id_transaction_status": 1,
"id_transaction": 1629024,
"order_no": 4476,
"in_app_transaction": true,
"redeem_status": 3,
"name_redeemed": null,
"note_redeemed": null,
"from_redeemed": null,
"id_external_transaction": "57af245a3e3942b8970a7f32ff8bec",
"notater_ticket": null,
"date_redeemed": null,
"from_redeemed_txt": "",
"redeem_status_txt": "PENDING_DELIVERY",
"order_type": 8,
"order_type_txt": "MERCHANDISE",
"order_status": 2,
"order_status_txt": "PAID",
"payment_type": 8,
"payment_type_txt": "VIPPS",
"sale_channel_txt": "PHONE",
"result": "OK",
"refund_detail": null,
"refunded_amount": "0",
"cancel_detail": null,
"prod_id": 263,
"prod_name": "Lojalitetskort",
"prod_size": "",
"prod_conf": {},
"prod_base_price": 100,
"prod_additional": 0,
"prod_disccount": 0,
"prod_min_price": 0,
"prod_max_price": 0,
"price_subtotal": 92.6,
"vat_category": "PLAYERVOTES",
"order_final_price": 100
},
{
"id": 1629023,
"vat": 7.4,
"vat_percentage": 8,
"id_order": "ec0176f7-6379-4c0f-ae04-38d37686918a",
"last_update": "2024-08-16T08:50:01.091Z",
"user_id": 1412742,
"order_amount": "100",
"payment_code": "ec0176f763794c0fae0438d3768691",
"order_datetime": "2024-08-11T15:30:01.677Z",
"username": "AEH Account",
"recovery_mail_address": "cjespelet@gmail.com",
"phone_number": "+4793474748",
"recovery_phone_number": "+4793474748",
"phone_guest": null,
"pickup_data": null,
"user_address": "",
"user_city": "",
"user_country": "",
"user_zip_code": "7001",
"user_created": "2023-10-11T16:59:28.218Z",
"user_last_login": "2023-10-11T16:59:28.218Z",
"id_transaction_status": 1,
"id_transaction": 1629021,
"order_no": 4475,
"in_app_transaction": true,
"redeem_status": 3,
"name_redeemed": null,
"note_redeemed": null,
"from_redeemed": null,
"id_external_transaction": "ec0176f763794c0fae0438d3768691",
"notater_ticket": null,
"date_redeemed": null,
"from_redeemed_txt": "",
"redeem_status_txt": "PENDING_DELIVERY",
"order_type": 8,
"order_type_txt": "MERCHANDISE",
"order_status": 2,
"order_status_txt": "PAID",
"payment_type": 8,
"payment_type_txt": "VIPPS",
"sale_channel_txt": "PHONE",
"result": "OK",
"refund_detail": null,
"refunded_amount": "0",
"cancel_detail": null,
"prod_id": 263,
"prod_name": "Lojalitetskort",
"prod_size": "",
"prod_conf": {},
"prod_base_price": 100,
"prod_additional": 0,
"prod_disccount": 0,
"prod_min_price": 0,
"prod_max_price": 0,
"price_subtotal": 92.6,
"vat_category": "PLAYERVOTES",
"order_final_price": 100
}
]
}