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

// @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 CustomerOrdersResponse extends BaseResponse
{

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

// @DataContract
export class ThirdPartyOrderItem
{
    // @DataMember
    public ProductName: string;

    // @DataMember
    public Sku: string;

    // @DataMember
    public SerialNumber: string;

    // @DataMember
    public WebNumber: string;

    // @DataMember
    public Location: string;

    // @DataMember
    public Qty: number;

    // @DataMember
    public QtyPicked: number;

    // @DataMember
    public UseQtyPicked: boolean;

    // @DataMember
    public Price: number;

    // @DataMember
    public OnApproval: boolean;

    // @DataMember
    public IsECard: boolean;

    // @DataMember
    public NiCat?: number;

    // @DataMember
    public NiSub?: number;

    // @DataMember
    public ExtPk?: number;

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

// @DataContract
export class ThirdPartyOrder
{
    // @DataMember
    public OrderNumber: string;

    // @DataMember
    public OrderDate: string;

    // @DataMember
    public TransactionState: string;

    // @DataMember
    public PaymentMethod: string;

    // @DataMember
    public OrderNotes: string;

    // @DataMember
    public AuthorizationCode: string;

    // @DataMember
    public ShippingMethod: string;

    // @DataMember
    public Total: number;

    // @DataMember
    public SubTotal: number;

    // @DataMember
    public TaxTotal: number;

    // @DataMember
    public ShippingTotal: number;

    // @DataMember
    public CardType: string;

    // @DataMember
    public CardToken: string;

    // @DataMember
    public CardSpan: string;

    // @DataMember
    public CardExpirationMonth: string;

    // @DataMember
    public CardExpirationYear: string;

    // @DataMember
    public CustomerAcct: number;

    // @DataMember
    public Email: string;

    // @DataMember
    public PO: string;

    // @DataMember
    public EmployeeUsername: string;

    // @DataMember
    public AeOnApprovalOrderSubtotal: number;

    // @DataMember
    public AeOnApprovalOrderShipping: number;

    // @DataMember
    public ShippingAttn: string;

    // @DataMember
    public ShippingName: string;

    // @DataMember
    public ShippingFirstName: string;

    // @DataMember
    public ShippingLastName: string;

    // @DataMember
    public ShippingCompany: string;

    // @DataMember
    public ShippingAddr1: string;

    // @DataMember
    public ShippingAddr2: string;

    // @DataMember
    public ShippingCity: string;

    // @DataMember
    public ShippingSt: string;

    // @DataMember
    public ShippingZip: string;

    // @DataMember
    public ShippingCountry: string;

    // @DataMember
    public ShippingPhone: string;

    // @DataMember
    public BillingAttn: string;

    // @DataMember
    public BillingName: string;

    // @DataMember
    public BillingFirstName: string;

    // @DataMember
    public BillingLastName: string;

    // @DataMember
    public BillingCompany: string;

    // @DataMember
    public BillingAddr1: string;

    // @DataMember
    public BillingAddr2: string;

    // @DataMember
    public BillingCity: string;

    // @DataMember
    public BillingSt: string;

    // @DataMember
    public BillingZip: string;

    // @DataMember
    public BillingCountry: string;

    // @DataMember
    public BillingPhone: string;

    // @DataMember
    public OrderSource: string;

    // @DataMember
    public CardName: string;

    // @DataMember
    public PnRef: string;

    // @DataMember
    public LineItems: ThirdPartyOrderItem[];

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

/** @description CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce. */
// @DataContract
export class CustomerOrdersRequest extends BaseSecureRequest
{
    // @DataMember
    public Orders: ThirdPartyOrder[];

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

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