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

// @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;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: 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 .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.

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

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

<CustomerOrderFulfillmentResponse 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>
  <CustomerName>String</CustomerName>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <Items>
    <CustomerOrderItem>
      <Description>String</Description>
      <Id>0</Id>
      <Item>String</Item>
      <Price>0</Price>
      <Quantity>0</Quantity>
      <QuantityPicked>0</QuantityPicked>
    </CustomerOrderItem>
  </Items>
  <Orders>
    <CustomerWebOrder>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <Items>
        <CustomerOrderItem>
          <Description>String</Description>
          <Id>0</Id>
          <Item>String</Item>
          <Price>0</Price>
          <Quantity>0</Quantity>
          <QuantityPicked>0</QuantityPicked>
        </CustomerOrderItem>
      </Items>
      <WebOrder>String</WebOrder>
    </CustomerWebOrder>
  </Orders>
  <WebOrder>String</WebOrder>
</CustomerOrderFulfillmentResponse>