Richemont.Booster2.PublicApi

<back to all web services

ExportMovement

Requires Authentication
The following routes are available for this service:
POST/stock/{brand}/movement/exportExport Stock Movement Data

export class MovementsRequest
{
    /** @description Brand */
    // @ApiMember(Description="Brand", IsRequired=true)
    public brand: string;

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public posCodes: string[];

    /** @description Movement Type Ids */
    // @ApiMember(Description="Movement Type Ids")
    public movementTypeIds: number[];

    /** @description Search Key (Article or SerialNumber) */
    // @ApiMember(Description="Search Key (Article or SerialNumber)")
    public searchKey: string;

    /** @description In Stock Since date from  */
    // @ApiMember(Description="In Stock Since date from ")
    public dateFrom?: string;

    /** @description In Stock Since date to */
    // @ApiMember(Description="In Stock Since date to")
    public dateTo?: string;

    /** @description Sort by date could be: 'DateDESC' or 'DateASC' (default is descending)  */
    // @ApiMember(Description="Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) ")
    public sortBy: string;

    public constructor(init?: Partial<MovementsRequest>) { (Object as any).assign(this, init); }
}

export class ExportMovementResponse
{
    /** @description Unique Identifier of the Export Request created */
    // @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    public asyncTaskId: string;

    public constructor(init?: Partial<ExportMovementResponse>) { (Object as any).assign(this, init); }
}

export class ExportMovement extends MovementsRequest
{
    /** @description Export Request ID of the API Consumers */
    // @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    public downloadRequestId: string;

    public constructor(init?: Partial<ExportMovement>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ExportMovement 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 /stock/{brand}/movement/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"downloadRequestId":"String","brand":"String","posCodes":["String"],"movementTypeIds":[0],"searchKey":"String","dateFrom":"\/Date(-62135596800000-0000)\/","dateTo":"\/Date(-62135596800000-0000)\/","sortBy":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}