Trendsic Platform Service

OrderHeadersRequest

The following routes are available for this service:
GET	/v1/OrderHeaders/{ID}
GET,POST,OPTIONS	/v1/OrderHeaders
POST	/v1/OrderHeaders/Agent/{AgentID}

"use strict";
export class Address {
    /** @param {{ID?:number,AddressTypeID?:number,AddressContact?:string,AttentionTo?:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,AddressCity?:string,AddressState?:string,AddressZip?:string,AddressCountry?:string,PhoneNumber?:string,FaxNumber?:string,UID?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    AddressTypeID;
    /** @type {string} */
    AddressContact;
    /** @type {string} */
    AttentionTo;
    /** @type {string} */
    AddressLine1;
    /** @type {string} */
    AddressLine2;
    /** @type {string} */
    AddressLine3;
    /** @type {string} */
    AddressCity;
    /** @type {string} */
    AddressState;
    /** @type {string} */
    AddressZip;
    /** @type {string} */
    AddressCountry;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    FaxNumber;
    /** @type {string} */
    UID;
    /** @type {string} */
    Name;
}
export class OrderHeader {
    /** @param {{ID?:number,AgentID?:number,CustomerID?:number,AgentName?:string,CustomerName?:string,OrderDate?:string,OrderStatus?:number,OrderStatusText?:string,TotalQuantityUnits?:number,TotalOrderCost?:number,TotalProductCost?:number,TotalOrderTax?:number,TotalShippingCost?:number,BillingAddressID?:number,ShippingAddressID?:number,CustomerPaidAmount?:number,Notes?:string,UID?:string,Recalculate?:boolean,PublicOrderID?:string,Address?:string,ShippingAddress?:Address,BillingAddress?:Address,isMultiShip?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    AgentID;
    /** @type {number} */
    CustomerID;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    OrderDate;
    /** @type {number} */
    OrderStatus;
    /** @type {string} */
    OrderStatusText;
    /** @type {number} */
    TotalQuantityUnits;
    /** @type {number} */
    TotalOrderCost;
    /** @type {number} */
    TotalProductCost;
    /** @type {number} */
    TotalOrderTax;
    /** @type {number} */
    TotalShippingCost;
    /** @type {number} */
    BillingAddressID;
    /** @type {number} */
    ShippingAddressID;
    /** @type {number} */
    CustomerPaidAmount;
    /** @type {string} */
    Notes;
    /** @type {string} */
    UID;
    /** @type {boolean} */
    Recalculate;
    /** @type {string} */
    PublicOrderID;
    /** @type {string} */
    Address;
    /** @type {Address} */
    ShippingAddress;
    /** @type {Address} */
    BillingAddress;
    /** @type {boolean} */
    isMultiShip;
}
export class OrderHeadersResponse {
    /** @param {{ResponseStatus?:ResponseStatus,OrderHeaders?:OrderHeader[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {OrderHeader[]} */
    OrderHeaders = [];
}
export class OrderHeadersRequest {
    /** @param {{AgentID?:string,OrderHeaders?:OrderHeader[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AgentID;
    /** @type {OrderHeader[]} */
    OrderHeaders = [];
}

JavaScript 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>