Richemont.Booster2.PublicApi

ExportStock

The following routes are available for this service:
POST	/stock/{brand}/export	Export Stock Data

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 ExportStockResponse() = 
        ///<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 StockRequest() = 
        ///<summary>
        ///Brand
        ///</summary>
        [<ApiMember(Description="Brand", IsRequired=true)>]
        member val brand:String = null with get,set

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

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

        ///<summary>
        ///Include Extra Info
        ///</summary>
        [<ApiMember(Description="Include Extra Info")>]
        member val includeExtraInfo:Boolean = new Boolean() with get,set

        ///<summary>
        ///Cluster Id
        ///</summary>
        [<ApiMember(Description="Cluster Id")>]
        member val clusterIds:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Include Consignment NotAuthorized POS
        ///</summary>
        [<ApiMember(Description="Include Consignment NotAuthorized POS")>]
        member val includeConsignmentNotAuthorizedPOS:Boolean = new Boolean() with get,set

        ///<summary>
        ///Include Retail Sales Price in the Output, by default: false
        ///</summary>
        [<ApiMember(Description="Include Retail Sales Price in the Output, by default: false")>]
        member val includeRSP:Boolean = new Boolean() with get,set

        ///<summary>
        ///In Stock Since date from 
        ///</summary>
        [<ApiMember(Description="In Stock Since date from ")>]
        member val dateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///In Stock Since date to
        ///</summary>
        [<ApiMember(Description="In Stock Since date to")>]
        member val dateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Item type, 'standard' OR 'consigned'. By default, all are coming
        ///</summary>
        [<ApiMember(Description="Item type, 'standard' OR 'consigned'. By default, all are coming")>]
        member val type:String = null 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 ExportStock() = 
        inherit StockRequest()
        ///<summary>
        ///Product Categories
        ///</summary>
        [<ApiMember(Description="Product Categories")>]
        member val productCategories:ResizeArray<ProductCategory> = new ResizeArray<ProductCategory>() 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# ExportStock 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 /stock/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	productCategories: 
	[
		{
			brandCategoryId: String,
			grandCategoryId: String,
			masterCategoryId: String,
			categoryId: String,
			subCategoryId: String
		}
	],
	downloadRequestId: String,
	brand: String,
	posCodes: 
	[
		String
	],
	articleCodes: 
	[
		String
	],
	includeExtraInfo: False,
	clusterIds: 
	[
		String
	],
	includeConsignmentNotAuthorizedPOS: False,
	includeRSP: False,
	dateFrom: 0001-01-01,
	dateTo: 0001-01-01,
	type: String
}

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

{
	asyncTaskId: 00000000000000000000000000000000
}