Richemont.Booster2.PublicApi

<back to all web services

CreateStockValidateRequest

Requires Authentication
The following routes are available for this service:
POST/stock/validateCreate Validate Stock Request
<?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 CreateStockValidateResponse implements JsonSerializable
{
    public function __construct(
        /** @description Validation Id */
        // @ApiMember(Description="Validation Id", IsRequired=true)
        /** @var int */
        public int $validationId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['validationId'])) $this->validationId = $o['validationId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->validationId)) $o['validationId'] = $this->validationId;
        return empty($o) ? new class(){} : $o;
    }
}

class CreateStockValidateRequestItem implements JsonSerializable
{
    public function __construct(
        /** @description Legacy Article Code of the item */
        // @ApiMember(Description="Legacy Article Code of the item", IsRequired=true)
        /** @var string */
        public string $articleCode='',

        /** @description Stock Quantity */
        // @ApiMember(Description="Stock Quantity", IsRequired=true)
        /** @var int */
        public int $quantity=0,

        /** @description Serial Numbers */
        // @ApiMember(Description="Serial Numbers")
        /** @var array<string>|null */
        public ?array $serialNumbers=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['articleCode'])) $this->articleCode = $o['articleCode'];
        if (isset($o['quantity'])) $this->quantity = $o['quantity'];
        if (isset($o['serialNumbers'])) $this->serialNumbers = JsonConverters::fromArray('string', $o['serialNumbers']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->articleCode)) $o['articleCode'] = $this->articleCode;
        if (isset($this->quantity)) $o['quantity'] = $this->quantity;
        if (isset($this->serialNumbers)) $o['serialNumbers'] = JsonConverters::toArray('string', $this->serialNumbers);
        return empty($o) ? new class(){} : $o;
    }
}

class CreateStockValidateRequest implements JsonSerializable
{
    public function __construct(
        /** @description Brand Trigram, e.g. CAR, IWC */
        // @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
        /** @var string */
        public string $brand='',

        /** @description POS Code e.g. ES100:102048 */
        // @ApiMember(Description="POS Code e.g. ES100:102048", IsRequired=true)
        /** @var string */
        public string $posCode='',

        /** @description Validation Date */
        // @ApiMember(Description="Validation Date", IsRequired=true)
        /** @var DateTime */
        public DateTime $date=new DateTime(),

        /** @description Items */
        // @ApiMember(Description="Items", IsRequired=true)
        /** @var array<CreateStockValidateRequestItem>|null */
        public ?array $items=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['date'])) $this->date = JsonConverters::from('DateTime', $o['date']);
        if (isset($o['items'])) $this->items = JsonConverters::fromArray('CreateStockValidateRequestItem', $o['items']);
    }
    
    /** @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->date)) $o['date'] = JsonConverters::to('DateTime', $this->date);
        if (isset($this->items)) $o['items'] = JsonConverters::toArray('CreateStockValidateRequestItem', $this->items);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateStockValidateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stock/validate HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"brand":"String","posCode":"String","date":"\/Date(-62135596800000-0000)\/","items":[{"articleCode":"String","quantity":0,"serialNumbers":["String"]}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"validationId":0}