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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Address() = 
        member val ID:Int32 = new Int32() with get,set
        member val AddressTypeID:Byte = new Byte() with get,set
        member val AddressContact:String = null with get,set
        member val AttentionTo:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val AddressCity:String = null with get,set
        member val AddressState:String = null with get,set
        member val AddressZip:String = null with get,set
        member val AddressCountry:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val FaxNumber:String = null with get,set
        member val UID:Guid = new Guid() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type OrderHeader() = 
        member val ID:Int32 = new Int32() with get,set
        member val AgentID:Int32 = new Int32() with get,set
        member val CustomerID:Int32 = new Int32() with get,set
        member val AgentName:String = null with get,set
        member val CustomerName:String = null with get,set
        member val OrderDate:DateTime = new DateTime() with get,set
        member val OrderStatus:Byte = new Byte() with get,set
        member val OrderStatusText:String = null with get,set
        member val TotalQuantityUnits:Int16 = new Int16() with get,set
        member val TotalOrderCost:Decimal = new Decimal() with get,set
        member val TotalProductCost:Decimal = new Decimal() with get,set
        member val TotalOrderTax:Decimal = new Decimal() with get,set
        member val TotalShippingCost:Decimal = new Decimal() with get,set
        member val BillingAddressID:Int32 = new Int32() with get,set
        member val ShippingAddressID:Int32 = new Int32() with get,set
        member val CustomerPaidAmount:Decimal = new Decimal() with get,set
        member val Notes:String = null with get,set
        member val UID:Guid = new Guid() with get,set
        member val Recalculate:Boolean = new Boolean() with get,set
        member val PublicOrderID:String = null with get,set
        member val Address:String = null with get,set
        member val ShippingAddress:Address = null with get,set
        member val BillingAddress:Address = null with get,set
        member val isMultiShip:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type OrderHeadersResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val OrderHeaders:ResizeArray<OrderHeader> = new ResizeArray<OrderHeader>() with get,set

    [<AllowNullLiteral>]
    type OrderHeadersRequest() = 
        member val AgentID:Guid = new Guid() with get,set
        member val OrderHeaders:ResizeArray<OrderHeader> = new ResizeArray<OrderHeader>() with get,set

F# OrderHeadersRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}