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

namespace Richemont.Booster2.PublicApi.Common.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ExportSellOutResponse() = 
        ///<summary>
        ///Unique Identifier of the Export Request created
        ///</summary>
        [<ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)>]
        member val asyncTaskId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type ProductCategory() = 
        ///<summary>
        ///Brand Category ID
        ///</summary>
        [<ApiMember(Description="Brand Category ID")>]
        member val brandCategoryId:String = null with get,set

        ///<summary>
        ///Grand Category ID
        ///</summary>
        [<ApiMember(Description="Grand Category ID", IsRequired=true)>]
        member val grandCategoryId:String = null with get,set

        ///<summary>
        ///Master Category ID
        ///</summary>
        [<ApiMember(Description="Master Category ID")>]
        member val masterCategoryId:String = null with get,set

        ///<summary>
        ///Category ID
        ///</summary>
        [<ApiMember(Description="Category ID")>]
        member val categoryId:String = null with get,set

        ///<summary>
        ///Sub Category ID
        ///</summary>
        [<ApiMember(Description="Sub Category ID")>]
        member val subCategoryId:String = null with get,set

    [<AllowNullLiteral>]
    type ExportSellOut() = 
        ///<summary>
        ///Brand Trigram, e.g. CAR, IWC
        ///</summary>
        [<ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///Pos Legacy IDs / Codes
        ///</summary>
        [<ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)>]
        member val posCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Date To
        ///</summary>
        [<ApiMember(Description="Date To")>]
        member val dateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Date From
        ///</summary>
        [<ApiMember(Description="Date From")>]
        member val dateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Item Article Codes, both Global and Local
        ///</summary>
        [<ApiMember(Description="Item Article Codes, both Global and Local")>]
        member val articleCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Product Categories
        ///</summary>
        [<ApiMember(Description="Product Categories")>]
        member val productCategories:ResizeArray<ProductCategory> = new ResizeArray<ProductCategory>() with get,set

        ///<summary>
        ///Sale Representative Email
        ///</summary>
        [<ApiMember(Description="Sale Representative Email")>]
        member val saleRepresentativeEmails:ResizeArray<String> = new ResizeArray<String>() with 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")>]
        member val selloutType:String = null with get,set

        ///<summary>
        ///Type: 'consigned' or 'standard', null for both
        ///</summary>
        [<ApiMember(Description="Type: 'consigned' or 'standard', null for both")>]
        member val type:String = null with 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)")>]
        member val warrantyExtensionStatusIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        ///<summary>
        ///Export Request ID of the API Consumers
        ///</summary>
        [<ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)>]
        member val downloadRequestId:String = null with get,set

F# ExportSellOut DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	brand: String,
	posCodes: 
	[
		String
	],
	dateTo: 0001-01-01,
	dateFrom: 0001-01-01,
	articleCodes: 
	[
		String
	],
	productCategories: 
	[
		{
			brandCategoryId: String,
			grandCategoryId: String,
			masterCategoryId: String,
			categoryId: String,
			subCategoryId: String
		}
	],
	saleRepresentativeEmails: 
	[
		String
	],
	selloutType: String,
	type: String,
	warrantyExtensionStatusIds: 
	[
		0
	],
	downloadRequestId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	asyncTaskId: 00000000000000000000000000000000
}