AIM Web Services

<back to all web services

StockCheckRequest

StockCheck
Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce

The following routes are available for this service:
POST/api/StockCheck
import Foundation
import ServiceStack

/**
* StockCheckRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
// @DataContract
public class StockCheckRequest : BaseRequest
{
    // @DataMember
    public var items:[StockCheckItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case items
    }

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

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

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

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

    /**
    * 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 var deviceId:String

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

    required public init(){}
}

// @DataContract
public class StockCheckItem : Codable
{
    // @DataMember
    public var sku:String

    // @DataMember
    public var locationId:Int?

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var qtyRequested:Double?

    required public init(){}
}

// @DataContract
public class StockCheckResponse : BaseResponse
{
    // @DataMember
    public var everythingAvailable:Bool

    // @DataMember
    public var outOfStockItems:[StockCheckErrorItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case everythingAvailable
        case outOfStockItems
    }

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

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

// @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 StockCheckErrorItem : Codable
{
    // @DataMember
    public var sku:String

    // @DataMember
    public var locationId:Int?

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var qtyRequested:Double?

    // @DataMember
    public var message:String

    required public init(){}
}

Swift StockCheckRequest 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/StockCheck HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StockCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Items>
    <StockCheckItem>
      <LocationId>0</LocationId>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckItem>
  </Items>
</StockCheckRequest>

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

<StockCheckResponse 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>
  <EverythingAvailable>false</EverythingAvailable>
  <OutOfStockItems>
    <StockCheckErrorItem>
      <LocationId>0</LocationId>
      <Message>String</Message>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckErrorItem>
  </OutOfStockItems>
</StockCheckResponse>