Richemont.Booster2.PublicApi

ExportStock

The following routes are available for this service:
POST	/stock/{brand}/export	Export Stock Data

"use strict";
export class StockRequest {
    /** @param {{brand?:string,posCodes?:string[],articleCodes?:string[],includeExtraInfo?:boolean,clusterIds?:string[],includeConsignmentNotAuthorizedPOS?:boolean,includeRSP?:boolean,dateFrom?:string,dateTo?:string,type?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand */
    brand;
    /**
     * @type {string[]}
     * @description POS Legacy */
    posCodes;
    /**
     * @type {string[]}
     * @description Article Codes */
    articleCodes;
    /**
     * @type {boolean}
     * @description Include Extra Info */
    includeExtraInfo;
    /**
     * @type {string[]}
     * @description Cluster Id */
    clusterIds;
    /**
     * @type {boolean}
     * @description Include Consignment NotAuthorized POS */
    includeConsignmentNotAuthorizedPOS;
    /**
     * @type {boolean}
     * @description Include Retail Sales Price in the Output, by default: false */
    includeRSP;
    /**
     * @type {?string}
     * @description In Stock Since date from  */
    dateFrom;
    /**
     * @type {?string}
     * @description In Stock Since date to */
    dateTo;
    /**
     * @type {string}
     * @description Item type, 'standard' OR 'consigned'. By default, all are coming */
    type;
}
export class ExportStockResponse {
    /** @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 ExportStock extends StockRequest {
    /** @param {{productCategories?:ProductCategory[],downloadRequestId?:string,brand?:string,posCodes?:string[],articleCodes?:string[],includeExtraInfo?:boolean,clusterIds?:string[],includeConsignmentNotAuthorizedPOS?:boolean,includeRSP?:boolean,dateFrom?:string,dateTo?:string,type?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {ProductCategory[]}
     * @description Product Categories */
    productCategories;
    /**
     * @type {string}
     * @description Export Request ID of the API Consumers */
    downloadRequestId;
}

JavaScript ExportStock 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 /stock/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExportStock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel">
  <articleCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </articleCodes>
  <brand>String</brand>
  <clusterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </clusterIds>
  <dateFrom>0001-01-01T00:00:00</dateFrom>
  <dateTo>0001-01-01T00:00:00</dateTo>
  <includeConsignmentNotAuthorizedPOS>false</includeConsignmentNotAuthorizedPOS>
  <includeExtraInfo>false</includeExtraInfo>
  <includeRSP>false</includeRSP>
  <posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </posCodes>
  <type>String</type>
  <downloadRequestId>String</downloadRequestId>
  <productCategories>
    <ProductCategory>
      <brandCategoryId>String</brandCategoryId>
      <categoryId>String</categoryId>
      <grandCategoryId>String</grandCategoryId>
      <masterCategoryId>String</masterCategoryId>
      <subCategoryId>String</subCategoryId>
    </ProductCategory>
  </productCategories>
</ExportStock>

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

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