Richemont.Booster2.PublicApi

CreateSellOut

The following routes are available for this service:
POST	/warranty	Create a Sell-Out	Create a sell-out in a POS you are authorised for


export class CreateSellOutResponse
{
    /** @description Unique Identifier of the Sell-out item created in Booster */
    // @ApiMember(Description="Unique Identifier of the Sell-out item created in Booster")
    public saleDetailId?: number;

    /** @description 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 saleDetailIds: number[];

    /** @description 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 saleId: number;

    public constructor(init?: Partial<CreateSellOutResponse>) { (Object as any).assign(this, init); }
}

export class CreateSellOut
{
    /** @description 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 brand: string;

    /** @description Richemont POS code */
    // @ApiMember(Description="Richemont POS code", IsRequired=true)
    public posCode: string;

    /** @description Receipt or Invoice Number */
    // @ApiMember(Description="Receipt or Invoice Number")
    public documentNumber: string;

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

    /** @description Position Number */
    // @ApiMember(Description="Position Number")
    public documentLineNumber?: number;

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

    /** @description Serial Number of the item */
    // @ApiMember(Description="Serial Number of the item")
    public serialNumber: string;

    /** @description 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 quantity: number;

    /** @description Sold Price */
    // @ApiMember(Description="Sold Price")
    public unitPrice?: number;

    /** @description Currency of the sold price */
    // @ApiMember(Description="Currency of the sold price")
    public currencyCode: string;

    /** @description Booster Customer Id */
    // @ApiMember(Description="Booster Customer Id")
    public boosterCustomerId?: number;

    /** @description Sale Representative Email e.g. rauf.aliyev@richemont.com */
    // @ApiMember(Description="Sale Representative Email e.g. rauf.aliyev@richemont.com")
    public saleRepresentativeEmails: string[];

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

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

    /** @description Sale related comments */
    // @ApiMember(Description="Sale related comments")
    public comments: string;

    /** @description Original Sale Detail Id */
    // @ApiMember(Description="Original Sale Detail Id")
    public originalSaleDetailId?: number;

    /** @description 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 consSelloutReturnInStock?: boolean;

    public constructor(init?: Partial<CreateSellOut>) { (Object as any).assign(this, init); }
}

TypeScript 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>