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}
"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 .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}]}