| POST | /customer/{brand}/export | Export Customer 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 GetCustomerInterest:
# @ApiMember(Description="Interest description", IsRequired=true)
interest: Optional[str] = None
"""
Interest description
"""
# @ApiMember(Description="SAP Interest ID, e.g. 'CA-1'", IsRequired=true)
sap_interest_id: Optional[str] = None
"""
SAP Interest ID, e.g. 'CA-1'
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerHobby:
# @ApiMember(Description="Hobby description")
hobby: Optional[str] = None
"""
Hobby description
"""
# @ApiMember(Description="SAP Hobby ID, e.g. 'ART'")
sap_hobby_id: Optional[str] = None
"""
SAP Hobby ID, e.g. 'ART'
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerProductCollection:
# @ApiMember(Description="Product Collection description", IsRequired=true)
product_collection: Optional[str] = None
"""
Product Collection description
"""
# @ApiMember(Description="SAP ProductCollection ID, e.g. 'CA-1'", IsRequired=true)
sap_product_collection_id: Optional[str] = None
"""
SAP ProductCollection ID, e.g. 'CA-1'
"""
@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 SearchCustomer:
# @ApiMember(Description="Brand", IsRequired=true)
brand: Optional[str] = None
"""
Brand
"""
# @ApiMember(Description="POS Legacy", IsRequired=true)
pos_codes: Optional[List[str]] = None
"""
POS Legacy
"""
# @ApiMember(Description="Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'")
search_key: Optional[str] = None
"""
Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'
"""
# @ApiMember(Description="Search by phone number - exact match")
phone_number: Optional[str] = None
"""
Search by phone number - exact match
"""
# @ApiMember(Description="Search by email address - exact match")
email: Optional[str] = None
"""
Search by email address - exact match
"""
# @ApiMember(Description="Values can be 'it', 'en' etc.")
location_country_ids: Optional[List[str]] = None
"""
Values can be 'it', 'en' etc.
"""
# @ApiMember(Description="Client Spending From e.g. '100'")
client_spending_from: Optional[float] = None
"""
Client Spending From e.g. '100'
"""
# @ApiMember(Description="Client Spending To e.g. '50000'")
client_spending_to: Optional[float] = None
"""
Client Spending To e.g. '50000'
"""
# @ApiMember(Description="Customer Creation Date From e.g. '2022-01-01'")
creation_date_from: Optional[datetime.datetime] = None
"""
Customer Creation Date From e.g. '2022-01-01'
"""
# @ApiMember(Description="Customer Creation Date To e.g. '2023-11-01'")
creation_date_to: Optional[datetime.datetime] = None
"""
Customer Creation Date To e.g. '2023-11-01'
"""
# @ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
transaction_date_from: Optional[datetime.datetime] = None
"""
Transaction Date From e.g. '2022-01-01'
"""
# @ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
transaction_date_to: Optional[datetime.datetime] = None
"""
Transaction Date To e.g. '2023-11-01'
"""
# @ApiMember(Description="Values can be 'true' or 'false'")
can_be_contacted_by_maison: Optional[bool] = None
"""
Values can be 'true' or 'false'
"""
# @ApiMember(Description="Values can be 1 for 'January', 2 for 'February', 3 for 'March', 4 for 'April', 5 for 'May', 6 for 'June', 7 for 'July', 8 for 'August', 9 for 'September', 10 for 'October', 11 for 'November', 12 for 'December'")
birthdate_months: Optional[List[int]] = None
"""
Values can be 1 for 'January', 2 for 'February', 3 for 'March', 4 for 'April', 5 for 'May', 6 for 'June', 7 for 'July', 8 for 'August', 9 for 'September', 10 for 'October', 11 for 'November', 12 for 'December'
"""
# @ApiMember(Description="Customer interest filter")
interests: Optional[List[GetCustomerInterest]] = None
"""
Customer interest filter
"""
# @ApiMember(Description="Customer hobby filter")
hobbies: Optional[List[GetCustomerHobby]] = None
"""
Customer hobby filter
"""
# @ApiMember(Description="Customer product collection filter")
product_collections: Optional[List[GetCustomerProductCollection]] = None
"""
Customer product collection filter
"""
# @ApiMember(Description="Customer Status e.g. 'Prospect', 'Client'")
customer_status: Optional[List[str]] = None
"""
Customer Status e.g. 'Prospect', 'Client'
"""
# @ApiMember(Description="List of BoosterCustomerIds, e.g. 1234567,1231231,12323423")
booster_customer_ids: Optional[List[int]] = None
"""
List of BoosterCustomerIds, e.g. 1234567,1231231,12323423
"""
# @ApiMember(Description="Values can be 'true' or 'false'")
has_sap_crm_error: Optional[bool] = None
"""
Values can be 'true' or 'false'
"""
# @ApiMember(Description="Product Categories")
product_categories: Optional[List[ProductCategory]] = None
"""
Product Categories
"""
# @ApiMember(Description="Sale Reprentative Emails")
sale_representative_emails: Optional[List[str]] = None
"""
Sale Reprentative Emails
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExportCustomerResponse:
# @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 ExportCustomer(SearchCustomer):
# @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
download_request_id: Optional[str] = None
"""
Export Request ID of the API Consumers
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customer/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
downloadRequestId: String,
brand: String,
posCodes:
[
String
],
searchKey: String,
phoneNumber: String,
email: String,
locationCountryIds:
[
String
],
clientSpendingFrom: 0,
clientSpendingTo: 0,
creationDateFrom: 0001-01-01,
creationDateTo: 0001-01-01,
transactionDateFrom: 0001-01-01,
transactionDateTo: 0001-01-01,
canBeContactedByMaison: False,
birthdateMonths:
[
0
],
interests:
[
{
interest: String,
sapInterestId: String
}
],
hobbies:
[
{
hobby: String,
sapHobbyId: String
}
],
productCollections:
[
{
productCollection: String,
sapProductCollectionId: String
}
],
customerStatus:
[
String
],
boosterCustomerIds:
[
0
],
hasSapCrmError: False,
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
saleRepresentativeEmails:
[
String
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}