Richemont.Booster2.PublicApi

ExportOrder

The following routes are available for this service:
POST	/purchase/{brand}/export	Export Order 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 ExportOrderResponse:
    # @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 ExportOrder:
    # @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
    brand: Optional[str] = None
    """
    Brand Trigram, e.g. CAR, IWC
    """


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


    # @ApiMember(Description="Date To")
    date_to: Optional[datetime.datetime] = None
    """
    Date To
    """


    # @ApiMember(Description="Date From")
    date_from: Optional[datetime.datetime] = None
    """
    Date From
    """


    # @ApiMember(Description="Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)")
    status: Optional[List[str]] = None
    """
    Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)
    """


    # @ApiMember(Description="Reason Code e.g. Y00, Y06")
    reason_code: Optional[List[str]] = None
    """
    Reason Code e.g. Y00, Y06
    """


    # @ApiMember(Description="Product Categories")
    product_categories: Optional[List[ProductCategory]] = None
    """
    Product Categories
    """


    # @ApiMember(Description="Final Ship To Pos Codes")
    final_ship_to: Optional[List[str]] = None
    """
    Final Ship To Pos Codes
    """


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

<ExportOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
  <brand>String</brand>
  <dateFrom>0001-01-01T00:00:00</dateFrom>
  <dateTo>0001-01-01T00:00:00</dateTo>
  <downloadRequestId>String</downloadRequestId>
  <finalShipTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </finalShipTo>
  <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>
  <reasonCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </reasonCode>
  <status xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </status>
</ExportOrder>

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

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