AIM Web Services

<back to all web services

CustomerOrdersRequest

CustomerOrders
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
POST/api/CustomerOrders
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class CustomerOrdersResponse extends BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ThirdPartyOrderItem {
    /** @param {{ProductName?:string,Sku?:string,SerialNumber?:string,WebNumber?:string,Location?:string,Qty?:number,QtyPicked?:number,UseQtyPicked?:boolean,Price?:number,OnApproval?:boolean,IsECard?:boolean,NiCat?:number,NiSub?:number,ExtPk?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProductName;
    /** @type {string} */
    Sku;
    /** @type {string} */
    SerialNumber;
    /** @type {string} */
    WebNumber;
    /** @type {string} */
    Location;
    /** @type {number} */
    Qty;
    /** @type {number} */
    QtyPicked;
    /** @type {boolean} */
    UseQtyPicked;
    /** @type {number} */
    Price;
    /** @type {boolean} */
    OnApproval;
    /** @type {boolean} */
    IsECard;
    /** @type {?number} */
    NiCat;
    /** @type {?number} */
    NiSub;
    /** @type {?number} */
    ExtPk;
}
export class ThirdPartyOrder {
    /** @param {{OrderNumber?:string,OrderDate?:string,TransactionState?:string,PaymentMethod?:string,OrderNotes?:string,AuthorizationCode?:string,ShippingMethod?:string,Total?:number,SubTotal?:number,TaxTotal?:number,ShippingTotal?:number,CardType?:string,CardToken?:string,CardSpan?:string,CardExpirationMonth?:string,CardExpirationYear?:string,CustomerAcct?:number,Email?:string,PO?:string,EmployeeUsername?:string,AeOnApprovalOrderSubtotal?:number,AeOnApprovalOrderShipping?:number,ShippingAttn?:string,ShippingName?:string,ShippingFirstName?:string,ShippingLastName?:string,ShippingCompany?:string,ShippingAddr1?:string,ShippingAddr2?:string,ShippingCity?:string,ShippingSt?:string,ShippingZip?:string,ShippingCountry?:string,ShippingPhone?:string,BillingAttn?:string,BillingName?:string,BillingFirstName?:string,BillingLastName?:string,BillingCompany?:string,BillingAddr1?:string,BillingAddr2?:string,BillingCity?:string,BillingSt?:string,BillingZip?:string,BillingCountry?:string,BillingPhone?:string,OrderSource?:string,CardName?:string,PnRef?:string,LineItems?:ThirdPartyOrderItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    OrderNumber;
    /** @type {string} */
    OrderDate;
    /** @type {string} */
    TransactionState;
    /** @type {string} */
    PaymentMethod;
    /** @type {string} */
    OrderNotes;
    /** @type {string} */
    AuthorizationCode;
    /** @type {string} */
    ShippingMethod;
    /** @type {number} */
    Total;
    /** @type {number} */
    SubTotal;
    /** @type {number} */
    TaxTotal;
    /** @type {number} */
    ShippingTotal;
    /** @type {string} */
    CardType;
    /** @type {string} */
    CardToken;
    /** @type {string} */
    CardSpan;
    /** @type {string} */
    CardExpirationMonth;
    /** @type {string} */
    CardExpirationYear;
    /** @type {number} */
    CustomerAcct;
    /** @type {string} */
    Email;
    /** @type {string} */
    PO;
    /** @type {string} */
    EmployeeUsername;
    /** @type {number} */
    AeOnApprovalOrderSubtotal;
    /** @type {number} */
    AeOnApprovalOrderShipping;
    /** @type {string} */
    ShippingAttn;
    /** @type {string} */
    ShippingName;
    /** @type {string} */
    ShippingFirstName;
    /** @type {string} */
    ShippingLastName;
    /** @type {string} */
    ShippingCompany;
    /** @type {string} */
    ShippingAddr1;
    /** @type {string} */
    ShippingAddr2;
    /** @type {string} */
    ShippingCity;
    /** @type {string} */
    ShippingSt;
    /** @type {string} */
    ShippingZip;
    /** @type {string} */
    ShippingCountry;
    /** @type {string} */
    ShippingPhone;
    /** @type {string} */
    BillingAttn;
    /** @type {string} */
    BillingName;
    /** @type {string} */
    BillingFirstName;
    /** @type {string} */
    BillingLastName;
    /** @type {string} */
    BillingCompany;
    /** @type {string} */
    BillingAddr1;
    /** @type {string} */
    BillingAddr2;
    /** @type {string} */
    BillingCity;
    /** @type {string} */
    BillingSt;
    /** @type {string} */
    BillingZip;
    /** @type {string} */
    BillingCountry;
    /** @type {string} */
    BillingPhone;
    /** @type {string} */
    OrderSource;
    /** @type {string} */
    CardName;
    /** @type {string} */
    PnRef;
    /** @type {ThirdPartyOrderItem[]} */
    LineItems;
}
export class CustomerOrdersRequest extends BaseSecureRequest {
    /** @param {{Orders?:ThirdPartyOrder[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ThirdPartyOrder[]} */
    Orders;
}

