Richemont.Booster2.PublicApi

<back to all web services

CreateOrderV2

Requires Authentication
The following routes are available for this service:
POST/purchase/v2Create Order
"use strict";
export class StrapItem {
    /** @param {{speakingArticleCode?:string,buckleTypeDescription?:string,buckleTypeCode?:string,watch6Length?:number,watch12Length?:number,materialCode?:string,materialDescription?:string,colorCode?:string,colorDescription?:string,buckleWidth?:string,liningCode?:string,liningDescription?:string,stitchingCode?:string,stitchingDescription?:string,edgeCode?:string,edgeDescription?:string,paddingCode?:string,paddingDescription?:string,specialtyCode?:string,specialtyDescription?:string,nuancierCode?:string,isStrapVipOrder?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Article reference */
    speakingArticleCode;
    /**
     * @type {string}
     * @description Buckle type Description */
    buckleTypeDescription;
    /**
     * @type {string}
     * @description Buckle type */
    buckleTypeCode;
    /**
     * @type {?number}
     * @description watch 6 Length */
    watch6Length;
    /**
     * @type {?number}
     * @description watch 12 Length */
    watch12Length;
    /**
     * @type {string}
     * @description Article Material Code */
    materialCode;
    /**
     * @type {string}
     * @description Article Material Description */
    materialDescription;
    /**
     * @type {string}
     * @description Article Color Code */
    colorCode;
    /**
     * @type {string}
     * @description Article Color Description */
    colorDescription;
    /**
     * @type {string}
     * @description Buckle Witdh */
    buckleWidth;
    /**
     * @type {string}
     * @description Article Lining Code */
    liningCode;
    /**
     * @type {string}
     * @description Article Lining Description */
    liningDescription;
    /**
     * @type {string}
     * @description Article Stitching Code */
    stitchingCode;
    /**
     * @type {string}
     * @description Article Stitching Description */
    stitchingDescription;
    /**
     * @type {string}
     * @description Article Edge Code */
    edgeCode;
    /**
     * @type {string}
     * @description Article Edge Description */
    edgeDescription;
    /**
     * @type {string}
     * @description Article Padding Code */
    paddingCode;
    /**
     * @type {string}
     * @description Article Padding Description */
    paddingDescription;
    /**
     * @type {string}
     * @description Article Speciality Code */
    specialtyCode;
    /**
     * @type {string}
     * @description Article Speciality Description */
    specialtyDescription;
    /**
     * @type {string}
     * @description Nuancier Code */
    nuancierCode;
    /**
     * @type {?boolean}
     * @description Strap Vip Order */
    isStrapVipOrder;
}
export class CreateOrderItemRequestV2 {
    /** @param {{lineNumber?:number,articleCode?:string,quantity?:number,requestedDeliveryDate?:string,strap?:StrapItem,orderType?:string,deliveryPlantId?:string,reasonCode?:string,orderDeliveryPriority?:number,buckleSummary?:string,materialSummary?:string,contentSummary?:string,strapSummary?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Line Number */
    lineNumber;
    /**
     * @type {string}
     * @description Reference ID of the article/product, e.g. 'CRWB520003' */
    articleCode;
    /**
     * @type {number}
     * @description Desired quantity of the article */
    quantity;
    /**
     * @type {?string}
     * @description Requested Delivery Date of the Item, e.g. '2020-12-30' */
    requestedDeliveryDate;
    /**
     * @type {StrapItem}
     * @description Strap definition */
    strap;
    /**
     * @type {string}
     * @description Purchase order type, e.g. 'WCFS', null. Null for ordinary order */
    orderType;
    /**
     * @type {string}
     * @description DeliveryPlantId of item, e.g.: CHD6 */
    deliveryPlantId;
    /**
     * @type {string}
     * @description Reason Code */
    reasonCode;
    /**
     * @type {?number}
     * @description Order Delivery Priority,  e.g.: 10, 20, 30, 40, 50 */
    orderDeliveryPriority;
    /**
     * @type {string}
     * @description Buckle Summary, can be get from order simulation */
    buckleSummary;
    /**
     * @type {string}
     * @description Material Summary, can be get from order simulation */
    materialSummary;
    /**
     * @type {string}
     * @description Content Summary, can be get from order simulation */
    contentSummary;
    /**
     * @type {string}
     * @description Strap Summary, can be get from order simulation */
    strapSummary;
}
export class SplittedOrder {
    /** @param {{shipToId?:string,finalShipToId?:string,billToId?:string,soldToId?:string,salesRepresentativeId?:string,orderItems?:CreateOrderItemRequestV2[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Ship To Pos Code */
    shipToId;
    /**
     * @type {string}
     * @description Final Ship To Pos Code */
    finalShipToId;
    /**
     * @type {string}
     * @description Bill To Pos Code */
    billToId;
    /**
     * @type {string}
     * @description Sold To Pos Code */
    soldToId;
    /**
     * @type {string}
     * @description Sales Representative Code */
    salesRepresentativeId;
    /**
     * @type {CreateOrderItemRequestV2[]}
     * @description List of Articles to be created */
    orderItems;
}
export class EndCustomerDetails {
    /** @param {{title?:string,firstName?:string,lastName?:string,email?:string,phone?:string,country?:string,city?:string,street?:string,houseNumber?:string,building?:string,postalCode?:string,region?:string,district?:string,additionalInfo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Title of the end Customer, e.g. 'MR', 'MRS'. */
    title;
    /**
     * @type {string}
     * @description First Name of the end Customer */
    firstName;
    /**
     * @type {string}
     * @description Last Name of the end Customer */
    lastName;
    /**
     * @type {string}
     * @description Email of the end Customer */
    email;
    /**
     * @type {string}
     * @description Phone number of the end Customer, e.g. '0032477123456'.  */
    phone;
    /**
     * @type {string}
     * @description Countr code in the shipping address, e.g. 'BE' (ISO Code) */
    country;
    /**
     * @type {string}
     * @description City name in the shipping address */
    city;
    /**
     * @type {string}
     * @description Street name in the shipping address */
    street;
    /**
     * @type {string}
     * @description House number in the shipping address */
    houseNumber;
    /**
     * @type {string}
     * @description Building number in the shipping address */
    building;
    /**
     * @type {string}
     * @description Postal code in the shipping address */
    postalCode;
    /**
     * @type {string}
     * @description Region code in the shipping address, e.g. 'VL' (ISO Code) */
    region;
    /**
     * @type {string}
     * @description District name in the shipping address */
    district;
    /**
     * @type {string}
     * @description Additional Info number to the shipping address */
    additionalInfo;
}
export class CreateOrderV2 {
    /** @param {{orderId?:string,posCode?:string,brand?:string,notes?:string,customerReference?:string,customerReferenceConsignment?:string,orderDate?:string,splittedOrders?:SplittedOrder[],endCustomerBooster1Id?:string,endCustomerDetails?:EndCustomerDetails}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Purchase order ID, total length-max with x-booster-App header: 99 */
    orderId;
    /**
     * @type {string}
     * @description Global Pos Code for the intended Order e.g. ES100:102048 */
    posCode;
    /**
     * @type {string}
     * @description Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc. */
    brand;
    /**
     * @type {string}
     * @description Additional Notes regarding the Order */
    notes;
    /**
     * @type {string}
     * @description Customer Reference */
    customerReference;
    /**
     * @type {string}
     * @description Customer Reference for Consignment Order */
    customerReferenceConsignment;
    /**
     * @type {?string}
     * @description Purchase order date, e.g. '2020-12-31' */
    orderDate;
    /**
     * @type {SplittedOrder[]}
     * @description Details of the end Customer */
    splittedOrders;
    /**
     * @type {string}
     * @description Booster1 ID of the end Customer */
    endCustomerBooster1Id;
    /**
     * @type {EndCustomerDetails}
     * @description Details of the end Customer */
    endCustomerDetails;
}

