Richemont.Booster2.PublicApi

CancelOrder

The following routes are available for this service:
POST	/purchase/{brand}/cancel	Cancel Order

<?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 CancelOrder implements JsonSerializable
{
    public function __construct(
        /** @description SAP order id e.g. '217207773', '217207774', '217207775' */
        // @ApiMember(Description="SAP order id e.g. '217207773', '217207774', '217207775'", IsRequired=true)
        /** @var int */
        public int $purchaseOrderId=0,

        /** @description Global Pos Code for the intended Order e.g. ES100:102048 */
        // @ApiMember(Description="Global Pos Code for the intended Order e.g. ES100:102048", IsRequired=true)
        /** @var string */
        public string $posCode='',

        /** @description Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc. */
        // @ApiMember(Description="Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.", IsRequired=true)
        /** @var string */
        public string $brand='',

        /** @description Order line numbers */
        // @ApiMember(Description="Order line numbers", IsRequired=true)
        /** @var array<int>|null */
        public ?array $lineNumbers=null
    ) {
    }

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

PHP CancelOrder DTOs

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

HTTP + XML

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

POST /purchase/{brand}/cancel HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
  <brand>String</brand>
  <lineNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </lineNumbers>
  <posCode>String</posCode>
  <purchaseOrderId>0</purchaseOrderId>
</CancelOrder>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />