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

export class ExportSellOutResponse
{
    /** @description Unique Identifier of the Export Request created */
    // @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    public asyncTaskId: string;

    public constructor(init?: Partial<ExportSellOutResponse>) { (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 ExportSellOut
{
    /** @description Brand Trigram, e.g. CAR, IWC */
    // @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
    public brand: string;

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

    /** @description Date To */
    // @ApiMember(Description="Date To")
    public dateTo?: string;

    /** @description Date From */
    // @ApiMember(Description="Date From")
    public dateFrom?: string;

    /** @description Item Article Codes, both Global and Local */
    // @ApiMember(Description="Item Article Codes, both Global and Local")
    public articleCodes: string[];

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

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

    /** @description Sellout Type: 'sellout' for sales, 'return' for returns, null for both */
    // @ApiMember(Description="Sellout Type: 'sellout' for sales, 'return' for returns, null for both")
    public selloutType: string;

    /** @description Type: 'consigned' or 'standard', null for both */
    // @ApiMember(Description="Type: 'consigned' or 'standard', null for both")
    public type: string;

    /** @description Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error) */
    // @ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)")
    public warrantyExtensionStatusIds: number[];

    /** @description Export Request ID of the API Consumers */
    // @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    public downloadRequestId: string;

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

TypeScript ExportSellOut DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}