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

<OrderLinesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <OrderHeaderUID>00000000-0000-0000-0000-000000000000</OrderHeaderUID>
  <OrderLines>
    <OrderLine>
      <ActualDeliveryDate>0001-01-01T00:00:00</ActualDeliveryDate>
      <ActualShipDate>0001-01-01T00:00:00</ActualShipDate>
      <AddressId>0</AddressId>
      <AgentId>0</AgentId>
      <City>String</City>
      <EstimatedDeliveryDate>0001-01-01T00:00:00</EstimatedDeliveryDate>
      <EstimatedShipDate>0001-01-01T00:00:00</EstimatedShipDate>
      <FullName>String</FullName>
      <ID>0</ID>
      <OrderHeaderID>00000000-0000-0000-0000-000000000000</OrderHeaderID>
      <OrderLineCreatedDate>0001-01-01T00:00:00</OrderLineCreatedDate>
      <OrderLineModifiedDate>0001-01-01T00:00:00</OrderLineModifiedDate>
      <OrderLineNumber>0</OrderLineNumber>
      <OrderLineShippingCost>0</OrderLineShippingCost>
      <OrderLineStatusID>0</OrderLineStatusID>
      <OrderLineTax>0</OrderLineTax>
      <PerUnitProductCost>0</PerUnitProductCost>
      <PerUnitShippingCost>0</PerUnitShippingCost>
      <PhoneNumber>String</PhoneNumber>
      <ProductCategory>0</ProductCategory>
      <ProductCost>0</ProductCost>
      <ProductID>0</ProductID>
      <ProductName>String</ProductName>
      <ProductSubCategory>0</ProductSubCategory>
      <Quantity>0</Quantity>
      <ShipMethodID>0</ShipMethodID>
      <ShippingAddress>String</ShippingAddress>
      <State>String</State>
      <Street>String</Street>
      <StripeProductId>String</StripeProductId>
      <TotalOrderLineCost>0</TotalOrderLineCost>
      <UID>00000000-0000-0000-0000-000000000000</UID>
      <Zip>String</Zip>
    </OrderLine>
  </OrderLines>
</OrderLinesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderLinesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <OrderLines>
    <OrderLine>
      <ActualDeliveryDate>0001-01-01T00:00:00</ActualDeliveryDate>
      <ActualShipDate>0001-01-01T00:00:00</ActualShipDate>
      <AddressId>0</AddressId>
      <AgentId>0</AgentId>
      <City>String</City>
      <EstimatedDeliveryDate>0001-01-01T00:00:00</EstimatedDeliveryDate>
      <EstimatedShipDate>0001-01-01T00:00:00</EstimatedShipDate>
      <FullName>String</FullName>
      <ID>0</ID>
      <OrderHeaderID>00000000-0000-0000-0000-000000000000</OrderHeaderID>
      <OrderLineCreatedDate>0001-01-01T00:00:00</OrderLineCreatedDate>
      <OrderLineModifiedDate>0001-01-01T00:00:00</OrderLineModifiedDate>
      <OrderLineNumber>0</OrderLineNumber>
      <OrderLineShippingCost>0</OrderLineShippingCost>
      <OrderLineStatusID>0</OrderLineStatusID>
      <OrderLineTax>0</OrderLineTax>
      <PerUnitProductCost>0</PerUnitProductCost>
      <PerUnitShippingCost>0</PerUnitShippingCost>
      <PhoneNumber>String</PhoneNumber>
      <ProductCategory>0</ProductCategory>
      <ProductCost>0</ProductCost>
      <ProductID>0</ProductID>
      <ProductName>String</ProductName>
      <ProductSubCategory>0</ProductSubCategory>
      <Quantity>0</Quantity>
      <ShipMethodID>0</ShipMethodID>
      <ShippingAddress>String</ShippingAddress>
      <State>String</State>
      <Street>String</Street>
      <StripeProductId>String</StripeProductId>
      <TotalOrderLineCost>0</TotalOrderLineCost>
      <UID>00000000-0000-0000-0000-000000000000</UID>
      <Zip>String</Zip>
    </OrderLine>
  </OrderLines>
  <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>
</OrderLinesResponse>