| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"Orders":[{"OrderNumber":"String","TransactionState":"String","PaymentMethod":"String","OrderNotes":"String","AuthorizationCode":"String","ShippingMethod":"String","Total":0,"SubTotal":0,"TaxTotal":0,"ShippingTotal":0,"CardType":"String","CardToken":"String","CardSpan":"String","CardExpirationMonth":"String","CardExpirationYear":"String","CustomerAcct":0,"Email":"String","PO":"String","EmployeeUsername":"String","AeOnApprovalOrderSubtotal":0,"AeOnApprovalOrderShipping":0,"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":[{"ProductName":"String","Sku":"String","SerialNumber":"String","WebNumber":"String","Location":"String","Qty":0,"QtyPicked":0,"UseQtyPicked":false,"Price":0,"OnApproval":false,"IsECard":false,"NiCat":0,"NiSub":0,"ExtPk":0}]}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}