JavaScript CreateOrderV2 DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"orderId":"String","posCode":"String","brand":"String","notes":"String","customerReference":"String","customerReferenceConsignment":"String","orderDate":"\/Date(-62135596800000-0000)\/","splittedOrders":[{"shipToId":"String","finalShipToId":"String","billToId":"String","soldToId":"String","salesRepresentativeId":"String","orderItems":[{"lineNumber":0,"articleCode":"String","quantity":0,"requestedDeliveryDate":"\/Date(-62135596800000-0000)\/","strap":{"speakingArticleCode":"String","buckleTypeDescription":"String","buckleTypeCode":"String","watch6Length":0,"watch12Length":0,"materialCode":"String","materialDescription":"String","colorCode":"String","colorDescription":"String","buckleWidth":"String","liningCode":"String","liningDescription":"String","stitchingCode":"String","stitchingDescription":"String","edgeCode":"String","edgeDescription":"String","paddingCode":"String","paddingDescription":"String","specialtyCode":"String","specialtyDescription":"String","nuancierCode":"String","isStrapVipOrder":false},"orderType":"String","deliveryPlantId":"String","reasonCode":"String","orderDeliveryPriority":0,"buckleSummary":"String","materialSummary":"String","contentSummary":"String","strapSummary":"String"}]}],"endCustomerBooster1Id":"String","endCustomerDetails":{"title":"String","firstName":"String","lastName":"String","email":"String","phone":"String","country":"String","city":"String","street":"String","houseNumber":"String","building":"String","postalCode":"String","region":"String","district":"String","additionalInfo":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}