Richemont.Booster2.PublicApi

<back to all web services

ExportSellOut

Requires Authentication
The following routes are available for this service:
POST/warranty/{brand}/exportExport Sell-Out DataCreate a sell-out in a POS you are authorised for
"use strict";
export class ExportSellOutResponse {
    /** @param {{asyncTaskId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Unique Identifier of the Export Request created */
    asyncTaskId;
}
export class ProductCategory {
    /** @param {{brandCategoryId?:string,grandCategoryId?:string,masterCategoryId?:string,categoryId?:string,subCategoryId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand Category ID */
    brandCategoryId;
    /**
     * @type {string}
     * @description Grand Category ID */
    grandCategoryId;
    /**
     * @type {string}
     * @description Master Category ID */
    masterCategoryId;
    /**
     * @type {string}
     * @description Category ID */
    categoryId;
    /**
     * @type {string}
     * @description Sub Category ID */
    subCategoryId;
}
export class ExportSellOut {
    /** @param {{brand?:string,posCodes?:string[],dateTo?:string,dateFrom?:string,articleCodes?:string[],productCategories?:ProductCategory[],saleRepresentativeEmails?:string[],selloutType?:string,type?:string,warrantyExtensionStatusIds?:number[],downloadRequestId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand Trigram, e.g. CAR, IWC */
    brand;
    /**
     * @type {string[]}
     * @description Pos Legacy IDs / Codes */
    posCodes;
    /**
     * @type {?string}
     * @description Date To */
    dateTo;
    /**
     * @type {?string}
     * @description Date From */
    dateFrom;
    /**
     * @type {string[]}
     * @description Item Article Codes, both Global and Local */
    articleCodes;
    /**
     * @type {ProductCategory[]}
     * @description Product Categories */
    productCategories;
    /**
     * @type {string[]}
     * @description Sale Representative Email */
    saleRepresentativeEmails;
    /**
     * @type {string}
     * @description Sellout Type: 'sellout' for sales, 'return' for returns, null for both */
    selloutType;
    /**
     * @type {string}
     * @description Type: 'consigned' or 'standard', null for both */
    type;
    /**
     * @type {number[]}
     * @description Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error) */
    warrantyExtensionStatusIds;
    /**
     * @type {string}
     * @description Export Request ID of the API Consumers */
    downloadRequestId;
}

JavaScript ExportSellOut DTOs

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

HTTP + OTHER

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

POST /warranty/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"brand":"String","posCodes":["String"],"dateTo":"\/Date(-62135596800000-0000)\/","dateFrom":"\/Date(-62135596800000-0000)\/","articleCodes":["String"],"productCategories":[{"brandCategoryId":"String","grandCategoryId":"String","masterCategoryId":"String","categoryId":"String","subCategoryId":"String"}],"saleRepresentativeEmails":["String"],"selloutType":"String","type":"String","warrantyExtensionStatusIds":[0],"downloadRequestId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}