Richemont.Booster2.PublicApi

<back to all web services

GetMovements

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/movementGet movements

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 Movement
{
    /** @description Movement Id */
    // @ApiMember(Description="Movement Id", IsRequired=true)
    public movementId: number;

    /** @description Pos Code */
    // @ApiMember(Description="Pos Code", IsRequired=true)
    public posCode: string;

    /** @description Pos Name */
    // @ApiMember(Description="Pos Name", IsRequired=true)
    public posName: string;

    /** @description Created By */
    // @ApiMember(Description="Created By", IsRequired=true)
    public createdBy: string;

    /** @description Movement Date */
    // @ApiMember(Description="Movement Date", IsRequired=true)
    public movementDate: string;

    /** @description Article Code */
    // @ApiMember(Description="Article Code", IsRequired=true)
    public articleCode: string;

    /** @description Serial Number */
    // @ApiMember(Description="Serial Number", IsRequired=true)
    public serialNumber: string;

    /** @description Quantity */
    // @ApiMember(Description="Quantity", IsRequired=true)
    public quantity: number;

    /** @description Movement Type Id */
    // @ApiMember(Description="Movement Type Id", IsRequired=true)
    public movementTypeId: number;

    /** @description Comments */
    // @ApiMember(Description="Comments", IsRequired=true)
    public comments: string;

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

export class GetMovementsResponse
{
    /** @description Total Pages */
    // @ApiMember(Description="Total Pages", IsRequired=true)
    public totalPages: number;

    /** @description Total Results */
    // @ApiMember(Description="Total Results", IsRequired=true)
    public totalResults: number;

    /** @description Index of the result set returned */
    // @ApiMember(Description="Index of the result set returned", IsRequired=true)
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned", IsRequired=true)
    public items: number;

    /** @description List of movements */
    // @ApiMember(Description="List of movements", IsRequired=true)
    public elements: Movement[];

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

export class GetMovements extends MovementsRequest implements IPagedRequest
{
    /** @description Index of the result set returned */
    // @ApiMember(Description="Index of the result set returned")
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned")
    public items: number;

    /** @description Omit precise record count - save on performance */
    // @ApiMember(Description="Omit precise record count - save on performance")
    public noCount: boolean;

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

TypeScript GetMovements DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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