Richemont.Booster2.PublicApi

<back to all web services

GetSaleDetails

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Sellout.ServiceModel;
using Richemont.Booster2.PublicApi.Common.ServiceModel;

namespace Richemont.Booster2.PublicApi.Common.ServiceModel
{
    public partial class ProductCategory
    {
        ///<summary>
        ///Brand Category ID
        ///</summary>
        [ApiMember(Description="Brand Category ID")]
        public virtual string brandCategoryId { get; set; }

        ///<summary>
        ///Grand Category ID
        ///</summary>
        [ApiMember(Description="Grand Category ID", IsRequired=true)]
        public virtual string grandCategoryId { get; set; }

        ///<summary>
        ///Master Category ID
        ///</summary>
        [ApiMember(Description="Master Category ID")]
        public virtual string masterCategoryId { get; set; }

        ///<summary>
        ///Category ID
        ///</summary>
        [ApiMember(Description="Category ID")]
        public virtual string categoryId { get; set; }

        ///<summary>
        ///Sub Category ID
        ///</summary>
        [ApiMember(Description="Sub Category ID")]
        public virtual string subCategoryId { get; set; }
    }

}

namespace Richemont.Booster2.PublicApi.Sellout.ServiceModel
{
    public partial class GetSaleDetails
        : IPagedRequest
    {
        public GetSaleDetails()
        {
            warrantyExtensionStatusIds = new List<int>{};
            productCategories = new List<ProductCategory>{};
        }

        ///<summary>
        ///Richemont Brand ID
        ///</summary>
        [ApiMember(Description="Richemont Brand ID", IsRequired=true)]
        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>
        ///Receipt or Invoice Number
        ///</summary>
        [ApiMember(Description="Receipt or Invoice Number")]
        public virtual string documentNumber { get; set; }

        ///<summary>
        ///Date of the Sell-out Start 
        ///</summary>
        [ApiMember(Description="Date of the Sell-out Start ")]
        public virtual DateTime? documentDateFrom { get; set; }

        ///<summary>
        ///Date of the Sell-out End
        ///</summary>
        [ApiMember(Description="Date of the Sell-out End")]
        public virtual DateTime? documentDateTo { 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>
        ///Unique Identifier of the Sell-out created in Booster
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Sell-out created in Booster")]
        public virtual int? saleDetailId { get; set; }

        ///<summary>
        ///Unique Identifier of the Sell-out created in Booster
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Sell-out created in Booster")]
        public virtual int? saleId { get; set; }

        ///<summary>
        ///Booster Customer Id
        ///</summary>
        [ApiMember(Description="Booster Customer Id")]
        public virtual int? boosterCustomerId { get; set; }

        ///<summary>
        ///Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)
        ///</summary>
        [ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)")]
        public virtual List<int> warrantyExtensionStatusIds { get; set; }

        ///<summary>
        ///Product Categories
        ///</summary>
        [ApiMember(Description="Product Categories")]
        public virtual List<ProductCategory> productCategories { 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 GetSaleDetailsResponse
    {
        ///<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<SaleDetail> elements { get; set; }
    }

    public partial class SaleDetail
    {
        public SaleDetail()
        {
            saleRepresentativeEmails = new List<string>{};
        }

        ///<summary>
        ///Unique Identifier of the Sell-out created in Booster
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)]
        public virtual int saleId { get; set; }

        ///<summary>
        ///Unique Identifier of the Sell-out created in Booster
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)]
        public virtual int saleDetailId { get; set; }

        ///<summary>
        ///Booster Customer Id
        ///</summary>
        [ApiMember(Description="Booster Customer Id")]
        public virtual int? boosterCustomerId { get; set; }

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

        ///<summary>
        ///Receipt or Invoice Number
        ///</summary>
        [ApiMember(Description="Receipt or Invoice Number")]
        public virtual string documentNumber { get; set; }

        ///<summary>
        ///Date of the Sell-out
        ///</summary>
        [ApiMember(Description="Date of the Sell-out", IsRequired=true)]
        public virtual string documentDate { get; set; }

        ///<summary>
        ///Position Number
        ///</summary>
        [ApiMember(Description="Position Number")]
        public virtual int? documentLineNumber { 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>
        ///Use positive for standard Sell-out and negative quantity for return
        ///</summary>
        [ApiMember(Description="Use positive for standard Sell-out and negative quantity for return", IsRequired=true)]
        public virtual int? quantity { get; set; }

        ///<summary>
        ///Retail Price
        ///</summary>
        [ApiMember(Description="Retail Price")]
        public virtual decimal? retailPrice { get; set; }

        ///<summary>
        ///Sold Price
        ///</summary>
        [ApiMember(Description="Sold Price")]
        public virtual decimal? unitPrice { get; set; }

        ///<summary>
        ///Currency of the sold price
        ///</summary>
        [ApiMember(Description="Currency of the sold price")]
        public virtual string currencyCode { get; set; }

        ///<summary>
        ///CCP Status Code
        ///</summary>
        [ApiMember(Description="CCP Status Code")]
        public virtual string ccpStatusCode { get; set; }

        ///<summary>
        ///CCP Status Description
        ///</summary>
        [ApiMember(Description="CCP Status Description")]
        public virtual string ccpStatusDescription { get; set; }

        ///<summary>
        ///CCP Retrigger enable
        ///</summary>
        [ApiMember(Description="CCP Retrigger enable")]
        public virtual bool retriggerEnabled { get; set; }

        ///<summary>
        ///Warranty Extention Status
        ///</summary>
        [ApiMember(Description="Warranty Extention Status")]
        public virtual int? warrantyExtentionStatusId { get; set; }

        ///<summary>
        ///Warranty Extention Status
        ///</summary>
        [ApiMember(Description="Warranty Extention Status")]
        public virtual string warrantyExtentionStatusDescription { get; set; }

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

        ///<summary>
        ///Promoter Type IDs, possible values are: DAI, FIT, GRT
        ///</summary>
        [ApiMember(Description="Promoter Type IDs, possible values are: DAI, FIT, GRT")]
        public virtual string promoterTypeId { get; set; }

        ///<summary>
        ///Sellout Type, possible values are: 'standard' or 'consigned'
        ///</summary>
        [ApiMember(Description="Sellout Type, possible values are: 'standard' or 'consigned'", IsRequired=true)]
        public virtual string type { get; set; }

        ///<summary>
        ///Original Sale Detail Id
        ///</summary>
        [ApiMember(Description="Original Sale Detail Id")]
        public virtual int? originalSaleDetailId { get; set; }
    }

}

C# GetSaleDetails DTOs

GET /warranty HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json

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

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