GET - CustomerOrder
Get customer order based on parameters
URL
Verb |
Url |
GET - Basic authentication |
/api/CustomerOrder?ShopCode=shop code&OrderIdentifier=order identifier
|
Request Parameters
At least one of the optional parameters need to be provided
Parameter |
Description |
Format |
ShopCode |
Shop identifier as provided with your account |
string |
Order Identifier |
Order identifier of the requested order |
string |
Response Elements
[
{
"LocationIdentifier":"FL_NL_1",
"ExternalOrderNr":"123",
"InternalOrderNr":1,
"CustomerIdentifier":"RTN_LOY_123",
"CustomerGLN":"1234567890123",
"OrderDate":"yyyy-MM-ddTHH:mm:ss",
"Employee":"Full Name",
"Status":"Order Status", /* For new order leave empty */
"TotalConsumerQuantityOrdered":1.0,
"TotalQuantityOrdered":1.0,
"OrderLines":
[
{
"ProductIdentifier": "LX_NL_123456",
"ProductDescription": "VERZORGINGSDOUCHE",
"QuantityOrdered": 1.00,
"ConsumerQuantityOrdered": 1.00,
"QuantityDelivered": 1.00,
"ConsumerQuantityDelivered": 1.00,
"Amount": 1.00,
"Eancode": "EAN-13",
"VatPercentage": 1.00,
"RetailPrice": 1.00,
"PurchasePrice": 1.00,
"Comments": "{"FrameColor":{"Value":"Rood"},"TopColor":{"Value":"Zwart"},"ThreadColor":{"Value":"Wit"},"Bijzonderheden":{"Value":"Leer"}}",
"stockLocationCode": "L01X5", /* Location of the product in warehouse */
"RowId": 1, /* RowId 0 for new OrderLines */
}
],
"OrderDocuments":
[
{
"Name": "Raaplijst",
"Document": "URL",
"Date": "yyyy-MM-ddTHH:mm:ss",
"RowId": 1 /* RowId 0 for new OrderDocuments */
}
],
"PartialPayments":
[
{
"Date":"yyyy-MM-ddTHH:mm:ss",
"Amount": 1,
"Paid": False,
"RowId": 1, /* RowId 0 for new PartialPayment */
"PaymentDate": "yyyy-MM-ddTHH:mm:ss"
}
],
"Discounts":
[
{
"Description":"Extra information about the Discount",
"Percentage":"The specified discount percentage",
"Amount":"The //////",
"Direct": false
}
],
}
]
Code Samples
C#.net
public string RequestUrlGET(string URL, string SourceUser, string SourcePassword)
{
HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(URL);
string credentials = Convert.ToBase64String(ASCIIEncoding.ASCII.GetBytes(SourceUser + ":" + SourcePassword));
request.Headers.Add("Authorization", "Basic " + credentials);
using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())
{
using (StreamReader content = new StreamReader(response.GetResponseStream()))
{
return content.ReadToEnd();
}
}
}