Richemont.Booster2.PublicApi

<back to all web services

CreateOrderV2

Requires Authentication
The following routes are available for this service:
POST/purchase/v2Create Order

export class StrapItem
{
    /** @description Article reference */
    // @ApiMember(Description="Article reference")
    public speakingArticleCode: string;

    /** @description Buckle type Description */
    // @ApiMember(Description="Buckle type Description")
    public buckleTypeDescription: string;

    /** @description Buckle type */
    // @ApiMember(Description="Buckle type")
    public buckleTypeCode: string;

    /** @description watch 6 Length */
    // @ApiMember(Description="watch 6 Length")
    public watch6Length?: number;

    /** @description watch 12 Length */
    // @ApiMember(Description="watch 12 Length")
    public watch12Length?: number;

    /** @description Article Material Code */
    // @ApiMember(Description="Article Material Code")
    public materialCode: string;

    /** @description Article Material Description */
    // @ApiMember(Description="Article Material Description")
    public materialDescription: string;

    /** @description Article Color Code */
    // @ApiMember(Description="Article Color Code")
    public colorCode: string;

    /** @description Article Color Description */
    // @ApiMember(Description="Article Color Description")
    public colorDescription: string;

    /** @description Buckle Witdh */
    // @ApiMember(Description="Buckle Witdh")
    public buckleWidth: string;

    /** @description Article Lining Code */
    // @ApiMember(Description="Article Lining Code")
    public liningCode: string;

    /** @description Article Lining Description */
    // @ApiMember(Description="Article Lining Description")
    public liningDescription: string;

    /** @description Article Stitching Code */
    // @ApiMember(Description="Article Stitching Code")
    public stitchingCode: string;

    /** @description Article Stitching Description */
    // @ApiMember(Description="Article Stitching Description")
    public stitchingDescription: string;

    /** @description Article Edge Code */
    // @ApiMember(Description="Article Edge Code")
    public edgeCode: string;

    /** @description Article Edge Description */
    // @ApiMember(Description="Article Edge Description")
    public edgeDescription: string;

    /** @description Article Padding Code */
    // @ApiMember(Description="Article Padding Code")
    public paddingCode: string;

    /** @description Article Padding Description */
    // @ApiMember(Description="Article Padding Description")
    public paddingDescription: string;

    /** @description Article Speciality Code */
    // @ApiMember(Description="Article Speciality Code")
    public specialtyCode: string;

    /** @description Article Speciality Description */
    // @ApiMember(Description="Article Speciality Description")
    public specialtyDescription: string;

    /** @description Nuancier Code */
    // @ApiMember(Description="Nuancier Code")
    public nuancierCode: string;

    /** @description Strap Vip Order */
    // @ApiMember(Description="Strap Vip Order")
    public isStrapVipOrder?: boolean;

    public constructor(init?: Partial<StrapItem>) { (Object as any).assign(this, init); }
}

export class CreateOrderItemRequestV2
{
    /** @description Line Number */
    // @ApiMember(Description="Line Number", IsRequired=true)
    public lineNumber: number;

    /** @description Reference ID of the article/product, e.g. 'CRWB520003' */
    // @ApiMember(Description="Reference ID of the article/product, e.g. 'CRWB520003'", IsRequired=true)
    public articleCode: string;

    /** @description Desired quantity of the article */
    // @ApiMember(Description="Desired quantity of the article", IsRequired=true)
    public quantity: number;

    /** @description Requested Delivery Date of the Item, e.g. '2020-12-30' */
    // @ApiMember(Description="Requested Delivery Date of the Item, e.g. '2020-12-30'")
    public requestedDeliveryDate?: string;

    /** @description Strap definition */
    // @ApiMember(Description="Strap definition")
    public strap: StrapItem;

    /** @description Purchase order type, e.g. 'WCFS', null. Null for ordinary order */
    // @ApiMember(Description="Purchase order type, e.g. 'WCFS', null. Null for ordinary order")
    public orderType: string;

    /** @description DeliveryPlantId of item, e.g.: CHD6 */
    // @ApiMember(Description="DeliveryPlantId of item, e.g.: CHD6")
    public deliveryPlantId: string;

    /** @description Reason Code */
    // @ApiMember(Description="Reason Code", IsRequired=true)
    public reasonCode: string;

    /** @description Order Delivery Priority,  e.g.: 10, 20, 30, 40, 50 */
    // @ApiMember(Description="Order Delivery Priority,  e.g.: 10, 20, 30, 40, 50")
    public orderDeliveryPriority?: number;

    /** @description Buckle Summary, can be get from order simulation */
    // @ApiMember(Description="Buckle Summary, can be get from order simulation")
    public buckleSummary: string;

    /** @description Material Summary, can be get from order simulation */
    // @ApiMember(Description="Material Summary, can be get from order simulation")
    public materialSummary: string;

    /** @description Content Summary, can be get from order simulation */
    // @ApiMember(Description="Content Summary, can be get from order simulation")
    public contentSummary: string;

    /** @description Strap Summary, can be get from order simulation */
    // @ApiMember(Description="Strap Summary, can be get from order simulation")
    public strapSummary: string;

