Richemont.Booster2.PublicApi

<back to all web services

GetMovements

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/movementGet movements
"use strict";
export class MovementsRequest {
    /** @param {{brand?:string,posCodes?:string[],movementTypeIds?:number[],searchKey?:string,dateFrom?:string,dateTo?:string,sortBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand */
    brand;
    /**
     * @type {string[]}
     * @description POS Legacy */
    posCodes;
    /**
     * @type {number[]}
     * @description Movement Type Ids */
    movementTypeIds;
    /**
     * @type {string}
     * @description Search Key (Article or SerialNumber) */
    searchKey;
    /**
     * @type {?string}
     * @description In Stock Since date from  */
    dateFrom;
    /**
     * @type {?string}
     * @description In Stock Since date to */
    dateTo;
    /**
     * @type {string}
     * @description Sort by date could be: 'DateDESC' or 'DateASC' (default is descending)  */
    sortBy;
}
export class Movement {
    /** @param {{movementId?:number,posCode?:string,posName?:string,createdBy?:string,movementDate?:string,articleCode?:string,serialNumber?:string,quantity?:number,movementTypeId?:number,comments?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Movement Id */
    movementId;
    /**
     * @type {string}
     * @description Pos Code */
    posCode;
    /**
     * @type {string}
     * @description Pos Name */
    posName;
    /**
     * @type {string}
     * @description Created By */
    createdBy;
    /**
     * @type {string}
     * @description Movement Date */
    movementDate;
    /**
     * @type {string}
     * @description Article Code */
    articleCode;
    /**
     * @type {string}
     * @description Serial Number */
    serialNumber;
    /**
     * @type {number}
     * @description Quantity */
    quantity;
    /**
     * @type {number}
     * @description Movement Type Id */
    movementTypeId;
    /**
     * @type {string}
     * @description Comments */
    comments;
}
export class GetMovementsResponse {
    /** @param {{totalPages?:number,totalResults?:number,page?:number,items?:number,elements?:Movement[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Total Pages */
    totalPages;
    /**
     * @type {number}
     * @description Total Results */
    totalResults;
    /**
     * @type {number}
     * @description Index of the result set returned */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {Movement[]}
     * @description List of movements */
    elements;
}
export class GetMovements extends MovementsRequest {
    /** @param {{page?:number,items?:number,noCount?:boolean,brand?:string,posCodes?:string[],movementTypeIds?:number[],searchKey?:string,dateFrom?:string,dateTo?:string,sortBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description Index of the result set returned */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {boolean}
     * @description Omit precise record count - save on performance */
    noCount;
}

JavaScript GetMovements 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.

GET /stock/{brand}/movement HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"totalPages":0,"totalResults":0,"page":0,"items":0}