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

/**
* CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
public class CustomerOrderFulfillmentRequest : BaseSecureRequest
{
    /**
    * 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 var webOrder:String

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

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

    /**
    * 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 var excludeFullyPickedOrders:Bool

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

    private enum CodingKeys : String, CodingKey {
        case webOrder
        case startOffset
        case recordCount
        case excludeFullyPickedOrders
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        webOrder = try container.decodeIfPresent(String.self, forKey: .webOrder)
        startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
        recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
        excludeFullyPickedOrders = try container.decodeIfPresent(Bool.self, forKey: .excludeFullyPickedOrders)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if webOrder != nil { try container.encode(webOrder, forKey: .webOrder) }
        if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
        if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
        if excludeFullyPickedOrders != nil { try container.encode(excludeFullyPickedOrders, forKey: .excludeFullyPickedOrders) }
    }
}

// @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 CustomerOrderFulfillmentResponse : BaseResponse
{
    // @DataMember
    public var webOrder:String

    // @DataMember
    public var customerName:String

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var items:[CustomerOrderItem] = []

    // @DataMember
    public var orders:[CustomerWebOrder] = []

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

    private enum CodingKeys : String, CodingKey {
        case webOrder
        case customerName
        case dateTime
        case items
        case orders
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        webOrder = try container.decodeIfPresent(String.self, forKey: .webOrder)
        customerName = try container.decodeIfPresent(String.self, forKey: .customerName)
        dateTime = try container.decodeIfPresent(Date.self, forKey: .dateTime)
        items = try container.decodeIfPresent([CustomerOrderItem].self, forKey: .items) ?? []
        orders = try container.decodeIfPresent([CustomerWebOrder].self, forKey: .orders) ?? []
    }

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

// @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(){}
}

// @DataContract
public class CustomerOrderItem : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var item:String

    // @DataMember
    public var Description:String

    // @DataMember
    public var price:Double

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var quantityPicked:Double

    required public init(){}
}

// @DataContract
public class CustomerWebOrder : Codable
{
    // @DataMember
    public var webOrder:String

    // @DataMember
    public var customerName:String

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var items:[CustomerOrderItem] = []

    required public init(){}
}

Swift 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"}}