Richemont.Booster2.PublicApi

<back to all web services

GetAggregatedStock

Requires Authentication
The following routes are available for this service:
GET/aggregatedStock/{brand}/{posCode}Get aggregated stock
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Stock.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.Stock.ServiceModel

        Public Partial Class AggregatedStockResponse
            Inherits ClusterStock
        End Class

        Public Partial Class ClusterStock
            '''<Summary>
            '''Cluster code
            '''</Summary>
            <ApiMember(Description:="Cluster code", IsRequired:=true)>
            Public Overridable Property clusterCode As String

            '''<Summary>
            '''Stock Items
            '''</Summary>
            <ApiMember(Description:="Stock Items", IsRequired:=true)>
            Public Overridable Property stockItems As List(Of ClusterStockItem) = New List(Of ClusterStockItem)
        End Class

        Public Partial Class ClusterStockItem
            '''<Summary>
            '''Article Code
            '''</Summary>
            <ApiMember(Description:="Article Code", IsRequired:=true)>
            Public Overridable Property articleCode As String

            '''<Summary>
            '''Asset Quantity
            '''</Summary>
            <ApiMember(Description:="Asset Quantity", IsRequired:=true)>
            Public Overridable Property assetQuantity As Integer

            '''<Summary>
            '''Consignment Quantity
            '''</Summary>
            <ApiMember(Description:="Consignment Quantity", IsRequired:=true)>
            Public Overridable Property consignmentQuantity As Integer
        End Class

        Public Partial Class GetAggregatedStock
            '''<Summary>
            '''Brand
            '''</Summary>
            <ApiMember(Description:="Brand", IsRequired:=true)>
            Public Overridable Property brand As String

            '''<Summary>
            '''Authorized POS Code e.g. ES100:102048
            '''</Summary>
            <ApiMember(Description:="Authorized POS Code e.g. ES100:102048", IsRequired:=true)>
            Public Overridable Property posCode As String

            '''<Summary>
            '''Article Codes
            '''</Summary>
            <ApiMember(Description:="Article Codes")>
            Public Overridable Property articleCodes As List(Of String)

            '''<Summary>
            '''Storage Location Identifier e.g. CPO, NEW, REP
            '''</Summary>
            <ApiMember(Description:="Storage Location Identifier e.g. CPO, NEW, REP")>
            Public Overridable Property storageLocationId As String

            '''<Summary>
            '''Inventory segment e.g. CPO or empty
            '''</Summary>
            <ApiMember(Description:="Inventory segment e.g. CPO or empty")>
            Public Overridable Property inventorySegment As String
        End Class
    End Namespace
End Namespace

VB.NET GetAggregatedStock DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /aggregatedStock/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	clusterCode: String,
	stockItems: 
	[
		{
			articleCode: String,
			assetQuantity: 0,
			consignmentQuantity: 0
		}
	]
}