| GET | /warranty | Get a list of Sale Details | Get a list of Sale Details based on the search parameters submitted |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GetSaleDetails implements IPagedRequest
{
/**
* Richemont Brand ID
*/
@ApiMember(Description="Richemont Brand ID", IsRequired=true)
public String brand = null;
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
public String posCode = null;
/**
* Receipt or Invoice Number
*/
@ApiMember(Description="Receipt or Invoice Number")
public String documentNumber = null;
/**
* Date of the Sell-out Start
*/
@ApiMember(Description="Date of the Sell-out Start ")
public Date documentDateFrom = null;
/**
* Date of the Sell-out End
*/
@ApiMember(Description="Date of the Sell-out End")
public Date documentDateTo = null;
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item")
public String articleCode = null;
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
public String serialNumber = null;
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster")
public Integer saleDetailId = null;
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster")
public Integer saleId = null;
/**
* Booster Customer Id
*/
@ApiMember(Description="Booster Customer Id")
public Integer boosterCustomerId = null;
/**
* Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)
*/
@ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)")
public ArrayList<Integer> warrantyExtensionStatusIds = null;
/**
* Product Categories
*/
@ApiMember(Description="Product Categories")
public ArrayList<ProductCategory> productCategories = null;
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
public Integer page = null;
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
public Integer items = null;
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
public Boolean noCount = null;
/**
* Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
*/
@ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")
public String sortBy = null;
public String getBrand() { return brand; }
public GetSaleDetails setBrand(String value) { this.brand = value; return this; }
public String getPosCode() { return posCode; }
public GetSaleDetails setPosCode(String value) { this.posCode = value; return this; }
public String getDocumentNumber() { return documentNumber; }
public GetSaleDetails setDocumentNumber(String value) { this.documentNumber = value; return this; }
public Date getDocumentDateFrom() { return documentDateFrom; }
public GetSaleDetails setDocumentDateFrom(Date value) { this.documentDateFrom = value; return this; }
public Date getDocumentDateTo() { return documentDateTo; }
public GetSaleDetails setDocumentDateTo(Date value) { this.documentDateTo = value; return this; }
public String getArticleCode() { return articleCode; }
public GetSaleDetails setArticleCode(String value) { this.articleCode = value; return this; }
public String getSerialNumber() { return serialNumber; }
public GetSaleDetails setSerialNumber(String value) { this.serialNumber = value; return this; }
public Integer getSaleDetailId() { return saleDetailId; }
public GetSaleDetails setSaleDetailId(Integer value) { this.saleDetailId = value; return this; }
public Integer getSaleId() { return saleId; }
public GetSaleDetails setSaleId(Integer value) { this.saleId = value; return this; }
public Integer getBoosterCustomerId() { return boosterCustomerId; }
public GetSaleDetails setBoosterCustomerId(Integer value) { this.boosterCustomerId = value; return this; }
public ArrayList<Integer> getWarrantyExtensionStatusIds() { return warrantyExtensionStatusIds; }
public GetSaleDetails setWarrantyExtensionStatusIds(ArrayList<Integer> value) { this.warrantyExtensionStatusIds = value; return this; }
public ArrayList<ProductCategory> getProductCategories() { return productCategories; }
public GetSaleDetails setProductCategories(ArrayList<ProductCategory> value) { this.productCategories = value; return this; }
public Integer getPage() { return page; }
public GetSaleDetails setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetSaleDetails setItems(Integer value) { this.items = value; return this; }
public Boolean isNoCount() { return noCount; }
public GetSaleDetails setNoCount(Boolean value) { this.noCount = value; return this; }
public String getSortBy() { return sortBy; }
public GetSaleDetails setSortBy(String value) { this.sortBy = value; return this; }
}
public static class ProductCategory
{
/**
* Brand Category ID
*/
@ApiMember(Description="Brand Category ID")
public String brandCategoryId = null;
/**
* Grand Category ID
*/
@ApiMember(Description="Grand Category ID", IsRequired=true)
public String grandCategoryId = null;
/**
* Master Category ID
*/
@ApiMember(Description="Master Category ID")
public String masterCategoryId = null;
/**
* Category ID
*/
@ApiMember(Description="Category ID")
public String categoryId = null;
/**
* Sub Category ID
*/
@ApiMember(Description="Sub Category ID")
public String subCategoryId = null;
public String getBrandCategoryId() { return brandCategoryId; }
public ProductCategory setBrandCategoryId(String value) { this.brandCategoryId = value; return this; }
public String getGrandCategoryId() { return grandCategoryId; }
public ProductCategory setGrandCategoryId(String value) { this.grandCategoryId = value; return this; }
public String getMasterCategoryId() { return masterCategoryId; }
public ProductCategory setMasterCategoryId(String value) { this.masterCategoryId = value; return this; }
public String getCategoryId() { return categoryId; }
public ProductCategory setCategoryId(String value) { this.categoryId = value; return this; }
public String getSubCategoryId() { return subCategoryId; }
public ProductCategory setSubCategoryId(String value) { this.subCategoryId = value; return this; }
}
public static class GetSaleDetailsResponse
{
/**
* Index of the result set returnedr
*/
@ApiMember(Description="Index of the result set returnedr", IsRequired=true)
public Integer page = null;
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
public Integer items = null;
/**
* Total amount of pages / result sets
*/
@ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
public Integer totalPages = null;
/**
* Total amount of results
*/
@ApiMember(Description="Total amount of results", IsRequired=true)
public Integer totalResults = null;
/**
* List of Sale Details
*/
@ApiMember(Description="List of Sale Details", IsRequired=true)
public ArrayList<SaleDetail> elements = null;
public Integer getPage() { return page; }
public GetSaleDetailsResponse setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetSaleDetailsResponse setItems(Integer value) { this.items = value; return this; }
public Integer getTotalPages() { return totalPages; }
public GetSaleDetailsResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
public Integer getTotalResults() { return totalResults; }
public GetSaleDetailsResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
public ArrayList<SaleDetail> getElements() { return elements; }
public GetSaleDetailsResponse setElements(ArrayList<SaleDetail> value) { this.elements = value; return this; }
}
public static class SaleDetail
{
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)
public Integer saleId = null;
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)
public Integer saleDetailId = null;
/**
* Booster Customer Id
*/
@ApiMember(Description="Booster Customer Id")
public Integer boosterCustomerId = null;
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
public String posCode = null;
/**
* Receipt or Invoice Number
*/
@ApiMember(Description="Receipt or Invoice Number")
public String documentNumber = null;
/**
* Date of the Sell-out
*/
@ApiMember(Description="Date of the Sell-out", IsRequired=true)
public String documentDate = null;
/**
* Position Number
*/
@ApiMember(Description="Position Number")
public Integer documentLineNumber = null;
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
public String articleCode = null;
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
public String serialNumber = null;
/**
* 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 Integer quantity = null;
/**
* Retail Price
*/
@ApiMember(Description="Retail Price")
public BigDecimal retailPrice = null;
/**
* Sold Price
*/
@ApiMember(Description="Sold Price")
public BigDecimal unitPrice = null;
/**
* Currency of the sold price
*/
@ApiMember(Description="Currency of the sold price")
public String currencyCode = null;
/**
* CCP Status Code
*/
@ApiMember(Description="CCP Status Code")
public String ccpStatusCode = null;
/**
* CCP Status Description
*/
@ApiMember(Description="CCP Status Description")
public String ccpStatusDescription = null;
/**
* CCP Retrigger enable
*/
@ApiMember(Description="CCP Retrigger enable")
public Boolean retriggerEnabled = null;
/**
* Warranty Extention Status
*/
@ApiMember(Description="Warranty Extention Status")
public Integer warrantyExtentionStatusId = null;
/**
* Warranty Extention Status
*/
@ApiMember(Description="Warranty Extention Status")
public String warrantyExtentionStatusDescription = null;
/**
* Sale Representative Email
*/
@ApiMember(Description="Sale Representative Email")
public ArrayList<String> saleRepresentativeEmails = null;
/**
* Promoter Type IDs, possible values are: DAI, FIT, GRT
*/
@ApiMember(Description="Promoter Type IDs, possible values are: DAI, FIT, GRT")
public String promoterTypeId = null;
/**
* Sellout Type, possible values are: 'standard' or 'consigned'
*/
@ApiMember(Description="Sellout Type, possible values are: 'standard' or 'consigned'", IsRequired=true)
public String type = null;
/**
* Original Sale Detail Id
*/
@ApiMember(Description="Original Sale Detail Id")
public Integer originalSaleDetailId = null;
public Integer getSaleId() { return saleId; }
public SaleDetail setSaleId(Integer value) { this.saleId = value; return this; }
public Integer getSaleDetailId() { return saleDetailId; }
public SaleDetail setSaleDetailId(Integer value) { this.saleDetailId = value; return this; }
public Integer getBoosterCustomerId() { return boosterCustomerId; }
public SaleDetail setBoosterCustomerId(Integer value) { this.boosterCustomerId = value; return this; }
public String getPosCode() { return posCode; }
public SaleDetail setPosCode(String value) { this.posCode = value; return this; }
public String getDocumentNumber() { return documentNumber; }
public SaleDetail setDocumentNumber(String value) { this.documentNumber = value; return this; }
public String getDocumentDate() { return documentDate; }
public SaleDetail setDocumentDate(String value) { this.documentDate = value; return this; }
public Integer getDocumentLineNumber() { return documentLineNumber; }
public SaleDetail setDocumentLineNumber(Integer value) { this.documentLineNumber = value; return this; }
public String getArticleCode() { return articleCode; }
public SaleDetail setArticleCode(String value) { this.articleCode = value; return this; }
public String getSerialNumber() { return serialNumber; }
public SaleDetail setSerialNumber(String value) { this.serialNumber = value; return this; }
public Integer getQuantity() { return quantity; }
public SaleDetail setQuantity(Integer value) { this.quantity = value; return this; }
public BigDecimal getRetailPrice() { return retailPrice; }
public SaleDetail setRetailPrice(BigDecimal value) { this.retailPrice = value; return this; }
public BigDecimal getUnitPrice() { return unitPrice; }
public SaleDetail setUnitPrice(BigDecimal value) { this.unitPrice = value; return this; }
public String getCurrencyCode() { return currencyCode; }
public SaleDetail setCurrencyCode(String value) { this.currencyCode = value; return this; }
public String getCcpStatusCode() { return ccpStatusCode; }
public SaleDetail setCcpStatusCode(String value) { this.ccpStatusCode = value; return this; }
public String getCcpStatusDescription() { return ccpStatusDescription; }
public SaleDetail setCcpStatusDescription(String value) { this.ccpStatusDescription = value; return this; }
public Boolean isRetriggerEnabled() { return retriggerEnabled; }
public SaleDetail setRetriggerEnabled(Boolean value) { this.retriggerEnabled = value; return this; }
public Integer getWarrantyExtentionStatusId() { return warrantyExtentionStatusId; }
public SaleDetail setWarrantyExtentionStatusId(Integer value) { this.warrantyExtentionStatusId = value; return this; }
public String getWarrantyExtentionStatusDescription() { return warrantyExtentionStatusDescription; }
public SaleDetail setWarrantyExtentionStatusDescription(String value) { this.warrantyExtentionStatusDescription = value; return this; }
public ArrayList<String> getSaleRepresentativeEmails() { return saleRepresentativeEmails; }
public SaleDetail setSaleRepresentativeEmails(ArrayList<String> value) { this.saleRepresentativeEmails = value; return this; }
public String getPromoterTypeId() { return promoterTypeId; }
public SaleDetail setPromoterTypeId(String value) { this.promoterTypeId = value; return this; }
public String getType() { return type; }
public SaleDetail setType(String value) { this.type = value; return this; }
public Integer getOriginalSaleDetailId() { return originalSaleDetailId; }
public SaleDetail setOriginalSaleDetailId(Integer value) { this.originalSaleDetailId = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}