| GET | /stock/{brand}/{posCode}/{articleCode} | Get stock details |
|---|
export class Pos
{
/** @description Name of the POS */
// @ApiMember(Description="Name of the POS", IsRequired=true)
public name: string;
/** @description POS Code */
// @ApiMember(Description="POS Code", IsRequired=true)
public posCode: string;
/** @description Pos Code To Be Displayed */
// @ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
public posCodeToBeDisplayed: string;
/** @description Country of the POS */
// @ApiMember(Description="Country of the POS", IsRequired=true)
public country: string;
/** @description City of the POS */
// @ApiMember(Description="City of the POS", IsRequired=true)
public city: string;
/** @description Postal Code */
// @ApiMember(Description="Postal Code", IsRequired=true)
public postalCode: string;
/** @description State */
// @ApiMember(Description="State", IsRequired=true)
public state: string;
/** @description Street */
// @ApiMember(Description="Street", IsRequired=true)
public street: string;
public constructor(init?: Partial<Pos>) { (Object as any).assign(this, init); }
}
export class UnitNetAmount
{
/** @description Currency Iso Code */
// @ApiMember(Description="Currency Iso Code", IsRequired=true)
public currencyIsoCode: string;
/** @description Value */
// @ApiMember(Description="Value", IsRequired=true)
public value: number;
public constructor(init?: Partial<UnitNetAmount>) { (Object as any).assign(this, init); }
}
export class StockPositionItem
{
/** @description Quantity */
// @ApiMember(Description="Quantity", IsRequired=true)
public quantity: number;
/** @description Serial Number */
// @ApiMember(Description="Serial Number")
public serialNumber: string;
/** @description Stock Date */
// @ApiMember(Description="Stock Date", IsRequired=true)
public stockDate: string;
/** @description Loaded On Date */
// @ApiMember(Description="Loaded On Date", IsRequired=true)
public loadedOnDate: string;
/** @description Type e.g. consignment or standard */
// @ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)
public type: string;
/** @description Is Consignment Sellable */
// @ApiMember(Description="Is Consignment Sellable ", IsRequired=true)
public isConsignmentSellable: boolean;
/** @description Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase. */
// @ApiMember(Description="Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase.")
public unitNetAmount: UnitNetAmount;
/** @description Retail Sales Price */
// @ApiMember(Description="Retail Sales Price")
public retailSalesPrice: UnitNetAmount;
public constructor(init?: Partial<StockPositionItem>) { (Object as any).assign(this, init); }
}
export class GetStockDetailResponse
{
/** @description Article code */
// @ApiMember(Description="Article code", IsRequired=true)
public articleCode: string;
/** @description Brand */
// @ApiMember(Description="Brand", IsRequired=true)
public brand: string;
/** @description Pos Code */
// @ApiMember(Description="Pos Code", IsRequired=true)
public posCode: string;
/** @description Current Stock Quantity */
// @ApiMember(Description="Current Stock Quantity", IsRequired=true)
public currentStockQuantity: number;
/** @description Shared Stock Location */
// @ApiMember(Description="Shared Stock Location", IsRequired=true)
public sharedStockLocation: Pos;
/** @description Stock Positions */
// @ApiMember(Description="Stock Positions", IsRequired=true)
public stockPositions: StockPositionItem[];
public constructor(init?: Partial<GetStockDetailResponse>) { (Object as any).assign(this, init); }
}
export class GetStockDetail
{
/** @description Brand */
// @ApiMember(Description="Brand", IsRequired=true)
public brand: string;
/** @description POS Legacy */
// @ApiMember(Description="POS Legacy", IsRequired=true)
public posCode: string;
/** @description Article Code */
// @ApiMember(Description="Article Code", IsRequired=true)
public articleCode: string;
public constructor(init?: Partial<GetStockDetail>) { (Object as any).assign(this, init); }
}
TypeScript GetStockDetail DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /stock/{brand}/{posCode}/{articleCode} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"articleCode":"String","brand":"String","posCode":"String","currentStockQuantity":0,"sharedStockLocation":{"name":"String","posCode":"String","posCodeToBeDisplayed":"String","country":"String","city":"String","postalCode":"String","state":"String","street":"String"},"stockPositions":[{"quantity":0,"serialNumber":"String","stockDate":"String","loadedOnDate":"String","type":"String","isConsignmentSellable":false,"unitNetAmount":{"currencyIsoCode":"String","value":0},"retailSalesPrice":{"currencyIsoCode":"String","value":0}}]}