Richemont.Booster2.PublicApi

<back to all web services

ExportOrder

Requires Authentication
The following routes are available for this service:
POST/purchase/{brand}/exportExport Order Data
namespace Richemont.Booster2.PublicApi.Common.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ExportOrderResponse() = 
        ///<summary>
        ///Unique Identifier of the Export Request created
        ///</summary>
        [<ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)>]
        member val asyncTaskId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type ProductCategory() = 
        ///<summary>
        ///Brand Category ID
        ///</summary>
        [<ApiMember(Description="Brand Category ID")>]
        member val brandCategoryId:String = null with get,set

        ///<summary>
        ///Grand Category ID
        ///</summary>
        [<ApiMember(Description="Grand Category ID", IsRequired=true)>]
        member val grandCategoryId:String = null with get,set

        ///<summary>
        ///Master Category ID
        ///</summary>
        [<ApiMember(Description="Master Category ID")>]
        member val masterCategoryId:String = null with get,set

        ///<summary>
        ///Category ID
        ///</summary>
        [<ApiMember(Description="Category ID")>]
        member val categoryId:String = null with get,set

        ///<summary>
        ///Sub Category ID
        ///</summary>
        [<ApiMember(Description="Sub Category ID")>]
        member val subCategoryId:String = null with get,set

    [<AllowNullLiteral>]
    type ExportOrder() = 
        ///<summary>
        ///Brand Trigram, e.g. CAR, IWC
        ///</summary>
        [<ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///POS Legacy
        ///</summary>
        [<ApiMember(Description="POS Legacy", IsRequired=true)>]
        member val posCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Date To
        ///</summary>
        [<ApiMember(Description="Date To")>]
        member val dateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Date From
        ///</summary>
        [<ApiMember(Description="Date From")>]
        member val dateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)
        ///</summary>
        [<ApiMember(Description="Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)")>]
        member val status:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Reason Code e.g. Y00, Y06
        ///</summary>
        [<ApiMember(Description="Reason Code e.g. Y00, Y06")>]
        member val reasonCode:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Product Categories
        ///</summary>
        [<ApiMember(Description="Product Categories")>]
        member val productCategories:ResizeArray<ProductCategory> = new ResizeArray<ProductCategory>() with get,set

        ///<summary>
        ///Final Ship To Pos Codes
        ///</summary>
        [<ApiMember(Description="Final Ship To Pos Codes")>]
        member val finalShipTo:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Export Request ID of the API Consumers
        ///</summary>
        [<ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)>]
        member val downloadRequestId:String = null with get,set

F# ExportOrder DTOs

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

<ExportOrder 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>
  <finalShipTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </finalShipTo>
  <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>
  <reasonCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </reasonCode>
  <status xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </status>
</ExportOrder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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