Richemont.Booster2.PublicApi

ExportSellOut

The following routes are available for this service:
POST	/warranty/{brand}/export	Export Sell-Out Data	Create 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 .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.

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

<ExportSellOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <articleCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </articleCodes>
  <brand>String</brand>
  <dateFrom>0001-01-01T00:00:00</dateFrom>
  <dateTo>0001-01-01T00:00:00</dateTo>
  <downloadRequestId>String</downloadRequestId>
  <posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </posCodes>
  <productCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Common.ServiceModel">
    <d2p1:ProductCategory>
      <d2p1:brandCategoryId>String</d2p1:brandCategoryId>
      <d2p1:categoryId>String</d2p1:categoryId>
      <d2p1:grandCategoryId>String</d2p1:grandCategoryId>
      <d2p1:masterCategoryId>String</d2p1:masterCategoryId>
      <d2p1:subCategoryId>String</d2p1:subCategoryId>
    </d2p1:ProductCategory>
  </productCategories>
  <saleRepresentativeEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </saleRepresentativeEmails>
  <selloutType>String</selloutType>
  <type>String</type>
  <warrantyExtensionStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </warrantyExtensionStatusIds>
</ExportSellOut>

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

<ExportSellOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Sellout.ServiceModel">
  <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId>
</ExportSellOutResponse>