| GET | /buyin/{brand} | Get list of buyin | Get list of paginated buyin based on the search parameters submitted |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class GetBuyInPaginated
{
/**
* Richemont Brand ID
*/
@ApiMember(Description="Richemont Brand ID")
open var brand:String? = null
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
open var posCode:String? = null
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item")
open var articleCode:String? = null
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
open var serialNumber:String? = null
/**
* Buy-in order status code
*/
@ApiMember(Description="Buy-in order status code")
open var buyInStatusId:String? = null
/**
* True is the buy-in’s piece is in stock, False otherwise
*/
@ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")
open var isInStock:Boolean? = null
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
open var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
open var items:Int? = null
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
open var noCount:Boolean? = null
/**
* Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
*/
@ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")
open var sortBy:String? = null
}
open class GetBuyInPaginatedResponse
{
/**
* Index of the result set returnedr
*/
@ApiMember(Description="Index of the result set returnedr", IsRequired=true)
open var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
open var items:Int? = null
/**
* Total amount of pages / result sets
*/
@ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
open var totalPages:Int? = null
/**
* Total amount of results
*/
@ApiMember(Description="Total amount of results", IsRequired=true)
open var totalResults:Int? = null
/**
* List of Sale Details
*/
@ApiMember(Description="List of Sale Details", IsRequired=true)
open var elements:ArrayList<BuyIn>? = null
}
open class BuyIn
{
/**
* Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
*/
@ApiMember(Description="Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided", IsRequired=true)
open var brand:String? = null
/**
* Code of BuyIn
*/
@ApiMember(Description="Code of BuyIn", IsRequired=true)
open var buyInOrderId:Int? = null
/**
* Richemont POS code
*/
@ApiMember(Description="Richemont POS code", IsRequired=true)
open var posCode:String? = null
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
open var articleCode:String? = null
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
open var serialNumber:String? = null
/**
* Buy-in order status code
*/
@ApiMember(Description="Buy-in order status code")
open var buyInStatusId:String? = null
/**
* Buy-in creation date
*/
@ApiMember(Description="Buy-in creation date")
open var buyInDate:Date? = null
/**
* Emails of Sale Representatives
*/
@ApiMember(Description="Emails of Sale Representatives")
open var saleRepresentativeEmails:ArrayList<String> = ArrayList<String>()
/**
* True is the buy-in’s piece is in stock, False otherwise
*/
@ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")
open var isInStock:Boolean? = 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 /buyin/{brand} 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
}