Richemont.Booster2.PublicApi

<back to all web services

GetStockPaginated

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 GetStockPaginated
        : IPagedRequest
    {
        ///<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>
        ///Search Key (Article or SerialNumber)
        ///</summary>
        [ApiMember(Description="Search Key (Article or SerialNumber)")]
        public virtual string searchKey { 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; }

        ///<summary>
        ///Parameter - Include Chain POSes Stock 
        ///</summary>
        [ApiMember(Description="Parameter - Include Chain POSes Stock ")]
        public virtual bool includeChainPosesStock { 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")]
        public virtual bool includeRSP { get; set; }
    }

    public partial class GetStockPaginatedResponse
    {
        ///<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<PaginatedStockElement> elements { get; set; }
    }

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

        ///<summary>
        ///Pos Code To Be Displayed
        ///</summary>
        [ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)]
        public virtual string posCodeToBeDisplayed { get; set; }

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

        ///<summary>
        ///Serial Number
        ///</summary>
        [ApiMember(Description="Serial Number")]
        public virtual string serialNumber { get; set; }

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

        ///<summary>
        ///Type e.g. consignment or standard
        ///</summary>
        [ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)]
        public virtual string type { get; set; }

        ///<summary>
        ///Is Consignment Sellable 
        ///</summary>
        [ApiMember(Description="Is Consignment Sellable ", IsRequired=true)]
        public virtual bool isConsignmentSellable { get; set; }

        ///<summary>
        ///Retail Sales Price
        ///</summary>
        [ApiMember(Description="Retail Sales Price", IsRequired=true)]
        public virtual RetailSalesPrice retailSalesPrice { get; set; }
    }

    public partial class RetailSalesPrice
    {
        ///<summary>
        ///Currency Iso Code
        ///</summary>
        [ApiMember(Description="Currency Iso Code", IsRequired=true)]
        public virtual string currencyIsoCode { get; set; }

        ///<summary>
        ///Value
        ///</summary>
        [ApiMember(Description="Value", IsRequired=true)]
        public virtual decimal? value { get; set; }
    }

}

C# GetStockPaginated DTOs

GET /stock/{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

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