Northwind Web Services

<back to all web services

GetOrders

Orders
The following routes are available for this service:
All Verbs/orders
All Verbs/orders/page/{Page}
All Verbs/customers/{CustomerId}/orders
GetOrders Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?No
CustomerIdpathstringYes
OrdersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<CustomerOrder>Yes
ResponseStatusformResponseStatusYes
CustomerOrder Parameters:
NameParameterData TypeRequiredDescription
OrderformOrderYes
OrderDetailsformList<OrderDetail>Yes
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformstringYes
EmployeeIdformintNo
OrderDateformDateTime?No
RequiredDateformDateTime?No
ShippedDateformDateTime?No
ShipViaformint?No
FreightformdecimalNo
ShipNameformstringYes
ShipAddressformstringYes
ShipCityformstringYes
ShipRegionformstringYes
ShipPostalCodeformstringYes
ShipCountryformstringYes
OrderDetail Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
ProductIdformintNo
UnitPriceformdecimalNo
QuantityformshortNo
DiscountformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"page":0,"customerId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"results":[{"order":{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","shipVia":0,"freight":0,"shipName":"String","shipAddress":"String","shipCity":"String","shipRegion":"String","shipPostalCode":"String","shipCountry":"String"},"orderDetails":[{"orderId":0,"productId":0,"unitPrice":0,"quantity":0,"discount":0}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}