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
import Foundation
import ServiceStack

/**
* CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
public class CustomerOrdersRequest : BaseSecureRequest
{
    // @DataMember
    public var orders:[ThirdPartyOrder] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case orders
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        orders = try container.decodeIfPresent([ThirdPartyOrder].self, forKey: .orders) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if orders.count > 0 { try container.encode(orders, forKey: .orders) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

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

    required public init(){}
}

// @DataContract
public class ThirdPartyOrder : Codable
{
    // @DataMember
    public var orderNumber:String

    // @DataMember
    public var orderDate:Date

    // @DataMember
    public var transactionState:String

    // @DataMember
    public var paymentMethod:String

    // @DataMember
    public var orderNotes:String

    // @DataMember
    public var authorizationCode:String

    // @DataMember
    public var shippingMethod:String

    // @DataMember
    public var total:Double

    // @DataMember
    public var subTotal:Double

    // @DataMember
    public var taxTotal:Double

    // @DataMember
    public var shippingTotal:Double

    // @DataMember
    public var cardType:String

    // @DataMember
    public var cardToken:String

    // @DataMember
    public var cardSpan:String

    // @DataMember
    public var cardExpirationMonth:String

    // @DataMember
    public var cardExpirationYear:String

    // @DataMember
    public var customerAcct:Int

    // @DataMember
    public var email:String

    // @DataMember
    public var po:String

    // @DataMember
    public var employeeUsername:String

    // @DataMember
    public var aeOnApprovalOrderSubtotal:Double

    // @DataMember
    public var aeOnApprovalOrderShipping:Double

    // @DataMember
    public var shippingAttn:String

    // @DataMember
    public var shippingName:String

    // @DataMember
    public var shippingFirstName:String

    // @DataMember
    public var shippingLastName:String

    // @DataMember
    public var shippingCompany:String

    // @DataMember
    public var shippingAddr1:String

    // @DataMember
    public var shippingAddr2:String

    // @DataMember
    public var shippingCity:String

    // @DataMember
    public var shippingSt:String

    // @DataMember
    public var shippingZip:String

    // @DataMember
    public var shippingCountry:String

    // @DataMember
    public var shippingPhone:String

    // @DataMember
    public var billingAttn:String

    // @DataMember
    public var billingName:String

    // @DataMember
    public var billingFirstName:String

    // @DataMember
    public var billingLastName:String

    // @DataMember
    public var billingCompany:String

    // @DataMember
    public var billingAddr1:String

    // @DataMember
    public var billingAddr2:String

    // @DataMember
    public var billingCity:String

    // @DataMember
    public var billingSt:String

    // @DataMember
    public var billingZip:String

    // @DataMember
    public var billingCountry:String

    // @DataMember
    public var billingPhone:String

    // @DataMember
    public var orderSource:String

    // @DataMember
    public var cardName:String

    // @DataMember
    public var pnRef:String

    // @DataMember
    public var lineItems:[ThirdPartyOrderItem] = []

    required public init(){}
}

// @DataContract
public class ThirdPartyOrderItem : Codable
{
    // @DataMember
    public var productName:String

    // @DataMember
    public var sku:String

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var webNumber:String

    // @DataMember
    public var location:String

    // @DataMember
    public var qty:Double

    // @DataMember
    public var qtyPicked:Double

    // @DataMember
    public var useQtyPicked:Bool

    // @DataMember
    public var price:Double

    // @DataMember
    public var onApproval:Bool

    // @DataMember
    public var isECard:Bool

    // @DataMember
    public var niCat:Int?

    // @DataMember
    public var niSub:Int?

    // @DataMember
    public var extPk:Int?

    required public init(){}
}

// @DataContract
public class CustomerOrdersResponse : BaseResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift CustomerOrdersRequest 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.

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

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

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