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 net.servicestack.client.*;

public class dtos
{

    public static 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")
        public String brand = null;

        /**
        * Richemont POS code
        */
        @ApiMember(Description="Richemont POS code", IsRequired=true)
        public String posCode = null;

        /**
        * Receipt or Invoice Number
        */
        @ApiMember(Description="Receipt or Invoice Number")
        public String documentNumber = null;

        /**
        * Date of the Sell-out
        */
        @ApiMember(Description="Date of the Sell-out", IsRequired=true)
        public Date documentDate = null;

        /**
        * Position Number
        */
        @ApiMember(Description="Position Number")
        public Integer documentLineNumber = null;

        /**
        * Richemont Reference Code of the item
        */
        @ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
        public String articleCode = null;

        /**
        * Serial Number of the item
        */
        @ApiMember(Description="Serial Number of the item")
        public String serialNumber = 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)
        public Integer quantity = null;

        /**
        * Sold Price
        */
        @ApiMember(Description="Sold Price")
        public BigDecimal unitPrice = null;

        /**
        * Currency of the sold price
        */
        @ApiMember(Description="Currency of the sold price")
        public String currencyCode = null;

        /**
        * Booster Customer Id
        */
        @ApiMember(Description="Booster Customer Id")
        public Integer boosterCustomerId = null;

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

        /**
        * Promoter Type ID, e.g. DAI, FIT, GRT
        */
        @ApiMember(Description="Promoter Type ID, e.g. DAI, FIT, GRT")
        public String promoterTypeId = null;

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

        /**
        * Sale related comments
        */
        @ApiMember(Description="Sale related comments")
        public String comments = null;

        /**
        * Original Sale Detail Id
        */
        @ApiMember(Description="Original Sale Detail Id")
        public Integer originalSaleDetailId = 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")
        public Boolean consSelloutReturnInStock = null;
        
        public String getBrand() { return brand; }
        public CreateSellOut setBrand(String value) { this.brand = value; return this; }
        public String getPosCode() { return posCode; }
        public CreateSellOut setPosCode(String value) { this.posCode = value; return this; }
        public String getDocumentNumber() { return documentNumber; }
        public CreateSellOut setDocumentNumber(String value) { this.documentNumber = value; return this; }
        public Date getDocumentDate() { return documentDate; }
        public CreateSellOut setDocumentDate(Date value) { this.documentDate = value; return this; }
        public Integer getDocumentLineNumber() { return documentLineNumber; }
        public CreateSellOut setDocumentLineNumber(Integer value) { this.documentLineNumber = value; return this; }
        public String getArticleCode() { return articleCode; }
        public CreateSellOut setArticleCode(String value) { this.articleCode = value; return this; }
        public String getSerialNumber() { return serialNumber; }
        public CreateSellOut setSerialNumber(String value) { this.serialNumber = value; return this; }
        public Integer getQuantity() { return quantity; }
        public CreateSellOut setQuantity(Integer value) { this.quantity = value; return this; }
        public BigDecimal getUnitPrice() { return unitPrice; }
        public CreateSellOut setUnitPrice(BigDecimal value) { this.unitPrice = value; return this; }
        public String getCurrencyCode() { return currencyCode; }
        public CreateSellOut setCurrencyCode(String value) { this.currencyCode = value; return this; }
        public Integer getBoosterCustomerId() { return boosterCustomerId; }
        public CreateSellOut setBoosterCustomerId(Integer value) { this.boosterCustomerId = value; return this; }
        public ArrayList<String> getSaleRepresentativeEmails() { return saleRepresentativeEmails; }
        public CreateSellOut setSaleRepresentativeEmails(ArrayList<String> value) { this.saleRepresentativeEmails = value; return this; }
        public String getPromoterTypeId() { return promoterTypeId; }
        public CreateSellOut setPromoterTypeId(String value) { this.promoterTypeId = value; return this; }
        public String getReturnReasonId() { return returnReasonId; }
        public CreateSellOut setReturnReasonId(String value) { this.returnReasonId = value; return this; }
        public String getComments() { return comments; }
        public CreateSellOut setComments(String value) { this.comments = value; return this; }
        public Integer getOriginalSaleDetailId() { return originalSaleDetailId; }
        public CreateSellOut setOriginalSaleDetailId(Integer value) { this.originalSaleDetailId = value; return this; }
        public Boolean isConsSelloutReturnInStock() { return consSelloutReturnInStock; }
        public CreateSellOut setConsSelloutReturnInStock(Boolean value) { this.consSelloutReturnInStock = value; return this; }
    }

    public static class CreateSellOutResponse
    {
        /**
        * Unique Identifier of the Sell-out item created in Booster
        */
        @ApiMember(Description="Unique Identifier of the Sell-out item created in Booster")
        public Integer saleDetailId = 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")
        public ArrayList<Integer> saleDetailIds = 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)
        public Integer saleId = null;
        
        public Integer getSaleDetailId() { return saleDetailId; }
        public CreateSellOutResponse setSaleDetailId(Integer value) { this.saleDetailId = value; return this; }
        public ArrayList<Integer> getSaleDetailIds() { return saleDetailIds; }
        public CreateSellOutResponse setSaleDetailIds(ArrayList<Integer> value) { this.saleDetailIds = value; return this; }
        public Integer getSaleId() { return saleId; }
        public CreateSellOutResponse setSaleId(Integer value) { this.saleId = value; return this; }
    }

}

Java CreateSellOut DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateSellOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <articleCode>String</articleCode>
  <boosterCustomerId>0</boosterCustomerId>
  <brand>String</brand>
  <comments>String</comments>
  <consSelloutReturnInStock>false</consSelloutReturnInStock>
  <currencyCode>String</currencyCode>
  <documentDate>0001-01-01T00:00:00</documentDate>
  <documentLineNumber>0</documentLineNumber>
  <documentNumber>String</documentNumber>
  <originalSaleDetailId>0</originalSaleDetailId>
  <posCode>String</posCode>
  <promoterTypeId>String</promoterTypeId>
  <quantity>0</quantity>
  <returnReasonId>String</returnReasonId>
  <saleRepresentativeEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </saleRepresentativeEmails>
  <serialNumber>String</serialNumber>
  <unitPrice>0</unitPrice>
</CreateSellOut>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateSellOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <saleDetailId>0</saleDetailId>
  <saleDetailIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </saleDetailIds>
  <saleId>0</saleId>
</CreateSellOutResponse>