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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Purchase.ServiceModel;
using Richemont.Booster2.PublicApi.Common.ServiceModel;

namespace Richemont.Booster2.PublicApi.Common.ServiceModel
{
    public partial class ProductCategory
    {
        ///<summary>
        ///Brand Category ID
        ///</summary>
        [ApiMember(Description="Brand Category ID")]
        public virtual string brandCategoryId { get; set; }

        ///<summary>
        ///Grand Category ID
        ///</summary>
        [ApiMember(Description="Grand Category ID", IsRequired=true)]
        public virtual string grandCategoryId { get; set; }

        ///<summary>
        ///Master Category ID
        ///</summary>
        [ApiMember(Description="Master Category ID")]
        public virtual string masterCategoryId { get; set; }

        ///<summary>
        ///Category ID
        ///</summary>
        [ApiMember(Description="Category ID")]
        public virtual string categoryId { get; set; }

        ///<summary>
        ///Sub Category ID
        ///</summary>
        [ApiMember(Description="Sub Category ID")]
        public virtual string subCategoryId { get; set; }
    }

}

namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel
{
    public partial class ExportOrder
    {
        public ExportOrder()
        {
            posCodes = new List<string>{};
            status = new List<string>{};
            reasonCode = new List<string>{};
            productCategories = new List<ProductCategory>{};
            finalShipTo = new List<string>{};
        }

        ///<summary>
        ///Brand Trigram, e.g. CAR, IWC
        ///</summary>
        [ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///POS Legacy
        ///</summary>
        [ApiMember(Description="POS Legacy", IsRequired=true)]
        public virtual List<string> posCodes { get; set; }

        ///<summary>
        ///Date To
        ///</summary>
        [ApiMember(Description="Date To")]
        public virtual DateTime? dateTo { get; set; }

        ///<summary>
        ///Date From
        ///</summary>
        [ApiMember(Description="Date From")]
        public virtual DateTime? dateFrom { 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)")]
        public virtual List<string> status { get; set; }

        ///<summary>
        ///Reason Code e.g. Y00, Y06
        ///</summary>
        [ApiMember(Description="Reason Code e.g. Y00, Y06")]
        public virtual List<string> reasonCode { get; set; }

        ///<summary>
        ///Product Categories
        ///</summary>
        [ApiMember(Description="Product Categories")]
        public virtual List<ProductCategory> productCategories { get; set; }

        ///<summary>
        ///Final Ship To Pos Codes
        ///</summary>
        [ApiMember(Description="Final Ship To Pos Codes")]
        public virtual List<string> finalShipTo { get; set; }

        ///<summary>
        ///Export Request ID of the API Consumers
        ///</summary>
        [ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)]
        public virtual string downloadRequestId { get; set; }
    }

    public partial class ExportOrderResponse
    {
        ///<summary>
        ///Unique Identifier of the Export Request created
        ///</summary>
        [ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)]
        public virtual Guid asyncTaskId { get; set; }
    }

}

C# 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>