JavaScript CustomerOrdersRequest 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 /api/CustomerOrders HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Misc">
    <d2p1:ThirdPartyOrder>
      <d2p1:AeOnApprovalOrderShipping>0</d2p1:AeOnApprovalOrderShipping>
      <d2p1:AeOnApprovalOrderSubtotal>0</d2p1:AeOnApprovalOrderSubtotal>
      <d2p1:AuthorizationCode>String</d2p1:AuthorizationCode>
      <d2p1:BillingAddr1>String</d2p1:BillingAddr1>
      <d2p1:BillingAddr2>String</d2p1:BillingAddr2>
      <d2p1:BillingAttn>String</d2p1:BillingAttn>
      <d2p1:BillingCity>String</d2p1:BillingCity>
      <d2p1:BillingCompany>String</d2p1:BillingCompany>
      <d2p1:BillingCountry>String</d2p1:BillingCountry>
      <d2p1:BillingFirstName>String</d2p1:BillingFirstName>
      <d2p1:BillingLastName>String</d2p1:BillingLastName>
      <d2p1:BillingName>String</d2p1:BillingName>
      <d2p1:BillingPhone>String</d2p1:BillingPhone>
      <d2p1:BillingSt>String</d2p1:BillingSt>
      <d2p1:BillingZip>String</d2p1:BillingZip>
      <d2p1:CardExpirationMonth>String</d2p1:CardExpirationMonth>
      <d2p1:CardExpirationYear>String</d2p1:CardExpirationYear>
      <d2p1:CardName>String</d2p1:CardName>
      <d2p1:CardSpan>String</d2p1:CardSpan>
      <d2p1:CardToken>String</d2p1:CardToken>
      <d2p1:CardType>String</d2p1:CardType>
      <d2p1:CustomerAcct>0</d2p1:CustomerAcct>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:EmployeeUsername>String</d2p1:EmployeeUsername>
      <d2p1:LineItems>
        <d2p1:ThirdPartyOrder.ThirdPartyOrderItem>
          <d2p1:ExtPk>0</d2p1:ExtPk>
          <d2p1:IsECard>false</d2p1:IsECard>
          <d2p1:Location>String</d2p1:Location>
          <d2p1:NiCat>0</d2p1:NiCat>
          <d2p1:NiSub>0</d2p1:NiSub>
          <d2p1:OnApproval>false</d2p1:OnApproval>
          <d2p1:Price>0</d2p1:Price>
          <d2p1:ProductName>String</d2p1:ProductName>
          <d2p1:Qty>0</d2p1:Qty>
          <d2p1:QtyPicked>0</d2p1:QtyPicked>
          <d2p1:SerialNumber>String</d2p1:SerialNumber>
          <d2p1:Sku>String</d2p1:Sku>
          <d2p1:UseQtyPicked>false</d2p1:UseQtyPicked>
          <d2p1:WebNumber>String</d2p1:WebNumber>
        </d2p1:ThirdPartyOrder.ThirdPartyOrderItem>
      </d2p1:LineItems>
      <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
      <d2p1:OrderNotes>String</d2p1:OrderNotes>
      <d2p1:OrderNumber>String</d2p1:OrderNumber>
      <d2p1:OrderSource>String</d2p1:OrderSource>
      <d2p1:PO>String</d2p1:PO>
      <d2p1:PaymentMethod>String</d2p1:PaymentMethod>
      <d2p1:PnRef>String</d2p1:PnRef>
      <d2p1:ShippingAddr1>String</d2p1:ShippingAddr1>
      <d2p1:ShippingAddr2>String</d2p1:ShippingAddr2>
      <d2p1:ShippingAttn>String</d2p1:ShippingAttn>
      <d2p1:ShippingCity>String</d2p1:ShippingCity>
      <d2p1:ShippingCompany>String</d2p1:ShippingCompany>
      <d2p1:ShippingCountry>String</d2p1:ShippingCountry>
      <d2p1:ShippingFirstName>String</d2p1:ShippingFirstName>
      <d2p1:ShippingLastName>String</d2p1:ShippingLastName>
      <d2p1:ShippingMethod>String</d2p1:ShippingMethod>
      <d2p1:ShippingName>String</d2p1:ShippingName>
      <d2p1:ShippingPhone>String</d2p1:ShippingPhone>
      <d2p1:ShippingSt>String</d2p1:ShippingSt>
      <d2p1:ShippingTotal>0</d2p1:ShippingTotal>
      <d2p1:ShippingZip>String</d2p1:ShippingZip>
      <d2p1:SubTotal>0</d2p1:SubTotal>
      <d2p1:TaxTotal>0</d2p1:TaxTotal>
      <d2p1:Total>0</d2p1:Total>
      <d2p1:TransactionState>String</d2p1:TransactionState>
    </d2p1:ThirdPartyOrder>
  </Orders>
</CustomerOrdersRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</CustomerOrdersResponse>