Richemont.Booster2.PublicApi

<back to all web services

GetCustomerPaginated

export class GetCustomerInterest
{
    /** @description Interest description */
    // @ApiMember(Description="Interest description", IsRequired=true)
    public interest: string;

    /** @description SAP Interest ID, e.g. 'CA-1' */
    // @ApiMember(Description="SAP Interest ID, e.g. 'CA-1'", IsRequired=true)
    public sapInterestId: string;

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

export class GetCustomerHobby
{
    /** @description Hobby description */
    // @ApiMember(Description="Hobby description")
    public hobby: string;

    /** @description SAP Hobby ID, e.g. 'ART' */
    // @ApiMember(Description="SAP Hobby ID, e.g. 'ART'")
    public sapHobbyId: string;

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

export class GetCustomerProductCollection
{
    /** @description Product Collection description */
    // @ApiMember(Description="Product Collection description", IsRequired=true)
    public productCollection: string;

    /** @description SAP ProductCollection ID, e.g. 'CA-1' */
    // @ApiMember(Description="SAP ProductCollection ID, e.g. 'CA-1'", IsRequired=true)
    public sapProductCollectionId: string;

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

export class ProductCategory
{
    /** @description Brand Category ID */
    // @ApiMember(Description="Brand Category ID")
    public brandCategoryId: string;

    /** @description Grand Category ID */
    // @ApiMember(Description="Grand Category ID", IsRequired=true)
    public grandCategoryId: string;

    /** @description Master Category ID */
    // @ApiMember(Description="Master Category ID")
    public masterCategoryId: string;

    /** @description Category ID */
    // @ApiMember(Description="Category ID")
    public categoryId: string;

    /** @description Sub Category ID */
    // @ApiMember(Description="Sub Category ID")
    public subCategoryId: string;

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

export class SearchCustomer
{
    /** @description Brand */
    // @ApiMember(Description="Brand", IsRequired=true)
    public brand: string;

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public posCodes: string[];

    /** @description Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId' */
    // @ApiMember(Description="Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'")
    public searchKey: string;

    /** @description Search by phone number - exact match */
    // @ApiMember(Description="Search by phone number - exact match")
    public phoneNumber: string;

    /** @description Search by email address - exact match */
    // @ApiMember(Description="Search by email address - exact match")
    public email: string;

    /** @description Values can be 'it', 'en' etc. */
    // @ApiMember(Description="Values can be 'it', 'en' etc.")
    public locationCountryIds: string[];

    /** @description Client Spending From e.g. '100' */
    // @ApiMember(Description="Client Spending From e.g. '100'")
    public clientSpendingFrom?: number;

    /** @description Client Spending To e.g. '50000' */
    // @ApiMember(Description="Client Spending To e.g. '50000'")
    public clientSpendingTo?: number;

    /** @description Customer Creation Date From e.g. '2022-01-01' */
    // @ApiMember(Description="Customer Creation Date From e.g. '2022-01-01'")
    public creationDateFrom?: string;

    /** @description Customer Creation Date To e.g. '2023-11-01' */
    // @ApiMember(Description="Customer Creation Date To e.g. '2023-11-01'")
    public creationDateTo?: string;

    /** @description Transaction Date From e.g. '2022-01-01' */
    // @ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
    public transactionDateFrom?: string;

    /** @description Transaction Date To e.g. '2023-11-01' */
    // @ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
    public transactionDateTo?: string;

    /** @description Values can be 'true' or 'false' */
    // @ApiMember(Description="Values can be 'true' or 'false'")
    public canBeContactedByMaison?: boolean;

    /** @description Values can be 1 for 'January', 2 for 'February', 3 for 'March', 4 for 'April', 5 for 'May', 6 for 'June', 7 for 'July', 8 for 'August', 9 for 'September', 10 for 'October', 11 for 'November', 12 for 'December' */
    // @ApiMember(Description="Values can be 1 for 'January', 2 for 'February', 3 for 'March', 4 for 'April', 5 for 'May', 6 for 'June', 7 for 'July', 8 for 'August', 9 for 'September', 10 for 'October', 11 for 'November', 12 for 'December'")
    public birthdateMonths: number[];

