Richemont.Booster2.PublicApi

GetSaleDetails

The following routes are available for this service:
GET	/warranty	Get a list of Sale Details	Get a list of Sale Details based on the search parameters submitted

**GetSaleDetails** Parameters:
Name	Parameter	Data Type	Required	Description
brand	query	string	Yes	Richemont Brand ID
posCode	query	string	Yes	Richemont POS code
documentNumber	query	string	No	Receipt or Invoice Number
documentDateFrom	query	DateTime?	No	Date of the Sell-out Start
documentDateTo	query	DateTime?	No	Date of the Sell-out End
articleCode	query	string	No	Richemont Reference Code of the item
serialNumber	query	string	No	Serial Number of the item
saleDetailId	query	int?	No	Unique Identifier of the Sell-out created in Booster
saleId	query	int?	No	Unique Identifier of the Sell-out created in Booster
boosterCustomerId	query	int?	No	Booster Customer Id
warrantyExtensionStatusIds	query	List<int>	No	Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)
productCategories	query	List<ProductCategory>	No	Product Categories
page	query	int	Yes	Index of the result set returned
items	query	int	Yes	Size of the result set returned
noCount	query	bool	No	Omit precise record count - save on performance
sortBy	query	string	No	Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.

**ProductCategory** Parameters:
Name	Parameter	Data Type	Required	Description
brandCategoryId	form	string	No	Brand Category ID
grandCategoryId	form	string	Yes	Grand Category ID
masterCategoryId	form	string	No	Master Category ID
categoryId	form	string	No	Category ID
subCategoryId	form	string	No	Sub Category ID

**GetSaleDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
page	form	int	Yes	Index of the result set returnedr
items	form	int	Yes	Size of the result set returned
totalPages	form	int	Yes	Total amount of pages / result sets
totalResults	form	int	Yes	Total amount of results
elements	form	IEnumerable<SaleDetail>	Yes	List of Sale Details

**SaleDetail** Parameters:
Name	Parameter	Data Type	Required	Description
saleId	form	int	Yes	Unique Identifier of the Sell-out created in Booster
saleDetailId	form	int	Yes	Unique Identifier of the Sell-out created in Booster
boosterCustomerId	form	int?	No	Booster Customer Id
posCode	form	string	Yes	Richemont POS code
documentNumber	form	string	No	Receipt or Invoice Number
documentDate	form	string	Yes	Date of the Sell-out
documentLineNumber	form	int?	No	Position Number
articleCode	form	string	Yes	Richemont Reference Code of the item
serialNumber	form	string	No	Serial Number of the item
quantity	form	int?	Yes	Use positive for standard Sell-out and negative quantity for return
retailPrice	form	decimal?	No	Retail Price
unitPrice	form	decimal?	No	Sold Price
currencyCode	form	string	No	Currency of the sold price
ccpStatusCode	form	string	No	CCP Status Code
ccpStatusDescription	form	string	No	CCP Status Description
retriggerEnabled	form	bool	No	CCP Retrigger enable
warrantyExtentionStatusId	form	int?	No	Warranty Extention Status
warrantyExtentionStatusDescription	form	string	No	Warranty Extention Status
saleRepresentativeEmails	form	List<string>	No	Sale Representative Email
promoterTypeId	form	string	No	Promoter Type IDs, possible values are: DAI, FIT, GRT
type	form	string	Yes	Sellout Type, possible values are: 'standard' or 'consigned'
originalSaleDetailId	form	int?	No	Original Sale Detail Id

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.

GET /warranty HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSaleDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetSaleDetailsResponse>