Richemont.Booster2.PublicApi

<back to all web services

GetStockPaginated

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/{posCode}Get Paginated Stock
namespace Richemont.Booster2.PublicApi.Stock.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RetailSalesPrice() = 
        ///<summary>
        ///Currency Iso Code
        ///</summary>
        [<ApiMember(Description="Currency Iso Code", IsRequired=true)>]
        member val currencyIsoCode:String = null with get,set

        ///<summary>
        ///Value
        ///</summary>
        [<ApiMember(Description="Value", IsRequired=true)>]
        member val value:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type PaginatedStockElement() = 
        ///<summary>
        ///Pos Code
        ///</summary>
        [<ApiMember(Description="Pos Code", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Pos Code To Be Displayed
        ///</summary>
        [<ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)>]
        member val posCodeToBeDisplayed:String = null with get,set

        ///<summary>
        ///Article Code
        ///</summary>
        [<ApiMember(Description="Article Code", IsRequired=true)>]
        member val articleCode:String = null with get,set

        ///<summary>
        ///Serial Number
        ///</summary>
        [<ApiMember(Description="Serial Number")>]
        member val serialNumber:String = null with get,set

        ///<summary>
        ///Current Stock Quantity
        ///</summary>
        [<ApiMember(Description="Current Stock Quantity", IsRequired=true)>]
        member val quantity:Int32 = new Int32() with get,set

        ///<summary>
        ///Type e.g. consignment or standard
        ///</summary>
        [<ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)>]
        member val type:String = null with get,set

        ///<summary>
        ///Is Consignment Sellable 
        ///</summary>
        [<ApiMember(Description="Is Consignment Sellable ", IsRequired=true)>]
        member val isConsignmentSellable:Boolean = new Boolean() with get,set

        ///<summary>
        ///Retail Sales Price
        ///</summary>
        [<ApiMember(Description="Retail Sales Price", IsRequired=true)>]
        member val retailSalesPrice:RetailSalesPrice = null with get,set

    [<AllowNullLiteral>]
    type GetStockPaginatedResponse() = 
        ///<summary>
        ///Total Pages
        ///</summary>
        [<ApiMember(Description="Total Pages", IsRequired=true)>]
        member val totalPages:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Results
        ///</summary>
        [<ApiMember(Description="Total Results", IsRequired=true)>]
        member val totalResults:Int32 = new Int32() with get,set

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [<ApiMember(Description="Index of the result set returned", IsRequired=true)>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///List of movements
        ///</summary>
        [<ApiMember(Description="List of movements", IsRequired=true)>]
        member val elements:IEnumerable<PaginatedStockElement> = null with get,set

    [<AllowNullLiteral>]
    type GetStockPaginated() = 
        ///<summary>
        ///Brand
        ///</summary>
        [<ApiMember(Description="Brand", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///POS Legacy
        ///</summary>
        [<ApiMember(Description="POS Legacy", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Search Key (Article or SerialNumber)
        ///</summary>
        [<ApiMember(Description="Search Key (Article or SerialNumber)")>]
        member val searchKey:String = null with get,set

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [<ApiMember(Description="Index of the result set returned")>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned")>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [<ApiMember(Description="Omit precise record count - save on performance")>]
        member val noCount:Boolean = new Boolean() with get,set

        ///<summary>
        ///Sorting expression
        ///</summary>
        [<ApiMember(Description="Sorting expression")>]
        member val sortBy:String = null with get,set

        ///<summary>
        ///Parameter - Include Chain POSes Stock 
        ///</summary>
        [<ApiMember(Description="Parameter - Include Chain POSes Stock ")>]
        member val includeChainPosesStock:Boolean = new Boolean() with get,set

        ///<summary>
        ///Include Retail Sales Price in the Output, by default: false
        ///</summary>
        [<ApiMember(Description="Include Retail Sales Price in the Output, by default: false")>]
        member val includeRSP:Boolean = new Boolean() with get,set

F# GetStockPaginated DTOs

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

HTTP + OTHER

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

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

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