Richemont.Booster2.PublicApi

<back to all web services

ImportRequest

Requires Authentication
The following routes are available for this service:
POST/tasks/{brand}/importrequestUpload requestUpload sell-outs and customers provided in a file
<?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 ImportRequestResponse implements JsonSerializable
{
    public function __construct(
        /** @description Unique Identifier of the Import Sell-Out and Customer request created */
        // @ApiMember(Description="Unique Identifier of the Import Sell-Out and Customer request created", IsRequired=true)
        /** @var string */
        public string $asyncTaskId=''
    ) {
    }

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

class ImportRequest 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 Public key of the file in cloud server */
        // @ApiMember(Description="Public key of the file in cloud server", IsRequired=true)
        /** @var string */
        public string $externalFileId='',

        /** @description Type of import e.g. 'SelloutAndCustomer', 'Sellout' */
        // @ApiMember(Description="Type of import e.g. 'SelloutAndCustomer', 'Sellout'", IsRequired=true)
        /** @var string */
        public string $type='',

        /** @description B2 document reference to link the file with the Salesforce record */
        // @ApiMember(Description="B2 document reference to link the file with the Salesforce record")
        /** @var string|null */
        public ?string $downloadRequestId=null
    ) {
    }

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

PHP ImportRequest DTOs

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

HTTP + JSON

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

POST /tasks/{brand}/importrequest HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"brand":"String","externalFileId":"String","type":"String","downloadRequestId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}