Trendsic Platform Service

<back to all web services

OrderHeadersRequest

The following routes are available for this service:
GET/v1/OrderHeaders/{ID}
GET,POST,OPTIONS/v1/OrderHeaders
POST/v1/OrderHeaders/Agent/{AgentID}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class OrderHeadersRequest
{
    open var AgentID:UUID? = null
    open var OrderHeaders:ArrayList<OrderHeader> = ArrayList<OrderHeader>()
}

open class OrderHeader
{
    open var ID:Int? = null
    open var AgentID:Int? = null
    open var CustomerID:Int? = null
    open var AgentName:String? = null
    open var CustomerName:String? = null
    open var OrderDate:Date? = null
    open var OrderStatus:Short? = null
    open var OrderStatusText:String? = null
    open var TotalQuantityUnits:Short? = null
    open var TotalOrderCost:BigDecimal? = null
    open var TotalProductCost:BigDecimal? = null
    open var TotalOrderTax:BigDecimal? = null
    open var TotalShippingCost:BigDecimal? = null
    open var BillingAddressID:Int? = null
    open var ShippingAddressID:Int? = null
    open var CustomerPaidAmount:BigDecimal? = null
    open var Notes:String? = null
    open var UID:UUID? = null
    open var Recalculate:Boolean? = null
    open var PublicOrderID:String? = null
    open var Address:String? = null
    open var ShippingAddress:Address? = null
    open var BillingAddress:Address? = null
    open var isMultiShip:Boolean? = null
}

open class Address
{
    open var ID:Int? = null
    open var AddressTypeID:Short? = null
    open var AddressContact:String? = null
    open var AttentionTo:String? = null
    open var AddressLine1:String? = null
    open var AddressLine2:String? = null
    open var AddressLine3:String? = null
    open var AddressCity:String? = null
    open var AddressState:String? = null
    open var AddressZip:String? = null
    open var AddressCountry:String? = null
    open var PhoneNumber:String? = null
    open var FaxNumber:String? = null
    open var UID:UUID? = null
    open var Name:String? = null
}

open class OrderHeadersResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var OrderHeaders:ArrayList<OrderHeader> = ArrayList<OrderHeader>()
}

Kotlin OrderHeadersRequest 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.

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

<OrderHeadersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentID>00000000-0000-0000-0000-000000000000</AgentID>
  <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>
</OrderHeadersRequest>
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>