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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Stock.ServiceModel;

namespace Richemont.Booster2.PublicApi.Stock.ServiceModel
{
    public partial class GetWarehouseStock
        : IPagedRequest
    {
        public GetWarehouseStock()
        {
            articleCodes = new List<string>{};
        }

        ///<summary>
        ///Brand
        ///</summary>
        [ApiMember(Description="Brand", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///POS Legacy
        ///</summary>
        [ApiMember(Description="POS Legacy", IsRequired=true)]
        public virtual string posCode { get; set; }

        ///<summary>
        ///List of Article Codes
        ///</summary>
        [ApiMember(Description="List of Article Codes")]
        public virtual List<string> articleCodes { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned")]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned")]
        public virtual int items { get; set; }

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }

        ///<summary>
        ///Sorting expression
        ///</summary>
        [ApiMember(Description="Sorting expression")]
        public virtual string sortBy { get; set; }
    }

    public partial class GetWarehouseStockResponse
    {
        ///<summary>
        ///Total Pages
        ///</summary>
        [ApiMember(Description="Total Pages", IsRequired=true)]
        public virtual int totalPages { get; set; }

        ///<summary>
        ///Total Results
        ///</summary>
        [ApiMember(Description="Total Results", IsRequired=true)]
        public virtual int totalResults { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///List of movements
        ///</summary>
        [ApiMember(Description="List of movements", IsRequired=true)]
        public virtual IEnumerable<WarehouseStockElement> elements { get; set; }
    }

    public partial class WarehouseStockElement
    {
        ///<summary>
        ///Article Code
        ///</summary>
        [ApiMember(Description="Article Code", IsRequired=true)]
        public virtual string articleCode { get; set; }

        ///<summary>
        ///Current Stock Quantity
        ///</summary>
        [ApiMember(Description="Current Stock Quantity", IsRequired=true)]
        public virtual int atpQuantity { get; set; }
    }

}

C# GetWarehouseStock 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 /warehouseItems/{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}