| POST | /warranty | Create a Sell-Out | Create a sell-out in a POS you are authorised for |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | body | string | No | Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided |
| posCode | body | string | Yes | Richemont POS code |
| documentNumber | body | string | No | Receipt or Invoice Number |
| documentDate | body | DateTime | Yes | Date of the Sell-out |
| documentLineNumber | body | int? | No | Position Number |
| articleCode | body | string | Yes | Richemont Reference Code of the item |
| serialNumber | body | string | No | Serial Number of the item |
| quantity | body | int | Yes | Use positive for standard Sell-out and negative quantity for return |
| unitPrice | body | decimal? | No | Sold Price |
| currencyCode | body | string | No | Currency of the sold price |
| boosterCustomerId | body | int? | No | Booster Customer Id |
| saleRepresentativeEmails | body | List<string> | No | Sale Representative Email e.g. rauf.aliyev@richemont.com |
| promoterTypeId | body | string | No | Promoter Type ID, e.g. DAI, FIT, GRT |
| returnReasonId | body | string | No | Return Reason ID, e.g ADM, CLR, EXC, DEF, OTH |
| comments | body | string | No | Sale related comments |
| originalSaleDetailId | body | int? | No | Original Sale Detail Id |
| consSelloutReturnInStock | body | bool? | No | To have the piece back in stock as consignment in case of consignment sellout return |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| saleDetailId | form | int? | No | Unique Identifier of the Sell-out item created in Booster |
| saleDetailIds | form | List<int> | No | Unique Identifiers of the Sell-out items created in Booster if more than one |
| saleId | form | int | Yes | Unique Identifier of the Sell-out header created in Booster |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>