| GET | /stock/{brand}/{posCode} | Get Paginated Stock |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class GetStockPaginated : IPagedRequest
{
/**
* Brand
*/
@ApiMember(Description="Brand", IsRequired=true)
var brand:String? = null
/**
* POS Legacy
*/
@ApiMember(Description="POS Legacy", IsRequired=true)
var posCode:String? = null
/**
* Search Key (Article or SerialNumber)
*/
@ApiMember(Description="Search Key (Article or SerialNumber)")
var searchKey:String? = null
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned")
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned")
var items:Int? = null
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
var noCount:Boolean? = null
/**
* Sorting expression
*/
@ApiMember(Description="Sorting expression")
var sortBy:String? = null
/**
* Parameter - Include Chain POSes Stock
*/
@ApiMember(Description="Parameter - Include Chain POSes Stock ")
var includeChainPosesStock:Boolean? = null
/**
* Include Retail Sales Price in the Output, by default: false
*/
@ApiMember(Description="Include Retail Sales Price in the Output, by default: false")
var includeRSP:Boolean? = null
}
open class GetStockPaginatedResponse
{
/**
* Total Pages
*/
@ApiMember(Description="Total Pages", IsRequired=true)
var totalPages:Int? = null
/**
* Total Results
*/
@ApiMember(Description="Total Results", IsRequired=true)
var totalResults:Int? = null
/**
* 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
/**
* List of movements
*/
@ApiMember(Description="List of movements", IsRequired=true)
var elements:ArrayList<PaginatedStockElement> = ArrayList<PaginatedStockElement>()
}
open class PaginatedStockElement
{
/**
* Pos Code
*/
@ApiMember(Description="Pos Code", IsRequired=true)
var posCode:String? = null
/**
* Pos Code To Be Displayed
*/
@ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
var posCodeToBeDisplayed:String? = null
/**
* Article Code
*/
@ApiMember(Description="Article Code", IsRequired=true)
var articleCode:String? = null
/**
* Serial Number
*/
@ApiMember(Description="Serial Number")
var serialNumber:String? = null
/**
* Current Stock Quantity
*/
@ApiMember(Description="Current Stock Quantity", IsRequired=true)
var quantity:Int? = null
/**
* Type e.g. consignment or standard
*/
@ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)
@SerializedName("type") var Type:String? = null
/**
* Is Consignment Sellable
*/
@ApiMember(Description="Is Consignment Sellable ", IsRequired=true)
var isConsignmentSellable:Boolean? = null
/**
* Retail Sales Price
*/
@ApiMember(Description="Retail Sales Price", IsRequired=true)
var retailSalesPrice:RetailSalesPrice? = null
}
open class RetailSalesPrice
{
/**
* Currency Iso Code
*/
@ApiMember(Description="Currency Iso Code", IsRequired=true)
var currencyIsoCode:String? = null
/**
* Value
*/
@ApiMember(Description="Value", IsRequired=true)
var value:BigDecimal? = null
}
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 /stock/{brand}/{posCode} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetStockPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel"> <elements i:nil="true" /> <items>0</items> <page>0</page> <totalPages>0</totalPages> <totalResults>0</totalResults> </GetStockPaginatedResponse>