Richemont.Booster2.PublicApi

<back to all web services

ExportInvoice

Requires Authentication
The following routes are available for this service:
POST/invoice/{brand}/exportExport Invoice DataCreate a invoice in a POS you are authorised for
ExportInvoice Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesBrand Trigram, e.g. CAR, IWC
posCodesbodyList<string>YesPos Legacy IDs / Codes
dateTobodyDateTime?NoDate To
dateFrombodyDateTime?NoDate From
reasonCodesbodyList<string>NoReason Code e.g. Y00, Y06
productCategoriesbodyList<ProductCategory>NoProduct Categories
downloadRequestIdbodystringYesExport Request ID of the API Consumers
ProductCategory Parameters:
NameParameterData TypeRequiredDescription
brandCategoryIdformstringNoBrand Category ID
grandCategoryIdformstringYesGrand Category ID
masterCategoryIdformstringNoMaster Category ID
categoryIdformstringNoCategory ID
subCategoryIdformstringNoSub Category ID
ExportInvoiceResponse Parameters:
NameParameterData TypeRequiredDescription
asyncTaskIdformGuidYesUnique Identifier of the Export Request created

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 /invoice/{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)\/","reasonCodes":["String"],"productCategories":[{"brandCategoryId":"String","grandCategoryId":"String","masterCategoryId":"String","categoryId":"String","subCategoryId":"String"}],"downloadRequestId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}