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

<ExportInvoice 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>
  <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>
  <reasonCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </reasonCodes>
</ExportInvoice>

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

<ExportInvoiceResponse 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>
</ExportInvoiceResponse>