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
// @ts-nocheck

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token?: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress?: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status?: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerOrderItem
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Item?: string;

    // @DataMember
    public Description?: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public QuantityPicked: number;

    public constructor(init?: Partial<CustomerOrderItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerWebOrder
{
    // @DataMember
    public WebOrder?: string;

    // @DataMember
    public CustomerName?: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Items?: CustomerOrderItem[];

    public constructor(init?: Partial<CustomerWebOrder>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerOrderFulfillmentResponse extends BaseResponse
{
    // @DataMember
    public WebOrder?: string;

    // @DataMember
    public CustomerName?: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Items?: CustomerOrderItem[];

    // @DataMember
    public Orders?: CustomerWebOrder[];

    public constructor(init?: Partial<CustomerOrderFulfillmentResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce. */
// @DataContract
export class CustomerOrderFulfillmentRequest extends BaseSecureRequest
{
    /** @description Pass in if only looking for one weborder. Otherwise do not pass in. */
    // @DataMember
    // @ApiMember(Description="Pass in if only looking for one weborder. Otherwise do not pass in.", Name="WebOrder", ParameterType="query")
    public WebOrder?: string;

    /** @description Starting offset for Pagination. Defaults to 0. */
    // @DataMember
    // @ApiMember(Description="Starting offset for Pagination. Defaults to 0.", Name="StartOffset", ParameterType="query")
    public StartOffset?: number;

    /** @description Records to be returned. Default to 100. */
    // @DataMember
    // @ApiMember(Description="Records to be returned. Default to 100.", Name="RecordCount", ParameterType="query")
    public RecordCount?: number;

    /** @description If sent, fully picked orders will not be returned. */
    // @DataMember
    // @ApiMember(Description="If sent, fully picked orders will not be returned.", Name="ExcludeFullyPickedOrders", ParameterType="query")
    public ExcludeFullyPickedOrders: boolean;

    public constructor(init?: Partial<CustomerOrderFulfillmentRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CustomerOrderFulfillmentRequest 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.

GET /api/CustomerOrderFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}