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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class StockCheckErrorItem
    {
        [DataMember]
        public virtual string SKU { get; set; }

        [DataMember]
        public virtual long? LocationId { get; set; }

        [DataMember]
        public virtual string SerialNumber { get; set; }

        [DataMember]
        public virtual decimal? QtyRequested { get; set; }

        [DataMember]
        public virtual string Message { get; set; }
    }

    [DataContract]
    public partial class StockCheckItem
    {
        [DataMember]
        public virtual string SKU { get; set; }

        [DataMember]
        public virtual long? LocationId { get; set; }

        [DataMember]
        public virtual string SerialNumber { get; set; }

        [DataMember]
        public virtual decimal? QtyRequested { get; set; }
    }

    ///<summary>
    ///StockCheckRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
    ///</summary>
    [DataContract]
    public partial class StockCheckRequest
        : BaseRequest
    {
        public StockCheckRequest()
        {
            Items = new List<StockCheckItem>{};
        }

        [DataMember]
        public virtual List<StockCheckItem> Items { get; set; }
    }

    [DataContract]
    public partial class StockCheckResponse
        : BaseResponse
    {
        public StockCheckResponse()
        {
            OutOfStockItems = new List<StockCheckErrorItem>{};
        }

        [DataMember]
        public virtual bool EverythingAvailable { get; set; }

        [DataMember]
        public virtual List<StockCheckErrorItem> OutOfStockItems { get; set; }
    }

}

C# 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>
  <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>