    /** @description Customer interest filter */
    // @ApiMember(Description="Customer interest filter")
    public interests: GetCustomerInterest[];

    /** @description Customer hobby filter */
    // @ApiMember(Description="Customer hobby filter")
    public hobbies: GetCustomerHobby[];

    /** @description Customer product collection filter */
    // @ApiMember(Description="Customer product collection filter")
    public productCollections: GetCustomerProductCollection[];

    /** @description Customer Status e.g. 'Prospect', 'Client' */
    // @ApiMember(Description="Customer Status e.g. 'Prospect', 'Client'")
    public customerStatus: string[];

    /** @description List of BoosterCustomerIds, e.g. 1234567,1231231,12323423 */
    // @ApiMember(Description="List of BoosterCustomerIds, e.g. 1234567,1231231,12323423")
    public boosterCustomerIds: number[];

    /** @description Values can be 'true' or 'false' */
    // @ApiMember(Description="Values can be 'true' or 'false'")
    public hasSapCrmError?: boolean;

    /** @description Product Categories */
    // @ApiMember(Description="Product Categories")
    public productCategories: ProductCategory[];

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

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

export class GetCustomerPaginatedElement
{
    /** @description Booster Customer Id */
    // @ApiMember(Description="Booster Customer Id", IsRequired=true)
    public boosterCustomerId: number;

    /** @description First name */
    // @ApiMember(Description="First name", IsRequired=true)
    public firstName: string;

    /** @description Middle name */
    // @ApiMember(Description="Middle name", IsRequired=true)
    public middleName: string;

    /** @description Last name */
    // @ApiMember(Description="Last name", IsRequired=true)
    public lastName: string;

    /** @description First name Not Latin */
    // @ApiMember(Description="First name Not Latin", IsRequired=true)
    public firstNameNotLatin: string;

    /** @description Last name Not Latin */
    // @ApiMember(Description="Last name Not Latin", IsRequired=true)
    public lastNameNotLatin: string;

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

    /** @description Phone Country Prefix */
    // @ApiMember(Description="Phone Country Prefix", IsRequired=true)
    public countryPrefix: string;

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

    /** @description Data Sharing Consent */
    // @ApiMember(Description="Data Sharing Consent", IsRequired=true)
    public dataSharingConsent: boolean;

    /** @description Sellout Transaction Count */
    // @ApiMember(Description="Sellout Transaction Count", IsRequired=true)
    public selloutTransactionCount: number;

    /** @description Elevate Customer ID */
    // @ApiMember(Description="Elevate Customer ID")
    public elevateCustomerId: string;

    /** @description Elevate Consent Status */
    // @ApiMember(Description="Elevate Consent Status")
    public elevateConsentStatus: string;

    /** @description Customer Country Id */
    // @ApiMember(Description="Customer Country Id")
    public countryId: string;

    /** @description Registration date */
    // @ApiMember(Description="Registration date")
    public registrationDate?: string;

    /** @description Sap Crm Error Message */
    // @ApiMember(Description="Sap Crm Error Message")
    public sapCrmErrorMessage: string;

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

export class GetCustomerPaginatedResponse
{
    /** @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 customers */
    // @ApiMember(Description="List of customers", IsRequired=true)
    public elements: GetCustomerPaginatedElement[];

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

export class GetCustomerPaginated extends SearchCustomer 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;

    /** @description Values can be 'NameDESC', 'NameASC', 'RegASC', 'RegDESC' */
    // @ApiMember(Description="Values can be 'NameDESC', 'NameASC', 'RegASC', 'RegDESC'")
    public sortBy: string;

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

TypeScript GetCustomerPaginated DTOs

GET /customer/{brand}/slim HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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