Richemont.Booster2.PublicApi

<back to all web services

GetWarehouseStock

Requires Authentication
The following routes are available for this service:
GET/warehouseItems/{brand}/{posCode}Get a list Paginated Warehouse Stock
Imports System
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 GetWarehouseStock
            Implements IPagedRequest
            Public Sub New()
                articleCodes = New List(Of String)
            End Sub

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

            '''<Summary>
            '''POS Legacy
            '''</Summary>
            <ApiMember(Description:="POS Legacy", IsRequired:=true)>
            Public Overridable Property posCode As String

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

            '''<Summary>
            '''Index of the result set returned
            '''</Summary>
            <ApiMember(Description:="Index of the result set returned")>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned")>
            Public Overridable Property items As Integer

            '''<Summary>
            '''Omit precise record count - save on performance
            '''</Summary>
            <ApiMember(Description:="Omit precise record count - save on performance")>
            Public Overridable Property noCount As Boolean

            '''<Summary>
            '''Sorting expression
            '''</Summary>
            <ApiMember(Description:="Sorting expression")>
            Public Overridable Property sortBy As String
        End Class

        Public Partial Class GetWarehouseStockResponse
            '''<Summary>
            '''Total Pages
            '''</Summary>
            <ApiMember(Description:="Total Pages", IsRequired:=true)>
            Public Overridable Property totalPages As Integer

            '''<Summary>
            '''Total Results
            '''</Summary>
            <ApiMember(Description:="Total Results", IsRequired:=true)>
            Public Overridable Property totalResults As Integer

            '''<Summary>
            '''Index of the result set returned
            '''</Summary>
            <ApiMember(Description:="Index of the result set returned", IsRequired:=true)>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
            Public Overridable Property items As Integer

            '''<Summary>
            '''List of movements
            '''</Summary>
            <ApiMember(Description:="List of movements", IsRequired:=true)>
            Public Overridable Property elements As IEnumerable(Of WarehouseStockElement)
        End Class

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

            '''<Summary>
            '''Current Stock Quantity
            '''</Summary>
            <ApiMember(Description:="Current Stock Quantity", IsRequired:=true)>
            Public Overridable Property atpQuantity As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetWarehouseStock 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 /warehouseItems/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"totalPages":0,"totalResults":0,"page":0,"items":0}