| GET | /warranty | Get a list of Sale Details | Get a list of Sale Details based on the search parameters submitted |
|---|
"use strict";
export class SaleDetail {
/** @param {{saleId?:number,saleDetailId?:number,boosterCustomerId?:number,posCode?:string,documentNumber?:string,documentDate?:string,documentLineNumber?:number,articleCode?:string,serialNumber?:string,quantity?:number,retailPrice?:number,unitPrice?:number,currencyCode?:string,ccpStatusCode?:string,ccpStatusDescription?:string,retriggerEnabled?:boolean,warrantyExtentionStatusId?:number,warrantyExtentionStatusDescription?:string,saleRepresentativeEmails?:string[],promoterTypeId?:string,type?:string,originalSaleDetailId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Unique Identifier of the Sell-out created in Booster */
saleId;
/**
* @type {number}
* @description Unique Identifier of the Sell-out created in Booster */
saleDetailId;
/**
* @type {?number}
* @description Booster Customer Id */
boosterCustomerId;
/**
* @type {string}
* @description Richemont POS code */
posCode;
/**
* @type {string}
* @description Receipt or Invoice Number */
documentNumber;
/**
* @type {string}
* @description Date of the Sell-out */
documentDate;
/**
* @type {?number}
* @description Position Number */
documentLineNumber;
/**
* @type {string}
* @description Richemont Reference Code of the item */
articleCode;
/**
* @type {string}
* @description Serial Number of the item */
serialNumber;
/**
* @type {number}
* @description Use positive for standard Sell-out and negative quantity for return */
quantity;
/**
* @type {?number}
* @description Retail Price */
retailPrice;
/**
* @type {?number}
* @description Sold Price */
unitPrice;
/**
* @type {string}
* @description Currency of the sold price */
currencyCode;
/**
* @type {string}
* @description CCP Status Code */
ccpStatusCode;
/**
* @type {string}
* @description CCP Status Description */
ccpStatusDescription;
/**
* @type {boolean}
* @description CCP Retrigger enable */
retriggerEnabled;
/**
* @type {?number}
* @description Warranty Extention Status */
warrantyExtentionStatusId;
/**
* @type {string}
* @description Warranty Extention Status */
warrantyExtentionStatusDescription;
/**
* @type {string[]}
* @description Sale Representative Email */
saleRepresentativeEmails;
/**
* @type {string}
* @description Promoter Type IDs, possible values are: DAI, FIT, GRT */
promoterTypeId;
/**
* @type {string}
* @description Sellout Type, possible values are: 'standard' or 'consigned' */
type;
/**
* @type {?number}
* @description Original Sale Detail Id */
originalSaleDetailId;
}
export class GetSaleDetailsResponse {
/** @param {{page?:number,items?:number,totalPages?:number,totalResults?:number,elements?:SaleDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Index of the result set returnedr */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {number}
* @description Total amount of pages / result sets */
totalPages;
/**
* @type {number}
* @description Total amount of results */
totalResults;
/**
* @type {SaleDetail[]}
* @description List of Sale Details */
elements;
}
export class ProductCategory {
/** @param {{brandCategoryId?:string,grandCategoryId?:string,masterCategoryId?:string,categoryId?:string,subCategoryId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand Category ID */
brandCategoryId;
/**
* @type {string}
* @description Grand Category ID */
grandCategoryId;
/**
* @type {string}
* @description Master Category ID */
masterCategoryId;
/**
* @type {string}
* @description Category ID */
categoryId;
/**
* @type {string}
* @description Sub Category ID */
subCategoryId;
}
export class GetSaleDetails {
/** @param {{brand?:string,posCode?:string,documentNumber?:string,documentDateFrom?:string,documentDateTo?:string,articleCode?:string,serialNumber?:string,saleDetailId?:number,saleId?:number,boosterCustomerId?:number,warrantyExtensionStatusIds?:number[],productCategories?:ProductCategory[],page?:number,items?:number,noCount?:boolean,sortBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Richemont Brand ID */
brand;
/**
* @type {string}
* @description Richemont POS code */
posCode;
/**
* @type {string}
* @description Receipt or Invoice Number */
documentNumber;
/**
* @type {?string}
* @description Date of the Sell-out Start */
documentDateFrom;
/**
* @type {?string}
* @description Date of the Sell-out End */
documentDateTo;
/**
* @type {string}
* @description Richemont Reference Code of the item */
articleCode;
/**
* @type {string}
* @description Serial Number of the item */
serialNumber;
/**
* @type {?number}
* @description Unique Identifier of the Sell-out created in Booster */
saleDetailId;
/**
* @type {?number}
* @description Unique Identifier of the Sell-out created in Booster */
saleId;
/**
* @type {?number}
* @description Booster Customer Id */
boosterCustomerId;
/**
* @type {number[]}
* @description Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending) */
warrantyExtensionStatusIds;
/**
* @type {ProductCategory[]}
* @description Product Categories */
productCategories;
/**
* @type {number}
* @description Index of the result set returned */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {boolean}
* @description Omit precise record count - save on performance */
noCount;
/**
* @type {string}
* @description Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'. */
sortBy;
}
JavaScript GetSaleDetails DTOs
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.
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>