| POST | /customer/{brand}/export | Export Customer Data |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class ExportCustomer : SearchCustomer()
{
/**
* Export Request ID of the API Consumers
*/
@ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
var downloadRequestId:String? = null
}
open class SearchCustomer
{
/**
* Brand
*/
@ApiMember(Description="Brand", IsRequired=true)
var brand:String? = null
/**
* POS Legacy
*/
@ApiMember(Description="POS Legacy", IsRequired=true)
var posCodes:ArrayList<String> = ArrayList<String>()
/**
* Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'
*/
@ApiMember(Description="Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'")
var searchKey:String? = null
/**
* Search by phone number - exact match
*/
@ApiMember(Description="Search by phone number - exact match")
var phoneNumber:String? = null
/**
* Search by email address - exact match
*/
@ApiMember(Description="Search by email address - exact match")
var email:String? = null
/**
* Values can be 'it', 'en' etc.
*/
@ApiMember(Description="Values can be 'it', 'en' etc.")
var locationCountryIds:ArrayList<String> = ArrayList<String>()
/**
* Client Spending From e.g. '100'
*/
@ApiMember(Description="Client Spending From e.g. '100'")
var clientSpendingFrom:Double? = null
/**
* Client Spending To e.g. '50000'
*/
@ApiMember(Description="Client Spending To e.g. '50000'")
var clientSpendingTo:Double? = null
/**
* Customer Creation Date From e.g. '2022-01-01'
*/
@ApiMember(Description="Customer Creation Date From e.g. '2022-01-01'")
var creationDateFrom:Date? = null
/**
* Customer Creation Date To e.g. '2023-11-01'
*/
@ApiMember(Description="Customer Creation Date To e.g. '2023-11-01'")
var creationDateTo:Date? = null
/**
* Transaction Date From e.g. '2022-01-01'
*/
@ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
var transactionDateFrom:Date? = null
/**
* Transaction Date To e.g. '2023-11-01'
*/
@ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
var transactionDateTo:Date? = null
/**
* Values can be 'true' or 'false'
*/
@ApiMember(Description="Values can be 'true' or 'false'")
var canBeContactedByMaison:Boolean? = null
/**
* 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="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'")
var birthdateMonths:ArrayList<Int> = ArrayList<Int>()
/**
* Customer interest filter
*/
@ApiMember(Description="Customer interest filter")
var interests:ArrayList<GetCustomerInterest> = ArrayList<GetCustomerInterest>()
/**
* Customer hobby filter
*/
@ApiMember(Description="Customer hobby filter")
var hobbies:ArrayList<GetCustomerHobby> = ArrayList<GetCustomerHobby>()
/**
* Customer product collection filter
*/
@ApiMember(Description="Customer product collection filter")
var productCollections:ArrayList<GetCustomerProductCollection> = ArrayList<GetCustomerProductCollection>()
/**
* Customer Status e.g. 'Prospect', 'Client'
*/
@ApiMember(Description="Customer Status e.g. 'Prospect', 'Client'")
var customerStatus:ArrayList<String> = ArrayList<String>()
/**
* List of BoosterCustomerIds, e.g. 1234567,1231231,12323423
*/
@ApiMember(Description="List of BoosterCustomerIds, e.g. 1234567,1231231,12323423")
var boosterCustomerIds:ArrayList<Int> = ArrayList<Int>()
/**
* Values can be 'true' or 'false'
*/
@ApiMember(Description="Values can be 'true' or 'false'")
var hasSapCrmError:Boolean? = null
/**
* Product Categories
*/
@ApiMember(Description="Product Categories")
var productCategories:ArrayList<ProductCategory> = ArrayList<ProductCategory>()
/**
* Sale Reprentative Emails
*/
@ApiMember(Description="Sale Reprentative Emails")
var saleRepresentativeEmails:ArrayList<String> = ArrayList<String>()
}
open class GetCustomerInterest
{
/**
* Interest description
*/
@ApiMember(Description="Interest description", IsRequired=true)
var interest:String? = null
/**
* SAP Interest ID, e.g. 'CA-1'
*/
@ApiMember(Description="SAP Interest ID, e.g. 'CA-1'", IsRequired=true)
var sapInterestId:String? = null
}
open class GetCustomerHobby
{
/**
* Hobby description
*/
@ApiMember(Description="Hobby description")
var hobby:String? = null
/**
* SAP Hobby ID, e.g. 'ART'
*/
@ApiMember(Description="SAP Hobby ID, e.g. 'ART'")
var sapHobbyId:String? = null
}
open class GetCustomerProductCollection
{
/**
* Product Collection description
*/
@ApiMember(Description="Product Collection description", IsRequired=true)
var productCollection:String? = null
/**
* SAP ProductCollection ID, e.g. 'CA-1'
*/
@ApiMember(Description="SAP ProductCollection ID, e.g. 'CA-1'", IsRequired=true)
var sapProductCollectionId:String? = null
}
open class ProductCategory
{
/**
* Brand Category ID
*/
@ApiMember(Description="Brand Category ID")
var brandCategoryId:String? = null
/**
* Grand Category ID
*/
@ApiMember(Description="Grand Category ID", IsRequired=true)
var grandCategoryId:String? = null
/**
* Master Category ID
*/
@ApiMember(Description="Master Category ID")
var masterCategoryId:String? = null
/**
* Category ID
*/
@ApiMember(Description="Category ID")
var categoryId:String? = null
/**
* Sub Category ID
*/
@ApiMember(Description="Sub Category ID")
var subCategoryId:String? = null
}
open class ExportCustomerResponse
{
/**
* Unique Identifier of the Export Request created
*/
@ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
var asyncTaskId:UUID? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"downloadRequestId":"String","brand":"String","posCodes":["String"],"searchKey":"String","phoneNumber":"String","email":"String","locationCountryIds":["String"],"clientSpendingFrom":0,"clientSpendingTo":0,"creationDateFrom":"\/Date(-62135596800000-0000)\/","creationDateTo":"\/Date(-62135596800000-0000)\/","transactionDateFrom":"\/Date(-62135596800000-0000)\/","transactionDateTo":"\/Date(-62135596800000-0000)\/","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/csv
Content-Length: length
{"asyncTaskId":"00000000000000000000000000000000"}