Richemont.Booster2.PublicApi

GetBuyInPaginated

The following routes are available for this service:
GET	/buyin/{brand}	Get list of buyin	Get list of paginated buyin based on the search parameters submitted

// @ts-nocheck

export class BuyIn
{
    /** @description Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided */
    // @ApiMember(Description="Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided", IsRequired=true)
    public brand: string;

    /** @description Code of BuyIn */
    // @ApiMember(Description="Code of BuyIn", IsRequired=true)
    public buyInOrderId: number;

    /** @description Richemont POS code */
    // @ApiMember(Description="Richemont POS code", IsRequired=true)
    public posCode: string;

    /** @description Richemont Reference Code of the item */
    // @ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)
    public articleCode: string;

    /** @description Serial Number of the item */
    // @ApiMember(Description="Serial Number of the item")
    public serialNumber: string;

    /** @description Buy-in order status code */
    // @ApiMember(Description="Buy-in order status code")
    public buyInStatusId: string;

    /** @description Buy-in creation date */
    // @ApiMember(Description="Buy-in creation date")
    public buyInDate: string;

    /** @description Emails of Sale Representatives */
    // @ApiMember(Description="Emails of Sale Representatives")
    public saleRepresentativeEmails: string[] = [];

    /** @description True is the buy-in’s piece is in stock, False otherwise */
    // @ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")
    public isInStock: boolean;

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

export class GetBuyInPaginatedResponse
{
    /** @description Index of the result set returnedr */
    // @ApiMember(Description="Index of the result set returnedr", 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 Total amount of pages / result sets */
    // @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
    public totalPages: number;

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

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

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

export class GetBuyInPaginated
{
    /** @description Richemont Brand ID */
    // @ApiMember(Description="Richemont Brand ID")
    public brand: string;

    /** @description Richemont POS code */
    // @ApiMember(Description="Richemont POS code", IsRequired=true)
    public posCode: string;

    /** @description Richemont Reference Code of the item */
    // @ApiMember(Description="Richemont Reference Code of the item")
    public articleCode: string;

    /** @description Serial Number of the item */
    // @ApiMember(Description="Serial Number of the item")
    public serialNumber: string;

    /** @description Buy-in order status code */
    // @ApiMember(Description="Buy-in order status code")
    public buyInStatusId: string;

    /** @description True is the buy-in’s piece is in stock, False otherwise */
    // @ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")
    public isInStock?: boolean;

    /** @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 Omit precise record count - save on performance */
    // @ApiMember(Description="Omit precise record count - save on performance")
    public noCount: boolean;

    /** @description Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'. */
    // @ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")
    public sortBy: string;

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

TypeScript GetBuyInPaginated DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /buyin/{brand} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetBuyInPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CPO.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetBuyInPaginatedResponse>