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 Foundation
import ServiceStack

public class OrderHeadersRequest : Codable
{
    public var agentID:String
    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(){}
}

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

    required public init(){}
}


Swift OrderHeadersRequest DTOs

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

HTTP + JSV

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

{
	AgentID: 00000000000000000000000000000000,
	OrderHeaders: 
	[
		{
			ID: 0,
			AgentID: 0,
			CustomerID: 0,
			AgentName: String,
			CustomerName: String,
			OrderDate: 0001-01-01,
			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/jsv
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-01,
			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
		}
	]
}