Richemont.Booster2.PublicApi

<back to all web services

ExportStock

Requires Authentication
The following routes are available for this service:
POST/stock/{brand}/exportExport Stock Data
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ExportStock : StockRequest()
{
    /**
    * Product Categories
    */
    @ApiMember(Description="Product Categories")
    var productCategories:ArrayList<ProductCategory> = ArrayList<ProductCategory>()

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

open class StockRequest
{
    /**
    * Brand
    */
    @ApiMember(Description="Brand", IsRequired=true)
    var brand:String? = null

    /**
    * POS Legacy
    */
    @ApiMember(Description="POS Legacy")
    var posCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Article Codes
    */
    @ApiMember(Description="Article Codes")
    var articleCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Include Extra Info
    */
    @ApiMember(Description="Include Extra Info")
    var includeExtraInfo:Boolean? = null

    /**
    * Cluster Id
    */
    @ApiMember(Description="Cluster Id")
    var clusterIds:ArrayList<String> = ArrayList<String>()

    /**
    * Include Consignment NotAuthorized POS
    */
    @ApiMember(Description="Include Consignment NotAuthorized POS")
    var includeConsignmentNotAuthorizedPOS:Boolean? = null

    /**
    * Include Retail Sales Price in the Output, by default: false
    */
    @ApiMember(Description="Include Retail Sales Price in the Output, by default: false")
    var includeRSP:Boolean? = null

    /**
    * In Stock Since date from 
    */
    @ApiMember(Description="In Stock Since date from ")
    var dateFrom:Date? = null

    /**
    * In Stock Since date to
    */
    @ApiMember(Description="In Stock Since date to")
    var dateTo:Date? = null

    /**
    * Item type, 'standard' OR 'consigned'. By default, all are coming
    */
    @ApiMember(Description="Item type, 'standard' OR 'consigned'. By default, all are coming")
    @SerializedName("type") var Type: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 ExportStockResponse
{
    /**
    * Unique Identifier of the Export Request created
    */
    @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    var asyncTaskId:UUID? = null
}

Kotlin ExportStock DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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":"\/Date(-62135596800000-0000)\/","dateTo":"\/Date(-62135596800000-0000)\/","type":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}