| GET | /v1/OrderHeaders/{ID} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/OrderHeaders | ||
| POST | /v1/OrderHeaders/Agent/{AgentID} |
export class Address
{
public ID: number;
public AddressTypeID: number;
public AddressContact: string;
public AttentionTo: string;
public AddressLine1: string;
public AddressLine2: string;
public AddressLine3: string;
public AddressCity: string;
public AddressState: string;
public AddressZip: string;
public AddressCountry: string;
public PhoneNumber: string;
public FaxNumber: string;
public UID: string;
public Name: string;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
export class OrderHeader
{
public ID: number;
public AgentID: number;
public CustomerID: number;
public AgentName: string;
public CustomerName: string;
public OrderDate: string;
public OrderStatus: number;
public OrderStatusText: string;
public TotalQuantityUnits: number;
public TotalOrderCost: number;
public TotalProductCost: number;
public TotalOrderTax: number;
public TotalShippingCost: number;
public BillingAddressID: number;
public ShippingAddressID: number;
public CustomerPaidAmount: number;
public Notes: string;
public UID: string;
public Recalculate: boolean;
public PublicOrderID: string;
public Address: string;
public ShippingAddress: Address;
public BillingAddress: Address;
public isMultiShip: boolean;
public constructor(init?: Partial<OrderHeader>) { (Object as any).assign(this, init); }
}
export class OrderHeadersResponse
{
public ResponseStatus: ResponseStatus;
public OrderHeaders: OrderHeader[] = [];
public constructor(init?: Partial<OrderHeadersResponse>) { (Object as any).assign(this, init); }
}
export class OrderHeadersRequest
{
public AgentID: string;
public OrderHeaders: OrderHeader[] = [];
public constructor(init?: Partial<OrderHeadersRequest>) { (Object as any).assign(this, init); }
}
TypeScript OrderHeadersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>