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 .csv suffix or ?format=csv

HTTP + CSV

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

{"AgentID":"00000000000000000000000000000000","OrderHeaders":[{"ID":0,"AgentID":0,"CustomerID":0,"AgentName":"String","CustomerName":"String","OrderDate":"0001-01-01T00:00:00.0000000","OrderStatus":0,"OrderStatusText":"String","TotalQuantityUnits":0,"TotalOrderCost":0,"TotalProductCost":0,"TotalOrderTax":0,"TotalShippingCost":0,"BillingAddressID":0,"ShippingAddressID":0,"CustomerPaidAmount":0,"Notes":"String","UID":"00000000000000000000000000000000","Recalculate":false,"PublicOrderID":"String","Address":"String","ShippingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"BillingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"isMultiShip":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"OrderHeaders":[{"ID":0,"AgentID":0,"CustomerID":0,"AgentName":"String","CustomerName":"String","OrderDate":"0001-01-01T00:00:00.0000000","OrderStatus":0,"OrderStatusText":"String","TotalQuantityUnits":0,"TotalOrderCost":0,"TotalProductCost":0,"TotalOrderTax":0,"TotalShippingCost":0,"BillingAddressID":0,"ShippingAddressID":0,"CustomerPaidAmount":0,"Notes":"String","UID":"00000000000000000000000000000000","Recalculate":false,"PublicOrderID":"String","Address":"String","ShippingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"BillingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"isMultiShip":false}]}