Richemont.Booster2.PublicApi

<back to all web services

SimulateOrderV2

Requires Authentication
The following routes are available for this service:
POST/purchase/simulate/v2Simulate Order
SimulateOrderV2 Parameters:
NameParameterData TypeRequiredDescription
brandbodystringYesBrand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.
posCodebodystringYesGlobal Pos Code for the intended Order e.g. ES100:102048
customerReferencebodystringNoCustomer Reference
notesbodystringNoAdditional Notes regarding the Order
orderDatebodyDateTime?NoPurchase order date, e.g. '2020-12-31'
orderItemsbodyList<SimulateOrderItemRequestV2>YesList of Articles to be simulated
endCustomerBooster1IdbodystringNoBooster1 ID of the end Customer
endCustomerDetailsbodyEndCustomerDetailsNoDetails of the end Customer
SimulateOrderItemRequestV2 Parameters:
NameParameterData TypeRequiredDescription
lineNumberformintYesLine Number
articleCodeformstringYesReference ID of the article/product, e.g. 'CRWB520003'
quantityformintYesDesired quantity of the article
requestedDeliveryDateformDateTime?NoRequested Delivery Date of the Item, e.g. '2020-12-30'
orderTypeformstringNoPurchase order type, e.g. 'WCFS', null. Null for ordinary order
finalShipToIdformstringNoFinal Ship To Pos Code
strapformStrapItemNoStrap definition
StrapItem Parameters:
NameParameterData TypeRequiredDescription
speakingArticleCodeformstringNoArticle reference
buckleTypeDescriptionformstringNoBuckle type Description
buckleTypeCodeformstringNoBuckle type
watch6Lengthformint?Nowatch 6 Length
watch12Lengthformint?Nowatch 12 Length
materialCodeformstringNoArticle Material Code
materialDescriptionformstringNoArticle Material Description
colorCodeformstringNoArticle Color Code
colorDescriptionformstringNoArticle Color Description
buckleWidthformstringNoBuckle Witdh
liningCodeformstringNoArticle Lining Code
liningDescriptionformstringNoArticle Lining Description
stitchingCodeformstringNoArticle Stitching Code
stitchingDescriptionformstringNoArticle Stitching Description
edgeCodeformstringNoArticle Edge Code
edgeDescriptionformstringNoArticle Edge Description
paddingCodeformstringNoArticle Padding Code
paddingDescriptionformstringNoArticle Padding Description
specialtyCodeformstringNoArticle Speciality Code
specialtyDescriptionformstringNoArticle Speciality Description
nuancierCodeformstringNoNuancier Code
isStrapVipOrderformbool?NoStrap Vip Order
EndCustomerDetails Parameters:
NameParameterData TypeRequiredDescription
titleformstringNoTitle of the end Customer, e.g. 'MR', 'MRS'.
firstNameformstringYesFirst Name of the end Customer
lastNameformstringYesLast Name of the end Customer
emailformstringNoEmail of the end Customer
phoneformstringNoPhone number of the end Customer, e.g. '0032477123456'.
countryformstringYesCountr code in the shipping address, e.g. 'BE' (ISO Code)
cityformstringYesCity name in the shipping address
streetformstringYesStreet name in the shipping address
houseNumberformstringNoHouse number in the shipping address
buildingformstringNoBuilding number in the shipping address
postalCodeformstringNoPostal code in the shipping address
regionformstringNoRegion code in the shipping address, e.g. 'VL' (ISO Code)
districtformstringNoDistrict name in the shipping address
additionalInfoformstringNoAdditional Info number to the shipping address
SimulateOrderResponseV2 Parameters:
NameParameterData TypeRequiredDescription
resultsformDictionary<string, SplittedSimulateOrderResponse>YesList of splitted order simulation results
shipToformList<Party>NoAddresses which order can be shipped to (common list for all splitted orders)
finalShipToformList<Party>NoAddresses which order can be final shipped to (common list for all splitted orders)
billToformList<Party>NoAddresses which order can be billed to (common list for all splitted orders)
soldToformPartyNoAddress which order is made to (common list for all splitted orders)
salesRepresentativeformPartyNoSales representatives (common list for all splitted orders)
SplittedSimulateOrderResponse Parameters:
NameParameterData TypeRequiredDescription
orderTypeformstringYesOrder Type
productTypeformstringYesProduct Type
orderItemsformList<SimulateOrderItemResponseV2>YesList of Articles simulated
totalValuesformTotalValuesYesTotal Values
shipToformList<Party>YesAddresses which order can be shipped to
finalShipToformList<Party>NoAddresses which order can be final shipped to
billToformList<Party>YesAddresses which order can be billed to
soldToformPartyYesAddress which order is made to
salesRepresentativeformPartyNoSales Representative
warningsformList<Warning>YesWarning list
SimulateOrderItemResponseV2 Parameters:
NameParameterData TypeRequiredDescription
lineNumberformintYesLine Number, e.g 20, 40, 21, 41
parentLineNumberformint?YesParent Line Number, e.g 20, 40
requestLineNumberformintYesOriginal line number in the request. Line numbers are remapped after the split
articleCodeformstringYesReference No of item, e.g.: CRWB521234
substitutedArticleCodeformstringNoSubstituted reference No of item, e.g.: CRWB520003
deliveryPlantIdformstringYesDeliveryPlantId of item, e.g.: CHD6
expectedDeliveryDateformstringNoExpected Delivery Date, e.g. '2020-12-30'
buckleSummaryformstringNoBuckle Summary, need to be forwarded to order creation
materialSummaryformstringNoMaterial Summary, need to be forwarded to order creation
contentSummaryformstringNoContent Summary, need to be forwarded to order creation
strapSummaryformstringNoStrap Summary, need to be forwarded to order creation
totalValuesformItemTotalValuesYesItem Total Values
warningsformList<Warning>YesWarning list
ItemTotalValues Parameters:
NameParameterData TypeRequiredDescription
requestedQuantityformQuantityNoRequested Quantity
confirmedQuantityformQuantityNoConfirmed Quantity
availableQuantityformQuantityNoAvailable Quantity
grossWeightMeasureformQuantityNoGross Weight
netWeightMeasureformQuantityNoNet Weight
volumeMeasureformQuantityNoVolume
netAmountformAmountNoNet Amount Line Total
netPriceformAmountAndQuantityNoNet Price Line Total
taxAmountformAmountNoTax Amount Line Total
retailSalesPriceAmountformAmountNoRetail Sales Price Line Total
Quantity Parameters:
NameParameterData TypeRequiredDescription
unitformstringYesUnit
valueformdecimalYesValue
Amount Parameters:
NameParameterData TypeRequiredDescription
valueformdecimalYesValue
currencyformstringYesCurrency
AmountAndQuantity Parameters:
NameParameterData TypeRequiredDescription
amountformAmountYesAmount
baseQuantityformQuantityYesBase Quantity
Warning Parameters:
NameParameterData TypeRequiredDescription
idformstringYesId
messageformstringYesMessage
severityCodeformintYesSeverity code, possible values: 1, 2, 3, 4
TotalValues Parameters:
NameParameterData TypeRequiredDescription
grossWeightMeasureformQuantityYesGross Weight
netWeightMeasureformQuantityYesNet Weight
grossVolumeMeasureformQuantityYesGross Volume
grossAmountformAmountYesGross Amount
netAmountformAmountYesNet Amount
taxAmountformAmountYesTax Amount
Party Parameters:
NameParameterData TypeRequiredDescription
idformstringYesInternal ID of the Element
nameformstringYesFormatted Name of the Element
addressformAddressNoGeographic Address of the Element
Address Parameters:
NameParameterData TypeRequiredDescription
countryIdformstringNoCountry ID
stateIdformstringNoState ID
cityformstringNoCity Name
streetformstringNoStreet Name and Number
zipCodeformstringNoPostal Code

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /purchase/simulate/v2 HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"brand":"String","posCode":"String","customerReference":"String","notes":"String","orderDate":"\/Date(-62135596800000-0000)\/","orderItems":[{"lineNumber":0,"articleCode":"String","quantity":0,"requestedDeliveryDate":"\/Date(-62135596800000-0000)\/","orderType":"String","finalShipToId":"String","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}}],"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: application/json
Content-Length: length

{"results":{"String":{"orderType":"String","productType":"String","orderItems":[{"lineNumber":0,"parentLineNumber":0,"requestLineNumber":0,"articleCode":"String","substitutedArticleCode":"String","deliveryPlantId":"String","expectedDeliveryDate":"String","buckleSummary":"String","materialSummary":"String","contentSummary":"String","strapSummary":"String","totalValues":{"requestedQuantity":{"unit":"String","value":0},"confirmedQuantity":{"unit":"String","value":0},"availableQuantity":{"unit":"String","value":0},"grossWeightMeasure":{"unit":"String","value":0},"netWeightMeasure":{"unit":"String","value":0},"volumeMeasure":{"unit":"String","value":0},"netAmount":{"value":0,"currency":"String"},"netPrice":{"amount":{"value":0,"currency":"String"},"baseQuantity":{"unit":"String","value":0}},"taxAmount":{"value":0,"currency":"String"},"retailSalesPriceAmount":{"value":0,"currency":"String"}},"warnings":[{"id":"String","message":"String","severityCode":0}]}],"totalValues":{"grossWeightMeasure":{"unit":"String","value":0},"netWeightMeasure":{"unit":"String","value":0},"grossVolumeMeasure":{"unit":"String","value":0},"grossAmount":{"value":0,"currency":"String"},"netAmount":{"value":0,"currency":"String"},"taxAmount":{"value":0,"currency":"String"}},"shipTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"finalShipTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"billTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"soldTo":{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}},"salesRepresentative":{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}},"warnings":[{"id":"String","message":"String","severityCode":0}]}},"shipTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"finalShipTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"billTo":[{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}],"soldTo":{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}},"salesRepresentative":{"id":"String","name":"String","address":{"countryId":"String","stateId":"String","city":"String","street":"String","zipCode":"String"}}}