Retrieve a list of sales orders from your administration. A maximum of 50 orders will be returned at once. Use offset and limit parameters to retrieve more orders over multiple calls.
- Request
- Response
Parameters
Limit
Integer
Details
Defines the limit of items to retreive
Offset
Integer
Details
Defines the offset for the retreive
DateFrom
Date String (dd-MM-yyyy)
Details
Filter on orderdate in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html). Default to no from date filter. Will only return orders with orderdate after the specified date.
DateTill
Date String (dd-MM-yyyy)
Details
Filter on orderdate in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html) Defaults to no till date. Will only return orders with orderdate before the specified date.
ChangedSince
String
Details
An UNIX timestamp in seconds. Will return only orders that are changed since the specified timestamp.
ChangedTill
String
Details
An UNIX timestamp in seconds. Will return only orders that are changed before the specified timestamp.
CreatedSince
String
Details
An UNIX timestamp in seconds. Will return only orders that are created since the specified timestamp.
CreatedTill
String
Details
An UNIX timestamp in seconds. Will return only orders that are created before the specified timestamp.
HtmlAsPlainText
Boolean (true|false)
Details
Whether the rich-text fields will be returned as plain text or not. Defaults to false.
OrderStatus
String
Details
A filter on order status (custom order status in Silvasoft). If specified the request will return only orders with the current status matching the status specified here.
CURL Example
|
1 |
curl -X GET -H "Content-Type: application/json" -H "ApiKey: b7d343Bnhd436f3ec3bd3504582" -H "Username: john@doe.nl" "https://rest-api.silvasoft.nl/rest/listorders/?DateFrom=01-01-2016&DateTill=15-01-2016&Limit=10" |
Parameters
Response JSON Example
The response order can vary from the parameter order above|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
[ { "CustomerNumber":123456, "OrderNotes":"Order from system X", "OrderReference":"system-X-1234", "OrderNumber":43, "OrderDiscountPc":15, "OrderStatus":"Ready to ship", "CustomerName":"Mr. John Doe", "DeliveryPeriod":14, "Order_Address":[ { "Address_CountryCode":"UK", "Address_Unit":"19", "Address_City":"London", "Address_UnitAppendix":"", "Address_Type":"BillingAddress", "Address_PostalCode":"4354", "Address_Street":"SHIPPING ADDRESS" }, { "Address_CountryCode":"NL", "Address_Unit":"5", "Address_City":"Amsterdam", "Address_UnitAppendix":"", "Address_Type":"BillingAddress", "Address_PostalCode":"3333AA", "Address_Street":"BILLING ADDRESS" } ], "Order_Orderline":[ { "TaxPc":21, "Description":"Green t-shirt, size 6", "UnitPriceExclTax":3.95, "Quantity":36, "ProductNumber":"CD-X-2", "SubTotalInclTax":172.06, "ProductEAN":null, "DeliveryDate":"15-02-2022", }, { "TaxPc":6, "Description":"", "UnitPriceExclTax":377.35849056603774, "Quantity":1, "ProductNumber":"CD-X-18", "SubTotalInclTax":400, "ProductEAN":null }, { "TaxPc":0, "Description":"Example text line", "UnitPriceExclTax":0, "Quantity":0, "ProductNumber":null, "SubTotalInclTax":0, "ProductEAN":null, "TextLineCategory":"Default category", "IsTextLine":true } ], "OrderTotalInclTax":486.25, "OrderDate":"24-11-2016", "CreatedOn":1598340866, "ChangedOn":1599849807 }, { "CustomerNumber":24234337, "OrderNotes":"Example order notes", "OrderReference":"1234", "OrderNumber":44, "OrderDiscountPc":15, "CustomerName":"Company LTD", "Order_Address":[ { "Address_CountryCode":"UK", "Address_Unit":"19", "Address_City":"London", "Address_UnitAppendix":"", "Address_Type":"BillingAddress", "Address_PostalCode":"4354", "Address_Street":"SHIPPING ADDRESS" }, { "Address_CountryCode":"NL", "Address_Unit":"5", "Address_City":"Amsterdam", "Address_UnitAppendix":"", "Address_Type":"BillingAddress", "Address_PostalCode":"3333AA", "Address_Street":"BILLING ADDRESS" } ], "Order_Orderline":[ { "TaxPc":21, "Description":"Green t-shirt, size 6", "UnitPriceExclTax":3.95, "Quantity":36, "ProductNumber":"CD-X-2", "SubTotalExclTax":144.95, "SubTotalInclTaxExclDiscount":195.75, "SubTotalInclTax":172.06, "ProductEAN":null }, { "TaxPc":6, "Description":"", "UnitPriceExclTax":377.35849056603774, "Quantity":1, "ProductNumber":"CD-X-18", "SubTotalInclTax":400, "ProductEAN":null } ], "OrderTotalInclTax":486.25, "OrderDate":"23-11-2016", "CreatedOn":1598340866, "ChangedOn":1599849807 } ] |