AIM Web Services

<back to all web services

InventoryDetailRequest

InventoryDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/InventoryDetail
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class LocationInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ShortDesc As String

            <DataMember>
            Public Overridable Property Region As String

            <DataMember>
            Public Overridable Property Latitude As Decimal

            <DataMember>
            Public Overridable Property Longitude As Decimal

            <DataMember>
            Public Overridable Property InStorePickup As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property CashSaleAcct As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class ActiveEInfo
            Public Sub New()
                WebCategoryIds = New List(Of Long)
            End Sub

            <DataMember>
            Public Overridable Property Dimension As String

            <DataMember>
            Public Overridable Property WebDescription As String

            <DataMember>
            Public Overridable Property Summary As String

            <DataMember>
            Public Overridable Property SETitle As String

            <DataMember>
            Public Overridable Property SEDescription As String

            <DataMember>
            Public Overridable Property SEKeywords As String

            <DataMember>
            Public Overridable Property SEAltText As String

            <DataMember>
            Public Overridable Property SEHtmlFreeText As String

            <DataMember>
            Public Overridable Property Unpublished As Boolean

            <DataMember>
            Public Overridable Property FreeShipping As Boolean

            <DataMember>
            Public Overridable Property IsFeatured As Boolean

            <DataMember>
            Public Overridable Property WebCategoryIds As List(Of Long)
        End Class

        <DataContract>
        Public Partial Class AddOnDetail
            <DataMember>
            Public Overridable Property SadPk As Long

            <DataMember>
            Public Overridable Property SkuPk As Long

            <DataMember>
            Public Overridable Property CatPk As Long

            <DataMember>
            Public Overridable Property SubPk As Long

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Price As Decimal
        End Class

        <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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class ImageInfo
            <DataMember>
            Public Overridable Property Url As String

            <DataMember>
            Public Overridable Property ImageStream As String

            <DataMember>
            Public Overridable Property ImageSize As String

            <DataMember>
            Public Overridable Property ErrorMessage As String

            <DataMember>
            Public Overridable Property UriPk As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class InventoryDetailAttribute
            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Value As String

            <DataMember>
            Public Overridable Property Priority As Integer

            '''<Summary>
            '''1 is 'Don't Send to Web', 2 is 'Guided Navigation'
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="1 is 'Don't Send to Web', 2 is 'Guided Navigation'", Name:="WebType", ParameterType:="query")>
            Public Overridable Property WebType As Integer
        End Class

        <DataContract>
        Public Partial Class InventoryDetailByLocation
            Public Sub New()
                Serials = New List(Of InventoryDetailBySerial)
                Substitutes = New List(Of InventoryDetailSubstitute)
            End Sub

            <DataMember>
            Public Overridable Property SaqPk As Long

            <DataMember>
            Public Overridable Property LocationInfo As LocationInfo

            <DataMember>
            Public Overridable Property Serials As List(Of InventoryDetailBySerial)

            <DataMember>
            Public Overridable Property Substitutes As List(Of InventoryDetailSubstitute)

            <DataMember>
            Public Overridable Property Retail As Decimal

            <DataMember>
            Public Overridable Property OurPrice As Decimal

            <DataMember>
            Public Overridable Property SalePrice As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property SaleInfo As String

            <DataMember>
            Public Overridable Property PriceA As Decimal

            <DataMember>
            Public Overridable Property PriceB As Decimal

            <DataMember>
            Public Overridable Property PriceC As Decimal

            <DataMember>
            Public Overridable Property MinPrice As Decimal

            <DataMember>
            Public Overridable Property ActiveEPrice As Decimal

            <DataMember>
            Public Overridable Property CustomerPrice As Decimal

            <DataMember>
            Public Overridable Property AllowPriceChange As Boolean

            <DataMember>
            Public Overridable Property Qty As Decimal

            <DataMember>
            Public Overridable Property QtyAvail As Decimal

            <DataMember>
            Public Overridable Property ActiveeHoldbackQty As Decimal

            <DataMember>
            Public Overridable Property ReorderMin As Integer

            <DataMember>
            Public Overridable Property ReorderMax As Integer

            <DataMember>
            Public Overridable Property AverageCost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property WeightedCost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Locator As String

            <DataMember>
            Public Overridable Property SelectionCode As String

            <DataMember>
            Public Overridable Property SelectionCodeDescription As String

            <DataMember>
            Public Overridable Property Spiff As Decimal

            <DataMember>
            Public Overridable Property CurrentSpotCheckQty As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property QtyOut As Decimal

            <DataMember>
            Public Overridable Property QtyOnOrder As Decimal

            <DataMember>
            Public Overridable Property AvailableForSTR As Decimal
        End Class

        <DataContract>
        Public Partial Class InventoryDetailBySerial
            Public Sub New()
                Attributes = New List(Of InventoryDetailAttribute)
                Images = New List(Of ImageInfo)
            End Sub

            <DataMember>
            Public Overridable Property SasPk As Long

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property Retail As Decimal

            <DataMember>
            Public Overridable Property OurPrice As Decimal

            <DataMember>
            Public Overridable Property SalePrice As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property SaleInfo As String

            <DataMember>
            Public Overridable Property PriceA As Decimal

            <DataMember>
            Public Overridable Property PriceB As Decimal

            <DataMember>
            Public Overridable Property PriceC As Decimal

            <DataMember>
            Public Overridable Property MinPrice As Decimal

            <DataMember>
            Public Overridable Property ActiveEPrice As Decimal

            <DataMember>
            Public Overridable Property AllowPriceChange As Boolean

            <DataMember>
            Public Overridable Property Cost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property WeightedCost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Attributes As List(Of InventoryDetailAttribute)

            <DataMember>
            Public Overridable Property Images As List(Of ImageInfo)

            <DataMember>
            Public Overridable Property HasImages As Boolean

            <DataMember>
            Public Overridable Property IsActiveeHoldback As Boolean

            <DataMember>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property AvailableForSTR As Boolean
        End Class

        <DataContract>
        Public Partial Class InventoryDetailByVariant
            Public Sub New()
                Attributes = New List(Of InventoryDetailAttribute)
                LocationDetails = New List(Of InventoryDetailByLocation)
                Images = New List(Of ImageInfo)
                Barcodes = New List(Of String)
            End Sub

            <DataMember>
            Public Overridable Property SkuPk As Long

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property VendorCost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property VendorName As String

            <DataMember>
            Public Overridable Property Attributes As List(Of InventoryDetailAttribute)

            <DataMember>
            Public Overridable Property LocationDetails As List(Of InventoryDetailByLocation)

            <DataMember>
            Public Overridable Property Images As List(Of ImageInfo)

            <DataMember>
            Public Overridable Property HasImages As Boolean

            <DataMember>
            Public Overridable Property Barcodes As List(Of String)
        End Class

        '''<Summary>
        '''InventoryDetailRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class InventoryDetailRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Pk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property PkType As String

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property SkipImages As Boolean

            <DataMember>
            Public Overridable Property IncludeSerialInfo As Boolean

            <DataMember>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class InventoryDetailResponse
            Inherits BaseResponse
            Public Sub New()
                Images = New List(Of ImageInfo)
                VariantDetails = New List(Of InventoryDetailByVariant)
                AddOns = New List(Of AddOnDetail)
            End Sub

            <DataMember>
            Public Overridable Property SadPk As Long

            <DataMember>
            Public Overridable Property InvType As String

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Mfg As String

            <DataMember>
            Public Overridable Property Category As Integer

            <DataMember>
            Public Overridable Property CategoryDescription As String

            <DataMember>
            Public Overridable Property SubCategory As Integer

            <DataMember>
            Public Overridable Property SubCategoryDescription As String

            <DataMember>
            Public Overridable Property SelectionCode As String

            <DataMember>
            Public Overridable Property SelectionCodeDescription As String

            <DataMember>
            Public Overridable Property SellSerialsOnline As Boolean

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Images As List(Of ImageInfo)

            <DataMember>
            Public Overridable Property HasImages As Boolean

            <DataMember>
            Public Overridable Property VariantDetails As List(Of InventoryDetailByVariant)

            <DataMember>
            Public Overridable Property AddOns As List(Of AddOnDetail)

            <DataMember>
            Public Overridable Property ActiveEInfo As ActiveEInfo

            <DataMember>
            Public Overridable Property Weight As Decimal

            <DataMember>
            Public Overridable Property Unit As String

            <DataMember>
            Public Overridable Property ShipCharge As Decimal
        End Class

        <DataContract>
        Public Partial Class InventoryDetailSubstitute
            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Mfg As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property AvailableQty As Decimal
        End Class
    End Namespace
End Namespace

VB.NET InventoryDetailRequest 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/InventoryDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Pk":0,"PkType":"String","Model":"String","SkipImages":false,"IncludeSerialInfo":false,"CustomerAcct":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"SadPk":0,"InvType":"String","Model":"String","Description":"String","Mfg":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","SelectionCode":"String","SelectionCodeDescription":"String","SellSerialsOnline":false,"Notes":"String","Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"HasImages":true,"VariantDetails":[{}],"AddOns":[{}],"ActiveEInfo":{"Dimension":"String","WebDescription":"String","Summary":"String","SETitle":"String","SEDescription":"String","SEKeywords":"String","SEAltText":"String","SEHtmlFreeText":"String","Unpublished":false,"FreeShipping":false,"IsFeatured":false,"WebCategoryIds":[0]},"Weight":0,"Unit":"String","ShipCharge":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}