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;

    /** @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 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 .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.

POST /api/CustomerOrders HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
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","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}