APIGetOrders

Returns all orders

/api/plain/?type=APIGetOrders&Payload=[payload]&HashString=[hashstring]

URL Parameters

 Field TypeDescription
TypeStringAPI that will be called
PayloadURL_ENCODEDAn URL encoded JSON array 
HashString Varchar sha256 encoded string. Read how to create payload and hashstring 

Payload Parameters

 Field TypeDescription
PageLengthIntNumber of items returned
PageOffsetIntStart row of PageLength
StatusArrayOptional Order Status(s) to filter for
CreatedObjectOptional Created DateTime Filter
Created.StartStringOptional ISO date time to start from
Created.EndStringOptional ISO date time to end
LastEditedObjectOptional LastEdited Filter
LastEdited.StartStringOptional ISO date time to start from
LastEdited.EndStringOptional ISO date time to end
PurchaserEmailStringOptional Purchaser Email to match


Success 200

FieldTypeDescription
OrdersArray() Array of Order details
ErrorsArray() 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"}
	  ]
    }