AIM Web Services

<back to all web services

CustomerOrderFulfillmentRequest

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

The following routes are available for this service:
GET/api/CustomerOrderFulfillment
"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 CustomerOrderItem {
    /** @param {{Id?:number,Item?:string,Description?:string,Price?:number,Quantity?:number,QuantityPicked?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Item;
    /** @type {string} */
    Description;
    /** @type {number} */
    Price;
    /** @type {number} */
    Quantity;
    /** @type {number} */
    QuantityPicked;
}
export class CustomerWebOrder {
    /** @param {{WebOrder?:string,CustomerName?:string,DateTime?:string,Items?:CustomerOrderItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    WebOrder;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    DateTime;
    /** @type {CustomerOrderItem[]} */
    Items;
}
export class CustomerOrderFulfillmentResponse extends BaseResponse {
    /** @param {{WebOrder?:string,CustomerName?:string,DateTime?:string,Items?:CustomerOrderItem[],Orders?:CustomerWebOrder[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    WebOrder;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    DateTime;
    /** @type {CustomerOrderItem[]} */
    Items;
    /** @type {CustomerWebOrder[]} */
    Orders;
}
export class CustomerOrderFulfillmentRequest extends BaseSecureRequest {
    /** @param {{WebOrder?:string,StartOffset?:number,RecordCount?:number,ExcludeFullyPickedOrders?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Pass in if only looking for one weborder. Otherwise do not pass in. */
    WebOrder;
    /**
     * @type {?number}
     * @description Starting offset for Pagination. Defaults to 0. */
    StartOffset;
    /**
     * @type {?number}
     * @description Records to be returned. Default to 100. */
    RecordCount;
    /**
     * @type {boolean}
     * @description If sent, fully picked orders will not be returned. */
    ExcludeFullyPickedOrders;
}

JavaScript CustomerOrderFulfillmentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/CustomerOrderFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"WebOrder":"String","CustomerName":"String","Items":[{"Id":0,"Item":"String","Description":"String","Price":0,"Quantity":0,"QuantityPicked":0}],"Orders":[{"WebOrder":"String","CustomerName":"String","Items":[{"Id":0,"Item":"String","Description":"String","Price":0,"Quantity":0,"QuantityPicked":0}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}