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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ExportSellOut
{
    /**
    * Brand Trigram, e.g. CAR, IWC
    */
    @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
    var brand:String? = null

    /**
    * Pos Legacy IDs / Codes
    */
    @ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)
    var posCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Date To
    */
    @ApiMember(Description="Date To")
    var dateTo:Date? = null

    /**
    * Date From
    */
    @ApiMember(Description="Date From")
    var dateFrom:Date? = null

    /**
    * Item Article Codes, both Global and Local
    */
    @ApiMember(Description="Item Article Codes, both Global and Local")
    var articleCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Product Categories
    */
    @ApiMember(Description="Product Categories")
    var productCategories:ArrayList<ProductCategory> = ArrayList<ProductCategory>()

    /**
    * Sale Representative Email
    */
    @ApiMember(Description="Sale Representative Email")
    var saleRepresentativeEmails:ArrayList<String> = ArrayList<String>()

    /**
    * Sellout Type: 'sellout' for sales, 'return' for returns, null for both
    */
    @ApiMember(Description="Sellout Type: 'sellout' for sales, 'return' for returns, null for both")
    var selloutType:String? = null

    /**
    * Type: 'consigned' or 'standard', null for both
    */
    @ApiMember(Description="Type: 'consigned' or 'standard', null for both")
    @SerializedName("type") var Type:String? = null

    /**
    * Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)
    */
    @ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)")
    var warrantyExtensionStatusIds:ArrayList<Int> = ArrayList<Int>()

    /**
    * Export Request ID of the API Consumers
    */
    @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    var downloadRequestId:String? = null
}

open class ProductCategory
{
    /**
    * Brand Category ID
    */
    @ApiMember(Description="Brand Category ID")
    var brandCategoryId:String? = null

    /**
    * Grand Category ID
    */
    @ApiMember(Description="Grand Category ID", IsRequired=true)
    var grandCategoryId:String? = null

    /**
    * Master Category ID
    */
    @ApiMember(Description="Master Category ID")
    var masterCategoryId:String? = null

    /**
    * Category ID
    */
    @ApiMember(Description="Category ID")
    var categoryId:String? = null

    /**
    * Sub Category ID
    */
    @ApiMember(Description="Sub Category ID")
    var subCategoryId:String? = null
}

open class ExportSellOutResponse
{
    /**
    * Unique Identifier of the Export Request created
    */
    @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    var asyncTaskId:UUID? = null
}

Kotlin 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>