API - Get Orders
Print
Modified on: Tue, 29 Apr, 2025 at 4:10 PM
APIGetOrders
Returns all orders
/api/plain/?type=APIGetOrders&Payload=[payload]&HashString=[hashstring]
URL Parameters
Payload Parameters
Field | Type | Description |
---|
PageLength | Int | Number of items returned |
PageOffset | Int | Start row of PageLength |
Status | Array | Optional Order Status(s) to filter for |
Created | Object | Optional Created DateTime Filter |
Created.Start | String | Optional ISO date time to start from |
Created.End | String | Optional ISO date time to end |
LastEdited | Object | Optional LastEdited Filter |
LastEdited.Start | String | Optional ISO date time to start from |
LastEdited.End | String | Optional ISO date time to end |
PurchaserEmail | String | Optional Purchaser Email to match |
Success 200
Field | Type | Description |
---|
Orders | Array() | Array of Order details |
Errors | Array() | Array of Errors encountered |
- Success-Response:
{
"Orders":[
{
"OrderID":270049,
"OrderReference":"REF-470049-FWR",
"Status":"Completed",
"Created":"2024-10-29 11:03:36",
"LastEdited":"2024-10-29 11:18:03",
"PurchaserEmail":"1196@email.com",
"PurchaserID":1196,
"PurchaserCustomerID":"CUS-2536-UXV"
},
.
.
.
],
"TotalItemCount":10000,
"PageLength":1000,
"PageOffset":0
}
- Error-Response:
HTTP/1.1 200 OK
{
"Errors": [
{"Code":"12", "Error":"Requested PageLength is greater than 1000"}
]
}
Did you find it helpful?
Yes
No
Send feedback Sorry we couldn't be helpful. Help us improve this article with your feedback.