    public constructor(init?: Partial<CreateOrderItemRequestV2>) { (Object as any).assign(this, init); }
}

export class SplittedOrder
{
    /** @description Ship To Pos Code */
    // @ApiMember(Description="Ship To Pos Code", IsRequired=true)
    public shipToId: string;

    /** @description Final Ship To Pos Code */
    // @ApiMember(Description="Final Ship To Pos Code")
    public finalShipToId: string;

    /** @description Bill To Pos Code */
    // @ApiMember(Description="Bill To Pos Code", IsRequired=true)
    public billToId: string;

    /** @description Sold To Pos Code */
    // @ApiMember(Description="Sold To Pos Code", IsRequired=true)
    public soldToId: string;

    /** @description Sales Representative Code */
    // @ApiMember(Description="Sales Representative Code")
    public salesRepresentativeId: string;

    /** @description List of Articles to be created */
    // @ApiMember(Description="List of Articles to be created", IsRequired=true)
    public orderItems: CreateOrderItemRequestV2[];

    public constructor(init?: Partial<SplittedOrder>) { (Object as any).assign(this, init); }
}

export class EndCustomerDetails
{
    /** @description Title of the end Customer, e.g. 'MR', 'MRS'. */
    // @ApiMember(Description="Title of the end Customer, e.g. 'MR', 'MRS'.")
    public title: string;

    /** @description First Name of the end Customer */
    // @ApiMember(Description="First Name of the end Customer", IsRequired=true)
    public firstName: string;

    /** @description Last Name of the end Customer */
    // @ApiMember(Description="Last Name of the end Customer", IsRequired=true)
    public lastName: string;

    /** @description Email of the end Customer */
    // @ApiMember(Description="Email of the end Customer")
    public email: string;

    /** @description Phone number of the end Customer, e.g. '0032477123456'.  */
    // @ApiMember(Description="Phone number of the end Customer, e.g. '0032477123456'. ")
    public phone: string;

    /** @description Countr code in the shipping address, e.g. 'BE' (ISO Code) */
    // @ApiMember(Description="Countr code in the shipping address, e.g. 'BE' (ISO Code)", IsRequired=true)
    public country: string;

    /** @description City name in the shipping address */
    // @ApiMember(Description="City name in the shipping address", IsRequired=true)
    public city: string;

    /** @description Street name in the shipping address */
    // @ApiMember(Description="Street name in the shipping address", IsRequired=true)
    public street: string;

    /** @description House number in the shipping address */
    // @ApiMember(Description="House number in the shipping address")
    public houseNumber: string;

    /** @description Building number in the shipping address */
    // @ApiMember(Description="Building number in the shipping address")
    public building: string;

    /** @description Postal code in the shipping address */
    // @ApiMember(Description="Postal code in the shipping address")
    public postalCode: string;

    /** @description Region code in the shipping address, e.g. 'VL' (ISO Code) */
    // @ApiMember(Description="Region code in the shipping address, e.g. 'VL' (ISO Code)")
    public region: string;

    /** @description District name in the shipping address */
    // @ApiMember(Description="District name in the shipping address")
    public district: string;

    /** @description Additional Info number to the shipping address */
    // @ApiMember(Description="Additional Info number to the shipping address")
    public additionalInfo: string;

    public constructor(init?: Partial<EndCustomerDetails>) { (Object as any).assign(this, init); }
}

export class CreateOrderV2
{
    /** @description Purchase order ID, total length-max with x-booster-App header: 99 */
    // @ApiMember(Description="Purchase order ID, total length-max with x-booster-App header: 99", IsRequired=true)
    public orderId: string;

    /** @description Global Pos Code for the intended Order e.g. ES100:102048 */
    // @ApiMember(Description="Global Pos Code for the intended Order e.g. ES100:102048", IsRequired=true)
    public posCode: string;

    /** @description Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc. */
    // @ApiMember(Description="Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.", IsRequired=true)
    public brand: string;

    /** @description Additional Notes regarding the Order */
    // @ApiMember(Description="Additional Notes regarding the Order")
    public notes: string;

    /** @description Customer Reference */
    // @ApiMember(Description="Customer Reference")
    public customerReference: string;

    /** @description Customer Reference for Consignment Order */
    // @ApiMember(Description="Customer Reference for Consignment Order")
    public customerReferenceConsignment: string;

    /** @description Purchase order date, e.g. '2020-12-31' */
    // @ApiMember(Description="Purchase order date, e.g. '2020-12-31'")
    public orderDate?: string;

    /** @description Details of the end Customer */
    // @ApiMember(Description="Details of the end Customer")
    public splittedOrders: SplittedOrder[];

    /** @description Booster1 ID of the end Customer */
    // @ApiMember(Description="Booster1 ID of the end Customer")
    public endCustomerBooster1Id: string;

    /** @description Details of the end Customer */
    // @ApiMember(Description="Details of the end Customer")
    public endCustomerDetails: EndCustomerDetails;

    public constructor(init?: Partial<CreateOrderV2>) { (Object as any).assign(this, init); }
}

TypeScript 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/" />