Trendsic Platform Service

<back to all web services

OrderLinesRequest

The following routes are available for this service:
POST,PUT,DELETE,OPTIONS/v1/OrderLines
GET/v1/OrderLines/OrderHeaders/{OrderHeaderUID}
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 OrderLine:
    id: int = 0
    order_header_i_d: Optional[str] = None
    order_line_number: int = 0
    product_i_d: int = 0
    stripe_product_id: Optional[str] = None
    product_category: int = 0
    product_sub_category: int = 0
    quantity: int = 0
    total_order_line_cost: Decimal = decimal.Decimal(0)
    product_cost: Decimal = decimal.Decimal(0)
    per_unit_product_cost: Decimal = decimal.Decimal(0)
    order_line_tax: Decimal = decimal.Decimal(0)
    order_line_shipping_cost: Decimal = decimal.Decimal(0)
    per_unit_shipping_cost: Decimal = decimal.Decimal(0)
    order_line_status_i_d: int = 0
    ship_method_i_d: int = 0
    estimated_ship_date: datetime.datetime = datetime.datetime(1, 1, 1)
    estimated_delivery_date: datetime.datetime = datetime.datetime(1, 1, 1)
    actual_ship_date: datetime.datetime = datetime.datetime(1, 1, 1)
    actual_delivery_date: datetime.datetime = datetime.datetime(1, 1, 1)
    order_line_created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    order_line_modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    uid: Optional[str] = None
    product_name: Optional[str] = None
    agent_id: int = 0
    street: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    phone_number: Optional[str] = None
    address_id: int = 0
    shipping_address: Optional[str] = None
    full_name: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderLinesRequest:
    order_header_u_i_d: Optional[str] = None
    order_lines: List[OrderLine] = field(default_factory=list)

Python OrderLinesRequest 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 /v1/OrderLines HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OrderHeaderUID: 00000000000000000000000000000000,
	OrderLines: 
	[
		{
			ID: 0,
			OrderHeaderID: 00000000000000000000000000000000,
			OrderLineNumber: 0,
			ProductID: 0,
			StripeProductId: String,
			ProductCategory: 0,
			ProductSubCategory: 0,
			Quantity: 0,
			TotalOrderLineCost: 0,
			ProductCost: 0,
			PerUnitProductCost: 0,
			OrderLineTax: 0,
			OrderLineShippingCost: 0,
			PerUnitShippingCost: 0,
			OrderLineStatusID: 0,
			ShipMethodID: 0,
			EstimatedShipDate: 0001-01-01,
			EstimatedDeliveryDate: 0001-01-01,
			ActualShipDate: 0001-01-01,
			ActualDeliveryDate: 0001-01-01,
			OrderLineCreatedDate: 0001-01-01,
			OrderLineModifiedDate: 0001-01-01,
			UID: 00000000000000000000000000000000,
			ProductName: String,
			AgentId: 0,
			Street: String,
			City: String,
			State: String,
			Zip: String,
			PhoneNumber: String,
			AddressId: 0,
			ShippingAddress: String,
			FullName: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	OrderLines: 
	[
		{
			ID: 0,
			OrderHeaderID: 00000000000000000000000000000000,
			OrderLineNumber: 0,
			ProductID: 0,
			StripeProductId: String,
			ProductCategory: 0,
			ProductSubCategory: 0,
			Quantity: 0,
			TotalOrderLineCost: 0,
			ProductCost: 0,
			PerUnitProductCost: 0,
			OrderLineTax: 0,
			OrderLineShippingCost: 0,
			PerUnitShippingCost: 0,
			OrderLineStatusID: 0,
			ShipMethodID: 0,
			EstimatedShipDate: 0001-01-01,
			EstimatedDeliveryDate: 0001-01-01,
			ActualShipDate: 0001-01-01,
			ActualDeliveryDate: 0001-01-01,
			OrderLineCreatedDate: 0001-01-01,
			OrderLineModifiedDate: 0001-01-01,
			UID: 00000000000000000000000000000000,
			ProductName: String,
			AgentId: 0,
			Street: String,
			City: String,
			State: String,
			Zip: String,
			PhoneNumber: String,
			AddressId: 0,
			ShippingAddress: String,
			FullName: String
		}
	]
}