APIGetOrdersByEmail
Returns all orders for a specific user email
/api/plain/?type=APIGetOrdersByEmail&[payload]&HashString=[hashstring]
URL Parameters
Payload Parameters
| Field | Type | Description |
|---|
| email | Varchar | Purchaser email |
Success 200
| Field | Type | Description |
|---|
| Orders | Array() | |
| Errors | Array() | |
- Success-Response:
HTTP/1.1 200 OK
{
"Created": "2020-01-14 11:35:26",
"Status": "Completed",
"Reference": "REF-200004-DAR",
"NetTotal": "15.00",
"GrossTotal": "18.00",
"TaxTotal": "3.00",
"EmailNotification: 1,
"SMSNotification: 0,
"Transactions": [
{
"Name": null,
"Type": "Card",
"Code": "",
"Vendor": "SagePay",
"Amount": "18.00",
"PaymentGatewayReference": "REF-200004-DAR"
}
],
"Params":{
"op_test_status": "booked"
},
"OrderItems":[
{
"OrderItem":{
"Created": "2020-01-14 11:35:27",
"OrderItemID":4,
"NetTotal": "15.00",
"GrossTotal":18,
"TaxTotal": "3.00",
"AccountingCodes":{
"Name": "Tax",
"AccountingCode": "BLTAX",
"FundCode": "BLTAX"
},
"Event":{
"ResourceName": "",
"LocationName": "Bristol",
"LocationPostCode": "PostCode",
"ProductName": "Carting",
"ProductID": 4,
"ProductDescription": "Allow customers to book at multiple locations",
"StartDateTime": "2020-01-24 10:00:00",
"EndDateTime": "2020-01-24 11:00:00",
"OrderItemID": 4,
"PreTime": 0,
"PostTime": 0
}
}
}
],
"Notes":[
]
}
Error 4xx
| Field | Type | Description |
|---|
| Errors | array() | |
| - Code | Int | Number of error |
| - Error | String | Error message |
- Error-Response:
HTTP/1.1 200 OK
{
"Errors": [
{"Code":"12", "Member not found":"Not found order"}
{"Code":"12", "No orders found for purchaser":"Not found order"}
]
}
