Richemont.Booster2.PublicApi

GetBuyInPaginated

The following routes are available for this service:
GET	/buyin/{brand}	Get list of buyin	Get list of paginated buyin based on the search parameters submitted

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.CPO.ServiceModel;

namespace Richemont.Booster2.PublicApi.CPO.ServiceModel
{
    public partial class BuyIn
    {
        ///<summary>
        ///Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
        ///</summary>
        [ApiMember(Description="Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///Code of BuyIn
        ///</summary>
        [ApiMember(Description="Code of BuyIn", IsRequired=true)]
        public virtual int buyInOrderId { get; set; }

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

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

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

        ///<summary>
        ///Buy-in order status code
        ///</summary>
        [ApiMember(Description="Buy-in order status code")]
        public virtual string buyInStatusId { get; set; }

        ///<summary>
        ///Buy-in creation date
        ///</summary>
        [ApiMember(Description="Buy-in creation date")]
        public virtual DateTime buyInDate { get; set; }

        ///<summary>
        ///Emails of Sale Representatives
        ///</summary>
        [ApiMember(Description="Emails of Sale Representatives")]
        public virtual List<string> saleRepresentativeEmails { get; set; } = [];

        ///<summary>
        ///True is the buy-in’s piece is in stock, False otherwise
        ///</summary>
        [ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")]
        public virtual bool isInStock { get; set; }
    }

    public partial class GetBuyInPaginated
    {
        ///<summary>
        ///Richemont Brand ID
        ///</summary>
        [ApiMember(Description="Richemont Brand ID")]
        public virtual string brand { get; set; }

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

        ///<summary>
        ///Richemont Reference Code of the item
        ///</summary>
        [ApiMember(Description="Richemont Reference Code of the item")]
        public virtual string articleCode { get; set; }

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

        ///<summary>
        ///Buy-in order status code
        ///</summary>
        [ApiMember(Description="Buy-in order status code")]
        public virtual string buyInStatusId { get; set; }

        ///<summary>
        ///True is the buy-in’s piece is in stock, False otherwise
        ///</summary>
        [ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")]
        public virtual bool? isInStock { 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>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }

        ///<summary>
        ///Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
        ///</summary>
        [ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")]
        public virtual string sortBy { get; set; }
    }

    public partial class GetBuyInPaginatedResponse
    {
        ///<summary>
        ///Index of the result set returnedr
        ///</summary>
        [ApiMember(Description="Index of the result set returnedr", 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>
        ///Total amount of pages / result sets
        ///</summary>
        [ApiMember(Description="Total amount of pages / result sets", IsRequired=true)]
        public virtual int totalPages { get; set; }

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

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

}

C# GetBuyInPaginated DTOs

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

HTTP + XML

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

GET /buyin/{brand} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetBuyInPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CPO.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetBuyInPaginatedResponse>