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
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 ExportSellOutResponse:
    # @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 ExportSellOut:
    # @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
    brand: Optional[str] = None
    """
    Brand Trigram, e.g. CAR, IWC
    """


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


    # @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="Item Article Codes, both Global and Local")
    article_codes: Optional[List[str]] = None
    """
    Item Article Codes, both Global and Local
    """


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


    # @ApiMember(Description="Sale Representative Email")
    sale_representative_emails: Optional[List[str]] = None
    """
    Sale Representative Email
    """


    # @ApiMember(Description="Sellout Type: 'sellout' for sales, 'return' for returns, null for both")
    sellout_type: Optional[str] = None
    """
    Sellout Type: 'sellout' for sales, 'return' for returns, null for both
    """


    # @ApiMember(Description="Type: 'consigned' or 'standard', null for both")
    type: Optional[str] = None
    """
    Type: 'consigned' or 'standard', null for both
    """


    # @ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)")
    warranty_extension_status_ids: Optional[List[int]] = None
    """
    Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)
    """


    # @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 ExportSellOut DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}