Richemont.Booster2.PublicApi

<back to all web services

ExportOrder

Requires Authentication
The following routes are available for this service:
POST/purchase/{brand}/exportExport Order Data
import java.math.*
import java.util.*
import net.servicestack.client.*


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

    /**
    * POS Legacy
    */
    @ApiMember(Description="POS Legacy", 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

    /**
    * Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)
    */
    @ApiMember(Description="Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)")
    var status:ArrayList<String> = ArrayList<String>()

    /**
    * Reason Code e.g. Y00, Y06
    */
    @ApiMember(Description="Reason Code e.g. Y00, Y06")
    var reasonCode:ArrayList<String> = ArrayList<String>()

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

    /**
    * Final Ship To Pos Codes
    */
    @ApiMember(Description="Final Ship To Pos Codes")
    var finalShipTo:ArrayList<String> = ArrayList<String>()

    /**
    * 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 ExportOrderResponse
{
    /**
    * Unique Identifier of the Export Request created
    */
    @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    var asyncTaskId:UUID? = null
}

Kotlin ExportOrder 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 /purchase/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"brand":"String","posCodes":["String"],"dateTo":"\/Date(-62135596800000-0000)\/","dateFrom":"\/Date(-62135596800000-0000)\/","status":["String"],"reasonCode":["String"],"productCategories":[{"brandCategoryId":"String","grandCategoryId":"String","masterCategoryId":"String","categoryId":"String","subCategoryId":"String"}],"finalShipTo":["String"],"downloadRequestId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}