Richemont.Booster2.PublicApi

<back to all web services

CreateOrderV2

Requires Authentication
The following routes are available for this service:
POST/purchase/v2Create Order
namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel

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

    [<AllowNullLiteral>]
    type StrapItem() = 
        ///<summary>
        ///Article reference
        ///</summary>
        [<ApiMember(Description="Article reference")>]
        member val speakingArticleCode:String = null with get,set

        ///<summary>
        ///Buckle type Description
        ///</summary>
        [<ApiMember(Description="Buckle type Description")>]
        member val buckleTypeDescription:String = null with get,set

        ///<summary>
        ///Buckle type
        ///</summary>
        [<ApiMember(Description="Buckle type")>]
        member val buckleTypeCode:String = null with get,set

        ///<summary>
        ///watch 6 Length
        ///</summary>
        [<ApiMember(Description="watch 6 Length")>]
        member val watch6Length:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///watch 12 Length
        ///</summary>
        [<ApiMember(Description="watch 12 Length")>]
        member val watch12Length:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Article Material Code
        ///</summary>
        [<ApiMember(Description="Article Material Code")>]
        member val materialCode:String = null with get,set

        ///<summary>
        ///Article Material Description
        ///</summary>
        [<ApiMember(Description="Article Material Description")>]
        member val materialDescription:String = null with get,set

        ///<summary>
        ///Article Color Code
        ///</summary>
        [<ApiMember(Description="Article Color Code")>]
        member val colorCode:String = null with get,set

        ///<summary>
        ///Article Color Description
        ///</summary>
        [<ApiMember(Description="Article Color Description")>]
        member val colorDescription:String = null with get,set

        ///<summary>
        ///Buckle Witdh
        ///</summary>
        [<ApiMember(Description="Buckle Witdh")>]
        member val buckleWidth:String = null with get,set

        ///<summary>
        ///Article Lining Code
        ///</summary>
        [<ApiMember(Description="Article Lining Code")>]
        member val liningCode:String = null with get,set

        ///<summary>
        ///Article Lining Description
        ///</summary>
        [<ApiMember(Description="Article Lining Description")>]
        member val liningDescription:String = null with get,set

        ///<summary>
        ///Article Stitching Code
        ///</summary>
        [<ApiMember(Description="Article Stitching Code")>]
        member val stitchingCode:String = null with get,set

        ///<summary>
        ///Article Stitching Description
        ///</summary>
        [<ApiMember(Description="Article Stitching Description")>]
        member val stitchingDescription:String = null with get,set

        ///<summary>
        ///Article Edge Code
        ///</summary>
        [<ApiMember(Description="Article Edge Code")>]
        member val edgeCode:String = null with get,set

        ///<summary>
        ///Article Edge Description
        ///</summary>
        [<ApiMember(Description="Article Edge Description")>]
        member val edgeDescription:String = null with get,set

        ///<summary>
        ///Article Padding Code
        ///</summary>
        [<ApiMember(Description="Article Padding Code")>]
        member val paddingCode:String = null with get,set

        ///<summary>
        ///Article Padding Description
        ///</summary>
        [<ApiMember(Description="Article Padding Description")>]
        member val paddingDescription:String = null with get,set

        ///<summary>
        ///Article Speciality Code
        ///</summary>
        [<ApiMember(Description="Article Speciality Code")>]
        member val specialtyCode:String = null with get,set

        ///<summary>
        ///Article Speciality Description
        ///</summary>
        [<ApiMember(Description="Article Speciality Description")>]
        member val specialtyDescription:String = null with get,set

        ///<summary>
        ///Nuancier Code
        ///</summary>
        [<ApiMember(Description="Nuancier Code")>]
        member val nuancierCode:String = null with get,set

        ///<summary>
        ///Strap Vip Order
        ///</summary>
        [<ApiMember(Description="Strap Vip Order")>]
        member val isStrapVipOrder:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type CreateOrderItemRequestV2() = 
        ///<summary>
        ///Line Number
        ///</summary>
        [<ApiMember(Description="Line Number", IsRequired=true)>]
        member val lineNumber:Int32 = new Int32() with get,set

        ///<summary>
        ///Reference ID of the article/product, e.g. 'CRWB520003'
        ///</summary>
        [<ApiMember(Description="Reference ID of the article/product, e.g. 'CRWB520003'", IsRequired=true)>]
        member val articleCode:String = null with get,set

        ///<summary>
        ///Desired quantity of the article
        ///</summary>
        [<ApiMember(Description="Desired quantity of the article", IsRequired=true)>]
        member val quantity:Int32 = new Int32() with get,set

        ///<summary>
        ///Requested Delivery Date of the Item, e.g. '2020-12-30'
        ///</summary>
        [<ApiMember(Description="Requested Delivery Date of the Item, e.g. '2020-12-30'")>]
        member val requestedDeliveryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Strap definition
        ///</summary>
        [<ApiMember(Description="Strap definition")>]
        member val strap:StrapItem = null with get,set

        ///<summary>
        ///Purchase order type, e.g. 'WCFS', null. Null for ordinary order
        ///</summary>
        [<ApiMember(Description="Purchase order type, e.g. 'WCFS', null. Null for ordinary order")>]
        member val orderType:String = null with get,set

        ///<summary>
        ///DeliveryPlantId of item, e.g.: CHD6
        ///</summary>
        [<ApiMember(Description="DeliveryPlantId of item, e.g.: CHD6")>]
        member val deliveryPlantId:String = null with get,set

        ///<summary>
        ///Reason Code
        ///</summary>
        [<ApiMember(Description="Reason Code", IsRequired=true)>]
        member val reasonCode:String = null with get,set

        ///<summary>
        ///Order Delivery Priority,  e.g.: 10, 20, 30, 40, 50
        ///</summary>
        [<ApiMember(Description="Order Delivery Priority,  e.g.: 10, 20, 30, 40, 50")>]
        member val orderDeliveryPriority:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Buckle Summary, can be get from order simulation
        ///</summary>
        [<ApiMember(Description="Buckle Summary, can be get from order simulation")>]
        member val buckleSummary:String = null with get,set

        ///<summary>
        ///Material Summary, can be get from order simulation
        ///</summary>
        [<ApiMember(Description="Material Summary, can be get from order simulation")>]
        member val materialSummary:String = null with get,set

        ///<summary>
        ///Content Summary, can be get from order simulation
        ///</summary>
        [<ApiMember(Description="Content Summary, can be get from order simulation")>]
        member val contentSummary:String = null with get,set

        ///<summary>
        ///Strap Summary, can be get from order simulation
        ///</summary>
        [<ApiMember(Description="Strap Summary, can be get from order simulation")>]
        member val strapSummary:String = null with get,set

    [<AllowNullLiteral>]
    type SplittedOrder() = 
        ///<summary>
        ///Ship To Pos Code
        ///</summary>
        [<ApiMember(Description="Ship To Pos Code", IsRequired=true)>]
        member val shipToId:String = null with get,set

        ///<summary>
        ///Final Ship To Pos Code
        ///</summary>
        [<ApiMember(Description="Final Ship To Pos Code")>]
        member val finalShipToId:String = null with get,set

        ///<summary>
        ///Bill To Pos Code
        ///</summary>
        [<ApiMember(Description="Bill To Pos Code", IsRequired=true)>]
        member val billToId:String = null with get,set

        ///<summary>
        ///Sold To Pos Code
        ///</summary>
        [<ApiMember(Description="Sold To Pos Code", IsRequired=true)>]
        member val soldToId:String = null with get,set

        ///<summary>
        ///Sales Representative Code
        ///</summary>
        [<ApiMember(Description="Sales Representative Code")>]
        member val salesRepresentativeId:String = null with get,set

        ///<summary>
        ///List of Articles to be created
        ///</summary>
        [<ApiMember(Description="List of Articles to be created", IsRequired=true)>]
        member val orderItems:ResizeArray<CreateOrderItemRequestV2> = new ResizeArray<CreateOrderItemRequestV2>() with get,set

    [<AllowNullLiteral>]
    type EndCustomerDetails() = 
        ///<summary>
        ///Title of the end Customer, e.g. 'MR', 'MRS'.
        ///</summary>
        [<ApiMember(Description="Title of the end Customer, e.g. 'MR', 'MRS'.")>]
        member val title:String = null with get,set

        ///<summary>
        ///First Name of the end Customer
        ///</summary>
        [<ApiMember(Description="First Name of the end Customer", IsRequired=true)>]
        member val firstName:String = null with get,set

        ///<summary>
        ///Last Name of the end Customer
        ///</summary>
        [<ApiMember(Description="Last Name of the end Customer", IsRequired=true)>]
        member val lastName:String = null with get,set

        ///<summary>
        ///Email of the end Customer
        ///</summary>
        [<ApiMember(Description="Email of the end Customer")>]
        member val email:String = null with get,set

        ///<summary>
        ///Phone number of the end Customer, e.g. '0032477123456'. 
        ///</summary>
        [<ApiMember(Description="Phone number of the end Customer, e.g. '0032477123456'. ")>]
        member val phone:String = null with get,set

        ///<summary>
        ///Countr code in the shipping address, e.g. 'BE' (ISO Code)
        ///</summary>
        [<ApiMember(Description="Countr code in the shipping address, e.g. 'BE' (ISO Code)", IsRequired=true)>]
        member val country:String = null with get,set

        ///<summary>
        ///City name in the shipping address
        ///</summary>
        [<ApiMember(Description="City name in the shipping address", IsRequired=true)>]
        member val city:String = null with get,set

        ///<summary>
        ///Street name in the shipping address
        ///</summary>
        [<ApiMember(Description="Street name in the shipping address", IsRequired=true)>]
        member val street:String = null with get,set

        ///<summary>
        ///House number in the shipping address
        ///</summary>
        [<ApiMember(Description="House number in the shipping address")>]
        member val houseNumber:String = null with get,set

        ///<summary>
        ///Building number in the shipping address
        ///</summary>
        [<ApiMember(Description="Building number in the shipping address")>]
        member val building:String = null with get,set

        ///<summary>
        ///Postal code in the shipping address
        ///</summary>
        [<ApiMember(Description="Postal code in the shipping address")>]
        member val postalCode:String = null with get,set

        ///<summary>
        ///Region code in the shipping address, e.g. 'VL' (ISO Code)
        ///</summary>
        [<ApiMember(Description="Region code in the shipping address, e.g. 'VL' (ISO Code)")>]
        member val region:String = null with get,set

        ///<summary>
        ///District name in the shipping address
        ///</summary>
        [<ApiMember(Description="District name in the shipping address")>]
        member val district:String = null with get,set

        ///<summary>
        ///Additional Info number to the shipping address
        ///</summary>
        [<ApiMember(Description="Additional Info number to the shipping address")>]
        member val additionalInfo:String = null with get,set

    [<AllowNullLiteral>]
    type CreateOrderV2() = 
        ///<summary>
        ///Purchase order ID, total length-max with x-booster-App header: 99
        ///</summary>
        [<ApiMember(Description="Purchase order ID, total length-max with x-booster-App header: 99", IsRequired=true)>]
        member val orderId:String = null with get,set

        ///<summary>
        ///Global Pos Code for the intended Order e.g. ES100:102048
        ///</summary>
        [<ApiMember(Description="Global Pos Code for the intended Order e.g. ES100:102048", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.
        ///</summary>
        [<ApiMember(Description="Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///Additional Notes regarding the Order
        ///</summary>
        [<ApiMember(Description="Additional Notes regarding the Order")>]
        member val notes:String = null with get,set

        ///<summary>
        ///Customer Reference
        ///</summary>
        [<ApiMember(Description="Customer Reference")>]
        member val customerReference:String = null with get,set

        ///<summary>
        ///Customer Reference for Consignment Order
        ///</summary>
        [<ApiMember(Description="Customer Reference for Consignment Order")>]
        member val customerReferenceConsignment:String = null with get,set

        ///<summary>
        ///Purchase order date, e.g. '2020-12-31'
        ///</summary>
        [<ApiMember(Description="Purchase order date, e.g. '2020-12-31'")>]
        member val orderDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Details of the end Customer
        ///</summary>
        [<ApiMember(Description="Details of the end Customer")>]
        member val SplittedOrders:ResizeArray<SplittedOrder> = new ResizeArray<SplittedOrder>() with get,set

        ///<summary>
        ///Booster1 ID of the end Customer
        ///</summary>
        [<ApiMember(Description="Booster1 ID of the end Customer")>]
        member val endCustomerBooster1Id:String = null with get,set

        ///<summary>
        ///Details of the end Customer
        ///</summary>
        [<ApiMember(Description="Details of the end Customer")>]
        member val endCustomerDetails:EndCustomerDetails = null with get,set

F# CreateOrderV2 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/v2 HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateOrderV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
  <SplittedOrders>
    <SplittedOrder>
      <billToId>String</billToId>
      <finalShipToId>String</finalShipToId>
      <orderItems>
        <CreateOrderItemRequestV2>
          <articleCode>String</articleCode>
          <buckleSummary>String</buckleSummary>
          <contentSummary>String</contentSummary>
          <deliveryPlantId>String</deliveryPlantId>
          <lineNumber>0</lineNumber>
          <materialSummary>String</materialSummary>
          <orderDeliveryPriority>0</orderDeliveryPriority>
          <orderType>String</orderType>
          <quantity>0</quantity>
          <reasonCode>String</reasonCode>
          <requestedDeliveryDate>0001-01-01T00:00:00</requestedDeliveryDate>
          <strap xmlns:d6p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel.SharedModels">
            <d6p1:buckleTypeCode>String</d6p1:buckleTypeCode>
            <d6p1:buckleTypeDescription>String</d6p1:buckleTypeDescription>
            <d6p1:buckleWidth>String</d6p1:buckleWidth>
            <d6p1:colorCode>String</d6p1:colorCode>
            <d6p1:colorDescription>String</d6p1:colorDescription>
            <d6p1:edgeCode>String</d6p1:edgeCode>
            <d6p1:edgeDescription>String</d6p1:edgeDescription>
            <d6p1:isStrapVipOrder>false</d6p1:isStrapVipOrder>
            <d6p1:liningCode>String</d6p1:liningCode>
            <d6p1:liningDescription>String</d6p1:liningDescription>
            <d6p1:materialCode>String</d6p1:materialCode>
            <d6p1:materialDescription>String</d6p1:materialDescription>
            <d6p1:nuancierCode>String</d6p1:nuancierCode>
            <d6p1:paddingCode>String</d6p1:paddingCode>
            <d6p1:paddingDescription>String</d6p1:paddingDescription>
            <d6p1:speakingArticleCode>String</d6p1:speakingArticleCode>
            <d6p1:specialtyCode>String</d6p1:specialtyCode>
            <d6p1:specialtyDescription>String</d6p1:specialtyDescription>
            <d6p1:stitchingCode>String</d6p1:stitchingCode>
            <d6p1:stitchingDescription>String</d6p1:stitchingDescription>
            <d6p1:watch12Length>0</d6p1:watch12Length>
            <d6p1:watch6Length>0</d6p1:watch6Length>
          </strap>
          <strapSummary>String</strapSummary>
        </CreateOrderItemRequestV2>
      </orderItems>
      <salesRepresentativeId>String</salesRepresentativeId>
      <shipToId>String</shipToId>
      <soldToId>String</soldToId>
    </SplittedOrder>
  </SplittedOrders>
  <brand>String</brand>
  <customerReference>String</customerReference>
  <customerReferenceConsignment>String</customerReferenceConsignment>
  <endCustomerBooster1Id>String</endCustomerBooster1Id>
  <endCustomerDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel.SharedModels">
    <d2p1:additionalInfo>String</d2p1:additionalInfo>
    <d2p1:building>String</d2p1:building>
    <d2p1:city>String</d2p1:city>
    <d2p1:country>String</d2p1:country>
    <d2p1:district>String</d2p1:district>
    <d2p1:email>String</d2p1:email>
    <d2p1:firstName>String</d2p1:firstName>
    <d2p1:houseNumber>String</d2p1:houseNumber>
    <d2p1:lastName>String</d2p1:lastName>
    <d2p1:phone>String</d2p1:phone>
    <d2p1:postalCode>String</d2p1:postalCode>
    <d2p1:region>String</d2p1:region>
    <d2p1:street>String</d2p1:street>
    <d2p1:title>String</d2p1:title>
  </endCustomerDetails>
  <notes>String</notes>
  <orderDate>0001-01-01T00:00:00</orderDate>
  <orderId>String</orderId>
  <posCode>String</posCode>
</CreateOrderV2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />