Richemont.Booster2.PublicApi

<back to all web services

CreateSellOut

Requires Authentication
The following routes are available for this service:
POST/warrantyCreate a Sell-OutCreate a sell-out in a POS you are authorised for
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CreateSellOut
{
    /**
    * Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
    */
    @ApiMember(Description="Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided")
    open var brand:String? = null

    /**
    * Richemont POS code
    */
    @ApiMember(Description="Richemont POS code", IsRequired=true)
    open var posCode:String? = null

    /**
    * Receipt or Invoice Number
    */
    @ApiMember(Description="Receipt or Invoice Number")
    open var documentNumber:String? = null

    /**
    * Date of the Sell-out
    */
    @ApiMember(Description="Date of the Sell-out", IsRequired=true)
    open var documentDate:Date? = null

    /**
    * Position Number
    */
    @ApiMember(Description="Position Number")
    open var documentLineNumber:Int? = null

    /**
    * Richemont Reference Code of the item
    */
    @ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
    open var articleCode:String? = null

    /**
    * Serial Number of the item
    */
    @ApiMember(Description="Serial Number of the item")
    open var serialNumber:String? = null

    /**
    * Use positive for standard Sell-out and negative quantity for return
    */
    @ApiMember(Description="Use positive for standard Sell-out and negative quantity for return", IsRequired=true)
    open var quantity:Int? = null

    /**
    * Sold Price
    */
    @ApiMember(Description="Sold Price")
    open var unitPrice:BigDecimal? = null

    /**
    * Currency of the sold price
    */
    @ApiMember(Description="Currency of the sold price")
    open var currencyCode:String? = null

    /**
    * Booster Customer Id
    */
    @ApiMember(Description="Booster Customer Id")
    open var boosterCustomerId:Int? = null

    /**
    * Sale Representative Email e.g. rauf.aliyev@richemont.com
    */
    @ApiMember(Description="Sale Representative Email e.g. rauf.aliyev@richemont.com")
    open var saleRepresentativeEmails:ArrayList<String>? = null

    /**
    * Promoter Type ID, e.g. DAI, FIT, GRT
    */
    @ApiMember(Description="Promoter Type ID, e.g. DAI, FIT, GRT")
    open var promoterTypeId:String? = null

    /**
    * Return Reason ID, e.g ADM, CLR, EXC, DEF, OTH
    */
    @ApiMember(Description="Return Reason ID, e.g ADM, CLR, EXC, DEF, OTH")
    open var returnReasonId:String? = null

    /**
    * Sale related comments
    */
    @ApiMember(Description="Sale related comments")
    open var comments:String? = null

    /**
    * Original Sale Detail Id
    */
    @ApiMember(Description="Original Sale Detail Id")
    open var originalSaleDetailId:Int? = null

    /**
    * To have the piece back in stock as consignment in case of consignment sellout return
    */
    @ApiMember(Description="To have the piece back in stock as consignment in case of consignment sellout return")
    open var consSelloutReturnInStock:Boolean? = null

    /**
    * Reason for the sell-out, e.g., 'CPO' (Certified Pre-Owned)
    */
    @ApiMember(Description="Reason for the sell-out, e.g., 'CPO' (Certified Pre-Owned)")
    open var saleReasonId:String? = null
}

open class CreateSellOutResponse
{
    /**
    * Unique Identifier of the Sell-out item created in Booster
    */
    @ApiMember(Description="Unique Identifier of the Sell-out item created in Booster")
    open var saleDetailId:Int? = null

    /**
    * Unique Identifiers of the Sell-out items created in Booster if more than one
    */
    @ApiMember(Description="Unique Identifiers of the Sell-out items created in Booster if more than one")
    open var saleDetailIds:ArrayList<Int>? = null

    /**
    * Unique Identifier of the Sell-out header created in Booster
    */
    @ApiMember(Description="Unique Identifier of the Sell-out header created in Booster", IsRequired=true)
    open var saleId:Int? = null
}

Kotlin CreateSellOut DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /warranty HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"brand":"String","posCode":"String","documentNumber":"String","documentDate":"\/Date(-62135596800000-0000)\/","documentLineNumber":0,"articleCode":"String","serialNumber":"String","quantity":0,"unitPrice":0,"currencyCode":"String","boosterCustomerId":0,"saleRepresentativeEmails":["String"],"promoterTypeId":"String","returnReasonId":"String","comments":"String","originalSaleDetailId":0,"consSelloutReturnInStock":false,"saleReasonId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"saleDetailId":0,"saleDetailIds":[0],"saleId":0}