Trendsic Platform Service

<back to all web services

ClosedOrderRequest

The following routes are available for this service:
GET/v1/OrderHeaders/Closed
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 Address:
    id: int = 0
    address_type_i_d: int = 0
    address_contact: Optional[str] = None
    attention_to: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_city: Optional[str] = None
    address_state: Optional[str] = None
    address_zip: Optional[str] = None
    address_country: Optional[str] = None
    phone_number: Optional[str] = None
    fax_number: Optional[str] = None
    uid: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderHeader:
    id: int = 0
    agent_i_d: int = 0
    customer_i_d: int = 0
    agent_name: Optional[str] = None
    customer_name: Optional[str] = None
    order_date: datetime.datetime = datetime.datetime(1, 1, 1)
    order_status: int = 0
    order_status_text: Optional[str] = None
    total_quantity_units: int = 0
    total_order_cost: Decimal = decimal.Decimal(0)
    total_product_cost: Decimal = decimal.Decimal(0)
    total_order_tax: Decimal = decimal.Decimal(0)
    total_shipping_cost: Decimal = decimal.Decimal(0)
    billing_address_i_d: int = 0
    shipping_address_i_d: int = 0
    customer_paid_amount: Decimal = decimal.Decimal(0)
    notes: Optional[str] = None
    uid: Optional[str] = None
    recalculate: bool = False
    public_order_i_d: Optional[str] = None
    address: Optional[str] = None
    shipping_address: Optional[Address] = None
    billing_address: Optional[Address] = None
    is_multi_ship: bool = False


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClosedOrderRequest:
    pass

Python ClosedOrderRequest DTOs

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

HTTP + XML

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

GET /v1/OrderHeaders/Closed HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderHeadersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <OrderHeaders>
    <OrderHeader>
      <Address>String</Address>
      <AgentID>0</AgentID>
      <AgentName>String</AgentName>
      <BillingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </BillingAddress>
      <BillingAddressID>0</BillingAddressID>
      <CustomerID>0</CustomerID>
      <CustomerName>String</CustomerName>
      <CustomerPaidAmount>0</CustomerPaidAmount>
      <ID>0</ID>
      <Notes>String</Notes>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <OrderStatus>0</OrderStatus>
      <OrderStatusText>String</OrderStatusText>
      <PublicOrderID>String</PublicOrderID>
      <Recalculate>false</Recalculate>
      <ShippingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </ShippingAddress>
      <ShippingAddressID>0</ShippingAddressID>
      <TotalOrderCost>0</TotalOrderCost>
      <TotalOrderTax>0</TotalOrderTax>
      <TotalProductCost>0</TotalProductCost>
      <TotalQuantityUnits>0</TotalQuantityUnits>
      <TotalShippingCost>0</TotalShippingCost>
      <UID>00000000-0000-0000-0000-000000000000</UID>
      <isMultiShip>false</isMultiShip>
    </OrderHeader>
  </OrderHeaders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</OrderHeadersResponse>