Trendsic Platform Service

<back to all web services

ClosedOrderRequest

The following routes are available for this service:
GET/v1/OrderHeaders/Closed
import Foundation
import ServiceStack

public class ClosedOrderRequest : Codable
{
    required public init(){}
}

public class OrderHeadersResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var orderHeaders:[OrderHeader] = []

    required public init(){}
}

public class OrderHeader : Codable
{
    public var id:Int
    public var agentID:Int
    public var customerID:Int
    public var agentName:String
    public var customerName:String
    public var orderDate:Date
    public var orderStatus:UInt8
    public var orderStatusText:String
    public var totalQuantityUnits:Int16
    public var totalOrderCost:Double
    public var totalProductCost:Double
    public var totalOrderTax:Double
    public var totalShippingCost:Double
    public var billingAddressID:Int
    public var shippingAddressID:Int
    public var customerPaidAmount:Double
    public var notes:String
    public var uid:String
    public var recalculate:Bool
    public var publicOrderID:String
    public var address:String
    public var shippingAddress:Address
    public var billingAddress:Address
    public var isMultiShip:Bool

    required public init(){}
}

public class Address : Codable
{
    public var id:Int
    public var addressTypeID:UInt8
    public var addressContact:String
    public var attentionTo:String
    public var addressLine1:String
    public var addressLine2:String
    public var addressLine3:String
    public var addressCity:String
    public var addressState:String
    public var addressZip:String
    public var addressCountry:String
    public var phoneNumber:String
    public var faxNumber:String
    public var uid:String
    public var name:String

    required public init(){}
}


Swift 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>