Trendsic Platform Service

<back to all web services

OrderLinesRequest

The following routes are available for this service:
POST,PUT,DELETE,OPTIONS/v1/OrderLines
GET/v1/OrderLines/OrderHeaders/{OrderHeaderUID}
"use strict";
export class OrderLine {
    /** @param {{ID?:number,OrderHeaderID?:string,OrderLineNumber?:number,ProductID?:number,StripeProductId?:string,ProductCategory?:number,ProductSubCategory?:number,Quantity?:number,TotalOrderLineCost?:number,ProductCost?:number,PerUnitProductCost?:number,OrderLineTax?:number,OrderLineShippingCost?:number,PerUnitShippingCost?:number,OrderLineStatusID?:number,ShipMethodID?:number,EstimatedShipDate?:string,EstimatedDeliveryDate?:string,ActualShipDate?:string,ActualDeliveryDate?:string,OrderLineCreatedDate?:string,OrderLineModifiedDate?:string,UID?:string,ProductName?:string,AgentId?:number,Street?:string,City?:string,State?:string,Zip?:string,PhoneNumber?:string,AddressId?:number,ShippingAddress?:string,FullName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    OrderHeaderID;
    /** @type {number} */
    OrderLineNumber;
    /** @type {number} */
    ProductID;
    /** @type {string} */
    StripeProductId;
    /** @type {number} */
    ProductCategory;
    /** @type {number} */
    ProductSubCategory;
    /** @type {number} */
    Quantity;
    /** @type {number} */
    TotalOrderLineCost;
    /** @type {number} */
    ProductCost;
    /** @type {number} */
    PerUnitProductCost;
    /** @type {number} */
    OrderLineTax;
    /** @type {number} */
    OrderLineShippingCost;
    /** @type {number} */
    PerUnitShippingCost;
    /** @type {number} */
    OrderLineStatusID;
    /** @type {number} */
    ShipMethodID;
    /** @type {string} */
    EstimatedShipDate;
    /** @type {string} */
    EstimatedDeliveryDate;
    /** @type {string} */
    ActualShipDate;
    /** @type {string} */
    ActualDeliveryDate;
    /** @type {string} */
    OrderLineCreatedDate;
    /** @type {string} */
    OrderLineModifiedDate;
    /** @type {string} */
    UID;
    /** @type {string} */
    ProductName;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    Street;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    PhoneNumber;
    /** @type {number} */
    AddressId;
    /** @type {string} */
    ShippingAddress;
    /** @type {string} */
    FullName;
}
export class OrderLinesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,OrderLines?:OrderLine[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {OrderLine[]} */
    OrderLines = [];
}
export class OrderLinesRequest {
    /** @param {{OrderHeaderUID?:string,OrderLines?:OrderLine[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    OrderHeaderUID;
    /** @type {OrderLine[]} */
    OrderLines = [];
}

JavaScript OrderLinesRequest 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/OrderLines HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"OrderHeaderUID":"00000000000000000000000000000000","OrderLines":[{"ID":0,"OrderHeaderID":"00000000000000000000000000000000","OrderLineNumber":0,"ProductID":0,"StripeProductId":"String","ProductCategory":0,"ProductSubCategory":0,"Quantity":0,"TotalOrderLineCost":0,"ProductCost":0,"PerUnitProductCost":0,"OrderLineTax":0,"OrderLineShippingCost":0,"PerUnitShippingCost":0,"OrderLineStatusID":0,"ShipMethodID":0,"EstimatedShipDate":"0001-01-01T00:00:00.0000000","EstimatedDeliveryDate":"0001-01-01T00:00:00.0000000","ActualShipDate":"0001-01-01T00:00:00.0000000","ActualDeliveryDate":"0001-01-01T00:00:00.0000000","OrderLineCreatedDate":"0001-01-01T00:00:00.0000000","OrderLineModifiedDate":"0001-01-01T00:00:00.0000000","UID":"00000000000000000000000000000000","ProductName":"String","AgentId":0,"Street":"String","City":"String","State":"String","Zip":"String","PhoneNumber":"String","AddressId":0,"ShippingAddress":"String","FullName":"String"}]}

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"}},"OrderLines":[{"ID":0,"OrderHeaderID":"00000000000000000000000000000000","OrderLineNumber":0,"ProductID":0,"StripeProductId":"String","ProductCategory":0,"ProductSubCategory":0,"Quantity":0,"TotalOrderLineCost":0,"ProductCost":0,"PerUnitProductCost":0,"OrderLineTax":0,"OrderLineShippingCost":0,"PerUnitShippingCost":0,"OrderLineStatusID":0,"ShipMethodID":0,"EstimatedShipDate":"0001-01-01T00:00:00.0000000","EstimatedDeliveryDate":"0001-01-01T00:00:00.0000000","ActualShipDate":"0001-01-01T00:00:00.0000000","ActualDeliveryDate":"0001-01-01T00:00:00.0000000","OrderLineCreatedDate":"0001-01-01T00:00:00.0000000","OrderLineModifiedDate":"0001-01-01T00:00:00.0000000","UID":"00000000000000000000000000000000","ProductName":"String","AgentId":0,"Street":"String","City":"String","State":"String","Zip":"String","PhoneNumber":"String","AddressId":0,"ShippingAddress":"String","FullName":"String"}]}