Richemont.Booster2.PublicApi

ExportSellOut

The following routes are available for this service:
POST	/warranty/{brand}/export	Export Sell-Out Data	Create a sell-out in a POS you are authorised for

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 ExportSellOut
    {
        public ExportSellOut()
        {
            posCodes = new List<string>{};
            articleCodes = new List<string>{};
            productCategories = new List<ProductCategory>{};
            saleRepresentativeEmails = new List<string>{};
            warrantyExtensionStatusIds = new List<int>{};
        }

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

        ///<summary>
        ///Pos Legacy IDs / Codes
        ///</summary>
        [ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)]
        public virtual List<string> posCodes { get; set; }

        ///<summary>
        ///Date To
        ///</summary>
        [ApiMember(Description="Date To")]
        public virtual DateTime? dateTo { get; set; }

        ///<summary>
        ///Date From
        ///</summary>
        [ApiMember(Description="Date From")]
        public virtual DateTime? dateFrom { get; set; }

        ///<summary>
        ///Item Article Codes, both Global and Local
        ///</summary>
        [ApiMember(Description="Item Article Codes, both Global and Local")]
        public virtual List<string> articleCodes { get; set; }

        ///<summary>
        ///Product Categories
        ///</summary>
        [ApiMember(Description="Product Categories")]
        public virtual List<ProductCategory> productCategories { get; set; }

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

        ///<summary>
        ///Sellout Type: 'sellout' for sales, 'return' for returns, null for both
        ///</summary>
        [ApiMember(Description="Sellout Type: 'sellout' for sales, 'return' for returns, null for both")]
        public virtual string selloutType { get; set; }

        ///<summary>
        ///Type: 'consigned' or 'standard', null for both
        ///</summary>
        [ApiMember(Description="Type: 'consigned' or 'standard', null for both")]
        public virtual string type { get; set; }

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

        ///<summary>
        ///Export Request ID of the API Consumers
        ///</summary>
        [ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)]
        public virtual string downloadRequestId { get; set; }
    }

    public partial class ExportSellOutResponse
    {
        ///<summary>
        ///Unique Identifier of the Export Request created
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)]
        public virtual Guid asyncTaskId { get; set; }
    }

}

C# ExportSellOut 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.

POST /warranty/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExportSellOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <articleCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </articleCodes>
  <brand>String</brand>
  <dateFrom>0001-01-01T00:00:00</dateFrom>
  <dateTo>0001-01-01T00:00:00</dateTo>
  <downloadRequestId>String</downloadRequestId>
  <posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </posCodes>
  <productCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Common.ServiceModel">
    <d2p1:ProductCategory>
      <d2p1:brandCategoryId>String</d2p1:brandCategoryId>
      <d2p1:categoryId>String</d2p1:categoryId>
      <d2p1:grandCategoryId>String</d2p1:grandCategoryId>
      <d2p1:masterCategoryId>String</d2p1:masterCategoryId>
      <d2p1:subCategoryId>String</d2p1:subCategoryId>
    </d2p1:ProductCategory>
  </productCategories>
  <saleRepresentativeEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </saleRepresentativeEmails>
  <selloutType>String</selloutType>
  <type>String</type>
  <warrantyExtensionStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </warrantyExtensionStatusIds>
</ExportSellOut>

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

<ExportSellOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId>
</ExportSellOutResponse>