| 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.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class GetSaleDetails : IPagedRequest
{
/**
* Richemont Brand ID
*/
@ApiMember(Description="Richemont Brand ID", IsRequired=true)
var brand:String? = null
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
var posCode:String? = null
/**
* Receipt or Invoice Number
*/
@ApiMember(Description="Receipt or Invoice Number")
var documentNumber:String? = null
/**
* Date of the Sell-out Start
*/
@ApiMember(Description="Date of the Sell-out Start ")
var documentDateFrom:Date? = null
/**
* Date of the Sell-out End
*/
@ApiMember(Description="Date of the Sell-out End")
var documentDateTo:Date? = null
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item")
var articleCode:String? = null
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
var serialNumber:String? = null
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster")
var saleDetailId:Int? = null
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster")
var saleId:Int? = null
/**
* Booster Customer Id
*/
@ApiMember(Description="Booster Customer Id")
var boosterCustomerId:Int? = 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)")
var warrantyExtensionStatusIds:ArrayList<Int> = ArrayList<Int>()
/**
* Product Categories
*/
@ApiMember(Description="Product Categories")
var productCategories:ArrayList<ProductCategory> = ArrayList<ProductCategory>()
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
var items:Int? = null
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
var noCount:Boolean? = null
/**
* Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
*/
@ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")
var sortBy:String? = null
}
open class ProductCategory
{
/**
* Brand Category ID
*/
@ApiMember(Description="Brand Category ID")
var brandCategoryId:String? = null
/**
* Grand Category ID
*/
@ApiMember(Description="Grand Category ID", IsRequired=true)
var grandCategoryId:String? = null
/**
* Master Category ID
*/
@ApiMember(Description="Master Category ID")
var masterCategoryId:String? = null
/**
* Category ID
*/
@ApiMember(Description="Category ID")
var categoryId:String? = null
/**
* Sub Category ID
*/
@ApiMember(Description="Sub Category ID")
var subCategoryId:String? = null
}
open class GetSaleDetailsResponse
{
/**
* Index of the result set returnedr
*/
@ApiMember(Description="Index of the result set returnedr", IsRequired=true)
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
var items:Int? = null
/**
* Total amount of pages / result sets
*/
@ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
var totalPages:Int? = null
/**
* Total amount of results
*/
@ApiMember(Description="Total amount of results", IsRequired=true)
var totalResults:Int? = null
/**
* List of Sale Details
*/
@ApiMember(Description="List of Sale Details", IsRequired=true)
var elements:ArrayList<SaleDetail> = ArrayList<SaleDetail>()
}
open class SaleDetail
{
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)
var saleId:Int? = null
/**
* Unique Identifier of the Sell-out created in Booster
*/
@ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)
var saleDetailId:Int? = null
/**
* Booster Customer Id
*/
@ApiMember(Description="Booster Customer Id")
var boosterCustomerId:Int? = null
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
var posCode:String? = null
/**
* Receipt or Invoice Number
*/
@ApiMember(Description="Receipt or Invoice Number")
var documentNumber:String? = null
/**
* Date of the Sell-out
*/
@ApiMember(Description="Date of the Sell-out", IsRequired=true)
var documentDate:String? = null
/**
* Position Number
*/
@ApiMember(Description="Position Number")
var documentLineNumber:Int? = null
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
var articleCode:String? = null
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
var serialNumber:String? = 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)
var quantity:Int? = null
/**
* Retail Price
*/
@ApiMember(Description="Retail Price")
var retailPrice:BigDecimal? = null
/**
* Sold Price
*/
@ApiMember(Description="Sold Price")
var unitPrice:BigDecimal? = null
/**
* Currency of the sold price
*/
@ApiMember(Description="Currency of the sold price")
var currencyCode:String? = null
/**
* CCP Status Code
*/
@ApiMember(Description="CCP Status Code")
var ccpStatusCode:String? = null
/**
* CCP Status Description
*/
@ApiMember(Description="CCP Status Description")
var ccpStatusDescription:String? = null
/**
* CCP Retrigger enable
*/
@ApiMember(Description="CCP Retrigger enable")
var retriggerEnabled:Boolean? = null
/**
* Warranty Extention Status
*/
@ApiMember(Description="Warranty Extention Status")
var warrantyExtentionStatusId:Int? = null
/**
* Warranty Extention Status
*/
@ApiMember(Description="Warranty Extention Status")
var warrantyExtentionStatusDescription:String? = null
/**
* Sale Representative Email
*/
@ApiMember(Description="Sale Representative Email")
var saleRepresentativeEmails:ArrayList<String> = ArrayList<String>()
/**
* Promoter Type IDs, possible values are: DAI, FIT, GRT
*/
@ApiMember(Description="Promoter Type IDs, possible values are: DAI, FIT, GRT")
var promoterTypeId:String? = null
/**
* Sellout Type, possible values are: 'standard' or 'consigned'
*/
@ApiMember(Description="Sellout Type, possible values are: 'standard' or 'consigned'", IsRequired=true)
@SerializedName("type") var Type:String? = null
/**
* Original Sale Detail Id
*/
@ApiMember(Description="Original Sale Detail Id")
var originalSaleDetailId:Int? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
page: 0,
items: 0,
totalPages: 0,
totalResults: 0
}