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
CreateSellOut Parameters:
NameParameterData TypeRequiredDescription
brandbodystringNoBrand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
posCodebodystringYesRichemont POS code
documentNumberbodystringNoReceipt or Invoice Number
documentDatebodyDateTimeYesDate of the Sell-out
documentLineNumberbodyint?NoPosition Number
articleCodebodystringYesRichemont Reference Code of the item
serialNumberbodystringNoSerial Number of the item
quantitybodyintYesUse positive for standard Sell-out and negative quantity for return
unitPricebodydecimal?NoSold Price
currencyCodebodystringNoCurrency of the sold price
boosterCustomerIdbodyint?NoBooster Customer Id
saleRepresentativeEmailsbodyList<string>NoSale Representative Email e.g. rauf.aliyev@richemont.com
promoterTypeIdbodystringNoPromoter Type ID, e.g. DAI, FIT, GRT
returnReasonIdbodystringNoReturn Reason ID, e.g ADM, CLR, EXC, DEF, OTH
commentsbodystringNoSale related comments
originalSaleDetailIdbodyint?NoOriginal Sale Detail Id
consSelloutReturnInStockbodybool?NoTo have the piece back in stock as consignment in case of consignment sellout return
CreateSellOutResponse Parameters:
NameParameterData TypeRequiredDescription
saleDetailIdformint?NoUnique Identifier of the Sell-out item created in Booster
saleDetailIdsformList<int>NoUnique Identifiers of the Sell-out items created in Booster if more than one
saleIdformintYesUnique Identifier of the Sell-out header created in Booster

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	brand: String,
	posCode: String,
	documentNumber: String,
	documentDate: 0001-01-01,
	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
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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