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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
@DataContract
open 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")
    open var WebOrder:String? = null

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

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

    /**
    * 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")
    open var ExcludeFullyPickedOrders:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 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")
    open var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * 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")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class CustomerOrderFulfillmentResponse : BaseResponse()
{
    @DataMember
    open var WebOrder:String? = null

    @DataMember
    open var CustomerName:String? = null

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var Items:ArrayList<CustomerOrderItem>? = null

    @DataMember
    open var Orders:ArrayList<CustomerWebOrder>? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class CustomerOrderItem
{
    @DataMember
    open var Id:Long? = null

    @DataMember
    open var Item:String? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var Quantity:BigDecimal? = null

    @DataMember
    open var QuantityPicked:BigDecimal? = null
}

@DataContract
open class CustomerWebOrder
{
    @DataMember
    open var WebOrder:String? = null

    @DataMember
    open var CustomerName:String? = null

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var Items:ArrayList<CustomerOrderItem>? = null
}

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