Richemont.Booster2.PublicApi

ExportStock

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StockRequest:
    # @ApiMember(Description="Brand", IsRequired=true)
    brand: Optional[str] = None
    """
    Brand
    """


    # @ApiMember(Description="POS Legacy")
    pos_codes: Optional[List[str]] = None
    """
    POS Legacy
    """


    # @ApiMember(Description="Article Codes")
    article_codes: Optional[List[str]] = None
    """
    Article Codes
    """


    # @ApiMember(Description="Include Extra Info")
    include_extra_info: bool = False
    """
    Include Extra Info
    """


    # @ApiMember(Description="Cluster Id")
    cluster_ids: Optional[List[str]] = None
    """
    Cluster Id
    """


    # @ApiMember(Description="Include Consignment NotAuthorized POS")
    include_consignment_not_authorized_p_o_s: bool = False
    """
    Include Consignment NotAuthorized POS
    """


    # @ApiMember(Description="Include Retail Sales Price in the Output, by default: false")
    include_r_s_p: bool = False
    """
    Include Retail Sales Price in the Output, by default: false
    """


    # @ApiMember(Description="In Stock Since date from ")
    date_from: Optional[datetime.datetime] = None
    """
    In Stock Since date from 
    """


    # @ApiMember(Description="In Stock Since date to")
    date_to: Optional[datetime.datetime] = None
    """
    In Stock Since date to
    """


    # @ApiMember(Description="Item type, 'standard' OR 'consigned'. By default, all are coming")
    type: Optional[str] = None
    """
    Item type, 'standard' OR 'consigned'. By default, all are coming
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExportStockResponse:
    # @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    async_task_id: Optional[str] = None
    """
    Unique Identifier of the Export Request created
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductCategory:
    # @ApiMember(Description="Brand Category ID")
    brand_category_id: Optional[str] = None
    """
    Brand Category ID
    """


    # @ApiMember(Description="Grand Category ID", IsRequired=true)
    grand_category_id: Optional[str] = None
    """
    Grand Category ID
    """


    # @ApiMember(Description="Master Category ID")
    master_category_id: Optional[str] = None
    """
    Master Category ID
    """


    # @ApiMember(Description="Category ID")
    category_id: Optional[str] = None
    """
    Category ID
    """


    # @ApiMember(Description="Sub Category ID")
    sub_category_id: Optional[str] = None
    """
    Sub Category ID
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExportStock(StockRequest):
    # @ApiMember(Description="Product Categories")
    product_categories: Optional[List[ProductCategory]] = None
    """
    Product Categories
    """


    # @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    download_request_id: Optional[str] = None
    """
    Export Request ID of the API Consumers
    """

Python 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>