| GET | /stock/{brand}/productQuantityFigures | Get product quantity figures |
|---|
<?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 ReasonCodeQuantity implements JsonSerializable
{
public function __construct(
/** @description Order Reason Code */
// @ApiMember(Description="Order Reason Code", IsRequired=true)
/** @var string */
public string $reasonCode='',
/** @description Ordered quantity per Reason Code */
// @ApiMember(Description="Ordered quantity per Reason Code", IsRequired=true)
/** @var int */
public int $quantity=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['reasonCode'])) $this->reasonCode = $o['reasonCode'];
if (isset($o['quantity'])) $this->quantity = $o['quantity'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->reasonCode)) $o['reasonCode'] = $this->reasonCode;
if (isset($this->quantity)) $o['quantity'] = $this->quantity;
return empty($o) ? new class(){} : $o;
}
}
class ProductQuantityFigure implements JsonSerializable
{
public function __construct(
/** @description Stock POS Legacy code */
// @ApiMember(Description="Stock POS Legacy code", IsRequired=true)
/** @var string */
public string $stockPosCode='',
/** @description Article Code */
// @ApiMember(Description="Article Code", IsRequired=true)
/** @var string */
public string $articleCode='',
/** @description Stock quantity */
// @ApiMember(Description="Stock quantity", IsRequired=true)
/** @var int */
public int $stockQuantity=0,
/** @description Stock quantity for standard orders */
// @ApiMember(Description="Stock quantity for standard orders", IsRequired=true)
/** @var int */
public int $standardStockQuantity=0,
/** @description Stock quantity for consignment orders */
// @ApiMember(Description="Stock quantity for consignment orders", IsRequired=true)
/** @var int */
public int $consignmentStockQuantity=0,
/** @description Ordered pending quantity */
// @ApiMember(Description="Ordered pending quantity", IsRequired=true)
/** @var int */
public int $orderedPendingQuantity=0,
/** @description Ordered confirmed quantity */
// @ApiMember(Description="Ordered confirmed quantity", IsRequired=true)
/** @var int */
public int $orderedConfirmedQuantity=0,
/** @description Ordered confirmed quantities splitted by reason codes */
// @ApiMember(Description="Ordered confirmed quantities splitted by reason codes")
/** @var array<ReasonCodeQuantity>|null */
public ?array $orderedConfirmedQuantityByReason=null,
/** @description In transit quantity */
// @ApiMember(Description="In transit quantity", IsRequired=true)
/** @var int */
public int $inTransitQuantity=0,
/** @description In transit quantities splitted by reason codes */
// @ApiMember(Description="In transit quantities splitted by reason codes")
/** @var array<ReasonCodeQuantity>|null */
public ?array $inTransitQuantityByReason=null,
/** @description Standard assortment no autoRep quantity */
// @ApiMember(Description="Standard assortment no autoRep quantity", IsRequired=true)
/** @var int */
public int $standardAssortmentNoAutoRepQuantity=0,
/** @description Standard assortment autoRep quantity */
// @ApiMember(Description="Standard assortment autoRep quantity", IsRequired=true)
/** @var int */
public int $standardAssortmentAutoRepQuantity=0,
/** @description Consignment assortment no autoRep quantity */
// @ApiMember(Description="Consignment assortment no autoRep quantity", IsRequired=true)
/** @var int */
public int $consignmentAssortmentNoAutoRepQuantity=0,
/** @description Consignment assortment autoRep quantity */
// @ApiMember(Description="Consignment assortment autoRep quantity", IsRequired=true)
/** @var int */
public int $consignmentAssortmentAutoRepQuantity=0,
/** @description Total ordered */
// @ApiMember(Description="Total ordered", IsRequired=true)
/** @var int */
public int $totalOrdered=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['stockPosCode'])) $this->stockPosCode = $o['stockPosCode'];
if (isset($o['articleCode'])) $this->articleCode = $o['articleCode'];
if (isset($o['stockQuantity'])) $this->stockQuantity = $o['stockQuantity'];
if (isset($o['standardStockQuantity'])) $this->standardStockQuantity = $o['standardStockQuantity'];
if (isset($o['consignmentStockQuantity'])) $this->consignmentStockQuantity = $o['consignmentStockQuantity'];
if (isset($o['orderedPendingQuantity'])) $this->orderedPendingQuantity = $o['orderedPendingQuantity'];
if (isset($o['orderedConfirmedQuantity'])) $this->orderedConfirmedQuantity = $o['orderedConfirmedQuantity'];
if (isset($o['orderedConfirmedQuantityByReason'])) $this->orderedConfirmedQuantityByReason = JsonConverters::fromArray('ReasonCodeQuantity', $o['orderedConfirmedQuantityByReason']);
if (isset($o['inTransitQuantity'])) $this->inTransitQuantity = $o['inTransitQuantity'];
if (isset($o['inTransitQuantityByReason'])) $this->inTransitQuantityByReason = JsonConverters::fromArray('ReasonCodeQuantity', $o['inTransitQuantityByReason']);
if (isset($o['standardAssortmentNoAutoRepQuantity'])) $this->standardAssortmentNoAutoRepQuantity = $o['standardAssortmentNoAutoRepQuantity'];
if (isset($o['standardAssortmentAutoRepQuantity'])) $this->standardAssortmentAutoRepQuantity = $o['standardAssortmentAutoRepQuantity'];
if (isset($o['consignmentAssortmentNoAutoRepQuantity'])) $this->consignmentAssortmentNoAutoRepQuantity = $o['consignmentAssortmentNoAutoRepQuantity'];
if (isset($o['consignmentAssortmentAutoRepQuantity'])) $this->consignmentAssortmentAutoRepQuantity = $o['consignmentAssortmentAutoRepQuantity'];
if (isset($o['totalOrdered'])) $this->totalOrdered = $o['totalOrdered'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->stockPosCode)) $o['stockPosCode'] = $this->stockPosCode;
if (isset($this->articleCode)) $o['articleCode'] = $this->articleCode;
if (isset($this->stockQuantity)) $o['stockQuantity'] = $this->stockQuantity;
if (isset($this->standardStockQuantity)) $o['standardStockQuantity'] = $this->standardStockQuantity;
if (isset($this->consignmentStockQuantity)) $o['consignmentStockQuantity'] = $this->consignmentStockQuantity;
if (isset($this->orderedPendingQuantity)) $o['orderedPendingQuantity'] = $this->orderedPendingQuantity;
if (isset($this->orderedConfirmedQuantity)) $o['orderedConfirmedQuantity'] = $this->orderedConfirmedQuantity;
if (isset($this->orderedConfirmedQuantityByReason)) $o['orderedConfirmedQuantityByReason'] = JsonConverters::toArray('ReasonCodeQuantity', $this->orderedConfirmedQuantityByReason);
if (isset($this->inTransitQuantity)) $o['inTransitQuantity'] = $this->inTransitQuantity;
if (isset($this->inTransitQuantityByReason)) $o['inTransitQuantityByReason'] = JsonConverters::toArray('ReasonCodeQuantity', $this->inTransitQuantityByReason);
if (isset($this->standardAssortmentNoAutoRepQuantity)) $o['standardAssortmentNoAutoRepQuantity'] = $this->standardAssortmentNoAutoRepQuantity;
if (isset($this->standardAssortmentAutoRepQuantity)) $o['standardAssortmentAutoRepQuantity'] = $this->standardAssortmentAutoRepQuantity;
if (isset($this->consignmentAssortmentNoAutoRepQuantity)) $o['consignmentAssortmentNoAutoRepQuantity'] = $this->consignmentAssortmentNoAutoRepQuantity;
if (isset($this->consignmentAssortmentAutoRepQuantity)) $o['consignmentAssortmentAutoRepQuantity'] = $this->consignmentAssortmentAutoRepQuantity;
if (isset($this->totalOrdered)) $o['totalOrdered'] = $this->totalOrdered;
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of ProductQuantityFigure
*/
class GetProductQuantityFiguresResponse extends \ArrayObject implements JsonSerializable
{
public function __construct(ProductQuantityFigure ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof ProductQuantityFigure)
parent::append($value);
else
throw new \Exception("Can only append a ProductQuantityFigure to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new ProductQuantityFigure();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
class GetProductQuantityFigures implements JsonSerializable
{
public function __construct(
/** @description Brand */
// @ApiMember(Description="Brand", IsRequired=true)
/** @var string */
public string $brand='',
/** @description POS Legacy codes */
// @ApiMember(Description="POS Legacy codes", IsRequired=true)
/** @var array<string>|null */
public ?array $posCodes=null,
/** @description Article codes */
// @ApiMember(Description="Article codes", IsRequired=true)
/** @var array<string>|null */
public ?array $articleCodes=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['brand'])) $this->brand = $o['brand'];
if (isset($o['posCodes'])) $this->posCodes = JsonConverters::fromArray('string', $o['posCodes']);
if (isset($o['articleCodes'])) $this->articleCodes = JsonConverters::fromArray('string', $o['articleCodes']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->brand)) $o['brand'] = $this->brand;
if (isset($this->posCodes)) $o['posCodes'] = JsonConverters::toArray('string', $this->posCodes);
if (isset($this->articleCodes)) $o['articleCodes'] = JsonConverters::toArray('string', $this->articleCodes);
return empty($o) ? new class(){} : $o;
}
}
PHP GetProductQuantityFigures DTOs
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 /stock/{brand}/productQuantityFigures HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length [ ]