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
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 ClusterStockItem() = 
        ///<summary>
        ///Article Code
        ///</summary>
        [<ApiMember(Description="Article Code", IsRequired=true)>]
        member val articleCode:String = null with get,set

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

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

    [<AllowNullLiteral>]
    type ClusterStock() = 
        ///<summary>
        ///Cluster code
        ///</summary>
        [<ApiMember(Description="Cluster code", IsRequired=true)>]
        member val clusterCode:String = null with get,set

        ///<summary>
        ///Stock Items
        ///</summary>
        [<ApiMember(Description="Stock Items", IsRequired=true)>]
        member val stockItems:ResizeArray<ClusterStockItem> = new ResizeArray<ClusterStockItem>() with get,set

    [<AllowNullLiteral>]
    type AggregatedStockResponse() = 
        inherit ClusterStock()

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

        ///<summary>
        ///Authorized POS Code e.g. ES100:102048
        ///</summary>
        [<ApiMember(Description="Authorized POS Code e.g. ES100:102048", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Article Codes
        ///</summary>
        [<ApiMember(Description="Article Codes")>]
        member val articleCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

F# GetAggregatedStock DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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