Richemont.Booster2.PublicApi

<back to all web services

GetProductQuantityFigures

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/productQuantityFiguresGet product quantity figures
"use strict";
export class ReasonCodeQuantity {
    /** @param {{reasonCode?:string,quantity?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Order Reason Code */
    reasonCode;
    /**
     * @type {number}
     * @description Ordered quantity per Reason Code */
    quantity;
}
export class ProductQuantityFigure {
    /** @param {{stockPosCode?:string,articleCode?:string,stockQuantity?:number,standardStockQuantity?:number,consignmentStockQuantity?:number,orderedPendingQuantity?:number,orderedConfirmedQuantity?:number,orderedConfirmedQuantityByReason?:ReasonCodeQuantity[],inTransitQuantity?:number,inTransitQuantityByReason?:ReasonCodeQuantity[],standardAssortmentNoAutoRepQuantity?:number,standardAssortmentAutoRepQuantity?:number,consignmentAssortmentNoAutoRepQuantity?:number,consignmentAssortmentAutoRepQuantity?:number,totalOrdered?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Stock POS Legacy code */
    stockPosCode;
    /**
     * @type {string}
     * @description Article Code */
    articleCode;
    /**
     * @type {number}
     * @description Stock quantity */
    stockQuantity;
    /**
     * @type {number}
     * @description Stock quantity for standard orders */
    standardStockQuantity;
    /**
     * @type {number}
     * @description Stock quantity for consignment orders */
    consignmentStockQuantity;
    /**
     * @type {number}
     * @description Ordered pending quantity */
    orderedPendingQuantity;
    /**
     * @type {number}
     * @description Ordered confirmed quantity */
    orderedConfirmedQuantity;
    /**
     * @type {ReasonCodeQuantity[]}
     * @description Ordered confirmed quantities splitted by reason codes */
    orderedConfirmedQuantityByReason;
    /**
     * @type {number}
     * @description In transit quantity */
    inTransitQuantity;
    /**
     * @type {ReasonCodeQuantity[]}
     * @description In transit quantities splitted by reason codes */
    inTransitQuantityByReason;
    /**
     * @type {number}
     * @description Standard assortment no autoRep quantity */
    standardAssortmentNoAutoRepQuantity;
    /**
     * @type {number}
     * @description Standard assortment autoRep quantity */
    standardAssortmentAutoRepQuantity;
    /**
     * @type {number}
     * @description Consignment assortment no autoRep quantity */
    consignmentAssortmentNoAutoRepQuantity;
    /**
     * @type {number}
     * @description Consignment assortment autoRep quantity */
    consignmentAssortmentAutoRepQuantity;
    /**
     * @type {number}
     * @description Total ordered */
    totalOrdered;
}
export class GetProductQuantityFiguresResponse extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetProductQuantityFigures {
    /** @param {{brand?:string,posCodes?:string[],articleCodes?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand */
    brand;
    /**
     * @type {string[]}
     * @description POS Legacy codes */
    posCodes;
    /**
     * @type {string[]}
     * @description Article codes */
    articleCodes;
}

JavaScript GetProductQuantityFigures 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}/productQuantityFigures HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	
]