Northwind 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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
    id: int = 0
    customer_id: Optional[str] = None
    employee_id: int = 0
    order_date: Optional[datetime.datetime] = None
    required_date: Optional[datetime.datetime] = None
    shipped_date: Optional[datetime.datetime] = None
    ship_via: Optional[int] = None
    freight: Decimal = decimal.Decimal(0)
    ship_name: Optional[str] = None
    ship_address: Optional[str] = None
    ship_city: Optional[str] = None
    ship_region: Optional[str] = None
    ship_postal_code: Optional[str] = None
    ship_country: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderDetail:
    order_id: int = 0
    product_id: int = 0
    unit_price: Decimal = decimal.Decimal(0)
    quantity: int = 0
    discount: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerOrder:
    order: Optional[Order] = None
    order_details: List[OrderDetail] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrdersResponse:
    results: List[CustomerOrder] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOrders(IGet):
    page: Optional[int] = None
    customer_id: Optional[str] = None

Python GetOrders DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0,
	customerId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			order: 
			{
				id: 0,
				customerId: String,
				employeeId: 0,
				orderDate: 0001-01-01,
				requiredDate: 0001-01-01,
				shippedDate: 0001-01-01,
				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
		}
	}
}