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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Northwind.ServiceModel;
using Northwind.ServiceModel.Types;

namespace Northwind.ServiceModel
{
    public partial class GetOrders
        : IGet
    {
        public virtual int? Page { get; set; }
        public virtual string CustomerId { get; set; }
    }

    [DataContract]
    public partial class OrdersResponse
    {
        [DataMember]
        public virtual List<CustomerOrder> Results { get; set; } = [];

        [DataMember]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Northwind.ServiceModel.Types
{
    [DataContract]
    public partial class CustomerOrder
    {
        [DataMember]
        public virtual Order Order { get; set; }

        [DataMember]
        public virtual List<OrderDetail> OrderDetails { get; set; } = [];
    }

    [DataContract]
    public partial class Order
    {
        [DataMember]
        public virtual int Id { get; set; }

        [DataMember]
        public virtual string CustomerId { get; set; }

        [DataMember]
        public virtual int EmployeeId { get; set; }

        [DataMember]
        public virtual DateTime? OrderDate { get; set; }

        [DataMember]
        public virtual DateTime? RequiredDate { get; set; }

        [DataMember]
        public virtual DateTime? ShippedDate { get; set; }

        [DataMember]
        public virtual int? ShipVia { get; set; }

        [DataMember]
        public virtual decimal Freight { get; set; }

        [DataMember]
        public virtual string ShipName { get; set; }

        [DataMember]
        public virtual string ShipAddress { get; set; }

        [DataMember]
        public virtual string ShipCity { get; set; }

        [DataMember]
        public virtual string ShipRegion { get; set; }

        [DataMember]
        public virtual string ShipPostalCode { get; set; }

        [DataMember]
        public virtual string ShipCountry { get; set; }
    }

    [DataContract]
    public partial class OrderDetail
    {
        [DataMember]
        public virtual int OrderId { get; set; }

        [DataMember]
        public virtual int ProductId { get; set; }

        [DataMember]
        public virtual decimal UnitPrice { get; set; }

        [DataMember]
        public virtual short Quantity { get; set; }

        [DataMember]
        public virtual double Discount { get; set; }
    }

}

C# GetOrders DTOs

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"}}}