| GET | /stock/{brand}/{posCode} | Get Paginated Stock |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class RetailSalesPrice implements JsonSerializable
{
public function __construct(
/** @description Currency Iso Code */
// @ApiMember(Description="Currency Iso Code", IsRequired=true)
/** @var string */
public string $currencyIsoCode='',
/** @description Value */
// @ApiMember(Description="Value", IsRequired=true)
/** @var float */
public float $value=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['currencyIsoCode'])) $this->currencyIsoCode = $o['currencyIsoCode'];
if (isset($o['value'])) $this->value = $o['value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->currencyIsoCode)) $o['currencyIsoCode'] = $this->currencyIsoCode;
if (isset($this->value)) $o['value'] = $this->value;
return empty($o) ? new class(){} : $o;
}
}
class PaginatedStockElement implements JsonSerializable
{
public function __construct(
/** @description Pos Code */
// @ApiMember(Description="Pos Code", IsRequired=true)
/** @var string */
public string $posCode='',
/** @description Pos Code To Be Displayed */
// @ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
/** @var string */
public string $posCodeToBeDisplayed='',
/** @description Article Code */
// @ApiMember(Description="Article Code", IsRequired=true)
/** @var string */
public string $articleCode='',
/** @description Serial Number */
// @ApiMember(Description="Serial Number")
/** @var string|null */
public ?string $serialNumber=null,
/** @description Current Stock Quantity */
// @ApiMember(Description="Current Stock Quantity", IsRequired=true)
/** @var int */
public int $quantity=0,
/** @description Type e.g. consignment or standard */
// @ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)
/** @var string */
public string $type='',
/** @description Is Consignment Sellable */
// @ApiMember(Description="Is Consignment Sellable ", IsRequired=true)
/** @var bool|null */
public ?bool $isConsignmentSellable=null,
/** @description Retail Sales Price */
// @ApiMember(Description="Retail Sales Price", IsRequired=true)
/** @var RetailSalesPrice|null */
public ?RetailSalesPrice $retailSalesPrice=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['posCode'])) $this->posCode = $o['posCode'];
if (isset($o['posCodeToBeDisplayed'])) $this->posCodeToBeDisplayed = $o['posCodeToBeDisplayed'];
if (isset($o['articleCode'])) $this->articleCode = $o['articleCode'];
if (isset($o['serialNumber'])) $this->serialNumber = $o['serialNumber'];
if (isset($o['quantity'])) $this->quantity = $o['quantity'];
if (isset($o['type'])) $this->type = $o['type'];
if (isset($o['isConsignmentSellable'])) $this->isConsignmentSellable = $o['isConsignmentSellable'];
if (isset($o['retailSalesPrice'])) $this->retailSalesPrice = JsonConverters::from('RetailSalesPrice', $o['retailSalesPrice']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->posCode)) $o['posCode'] = $this->posCode;
if (isset($this->posCodeToBeDisplayed)) $o['posCodeToBeDisplayed'] = $this->posCodeToBeDisplayed;
if (isset($this->articleCode)) $o['articleCode'] = $this->articleCode;
if (isset($this->serialNumber)) $o['serialNumber'] = $this->serialNumber;
if (isset($this->quantity)) $o['quantity'] = $this->quantity;
if (isset($this->type)) $o['type'] = $this->type;
if (isset($this->isConsignmentSellable)) $o['isConsignmentSellable'] = $this->isConsignmentSellable;
if (isset($this->retailSalesPrice)) $o['retailSalesPrice'] = JsonConverters::to('RetailSalesPrice', $this->retailSalesPrice);
return empty($o) ? new class(){} : $o;
}
}
class GetStockPaginatedResponse implements JsonSerializable
{
public function __construct(
/** @description Total Pages */
// @ApiMember(Description="Total Pages", IsRequired=true)
/** @var int */
public int $totalPages=0,
/** @description Total Results */
// @ApiMember(Description="Total Results", IsRequired=true)
/** @var int */
public int $totalResults=0,
/** @description Index of the result set returned */
// @ApiMember(Description="Index of the result set returned", IsRequired=true)
/** @var int */
public int $page=0,
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned", IsRequired=true)
/** @var int */
public int $items=0,
/** @description List of movements */
// @ApiMember(Description="List of movements", IsRequired=true)
/** @var array<PaginatedStockElement>|null */
public ?array $elements=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['totalPages'])) $this->totalPages = $o['totalPages'];
if (isset($o['totalResults'])) $this->totalResults = $o['totalResults'];
if (isset($o['page'])) $this->page = $o['page'];
if (isset($o['items'])) $this->items = $o['items'];
if (isset($o['elements'])) $this->elements = JsonConverters::fromArray('PaginatedStockElement', $o['elements']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->totalPages)) $o['totalPages'] = $this->totalPages;
if (isset($this->totalResults)) $o['totalResults'] = $this->totalResults;
if (isset($this->page)) $o['page'] = $this->page;
if (isset($this->items)) $o['items'] = $this->items;
if (isset($this->elements)) $o['elements'] = JsonConverters::toArray('PaginatedStockElement', $this->elements);
return empty($o) ? new class(){} : $o;
}
}
class GetStockPaginated implements IPagedRequest, JsonSerializable
{
public function __construct(
/** @description Brand */
// @ApiMember(Description="Brand", IsRequired=true)
/** @var string */
public string $brand='',
/** @description POS Legacy */
// @ApiMember(Description="POS Legacy", IsRequired=true)
/** @var string */
public string $posCode='',
/** @description Search Key (Article or SerialNumber) */
// @ApiMember(Description="Search Key (Article or SerialNumber)")
/** @var string|null */
public ?string $searchKey=null,
/** @description Index of the result set returned */
// @ApiMember(Description="Index of the result set returned")
/** @var int */
public int $page=0,
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned")
/** @var int */
public int $items=0,
/** @description Omit precise record count - save on performance */
// @ApiMember(Description="Omit precise record count - save on performance")
/** @var bool|null */
public ?bool $noCount=null,
/** @description Sorting expression */
// @ApiMember(Description="Sorting expression")
/** @var string|null */
public ?string $sortBy=null,
/** @description Parameter - Include Chain POSes Stock */
// @ApiMember(Description="Parameter - Include Chain POSes Stock ")
/** @var bool|null */
public ?bool $includeChainPosesStock=null,
/** @description Include Retail Sales Price in the Output, by default: false */
// @ApiMember(Description="Include Retail Sales Price in the Output, by default: false")
/** @var bool|null */
public ?bool $includeRSP=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['brand'])) $this->brand = $o['brand'];
if (isset($o['posCode'])) $this->posCode = $o['posCode'];
if (isset($o['searchKey'])) $this->searchKey = $o['searchKey'];
if (isset($o['page'])) $this->page = $o['page'];
if (isset($o['items'])) $this->items = $o['items'];
if (isset($o['noCount'])) $this->noCount = $o['noCount'];
if (isset($o['sortBy'])) $this->sortBy = $o['sortBy'];
if (isset($o['includeChainPosesStock'])) $this->includeChainPosesStock = $o['includeChainPosesStock'];
if (isset($o['includeRSP'])) $this->includeRSP = $o['includeRSP'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->brand)) $o['brand'] = $this->brand;
if (isset($this->posCode)) $o['posCode'] = $this->posCode;
if (isset($this->searchKey)) $o['searchKey'] = $this->searchKey;
if (isset($this->page)) $o['page'] = $this->page;
if (isset($this->items)) $o['items'] = $this->items;
if (isset($this->noCount)) $o['noCount'] = $this->noCount;
if (isset($this->sortBy)) $o['sortBy'] = $this->sortBy;
if (isset($this->includeChainPosesStock)) $o['includeChainPosesStock'] = $this->includeChainPosesStock;
if (isset($this->includeRSP)) $o['includeRSP'] = $this->includeRSP;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"totalPages":0,"totalResults":0,"page":0,"items":0}