Richemont.Booster2.PublicApi

SimulateOrderV2

The following routes are available for this service:
POST	/purchase/simulate/v2	Simulate Order

**SimulateOrderV2** Parameters:
Name	Parameter	Data Type	Required	Description
brand	body	string	Yes	Brand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.
posCode	body	string	Yes	Global Pos Code for the intended Order e.g. ES100:102048
customerReference	body	string	No	Customer Reference
notes	body	string	No	Additional Notes regarding the Order
orderDate	body	DateTime?	No	Purchase order date, e.g. '2020-12-31'
orderItems	body	List<SimulateOrderItemRequestV2>	Yes	List of Articles to be simulated
endCustomerBooster1Id	body	string	No	Booster1 ID of the end Customer
endCustomerDetails	body	EndCustomerDetails	No	Details of the end Customer

**SimulateOrderItemRequestV2** Parameters:
Name	Parameter	Data Type	Required	Description
lineNumber	form	int	Yes	Line Number
articleCode	form	string	Yes	Reference ID of the article/product, e.g. 'CRWB520003'
quantity	form	int	Yes	Desired quantity of the article
requestedDeliveryDate	form	DateTime?	No	Requested Delivery Date of the Item, e.g. '2020-12-30'
orderType	form	string	No	Purchase order type, e.g. 'WCFS', null. Null for ordinary order
finalShipToId	form	string	No	Final Ship To Pos Code
strap	form	StrapItem	No	Strap definition

**StrapItem** Parameters:
Name	Parameter	Data Type	Required	Description
speakingArticleCode	form	string	No	Article reference
buckleTypeDescription	form	string	No	Buckle type Description
buckleTypeCode	form	string	No	Buckle type
watch6Length	form	int?	No	watch 6 Length
watch12Length	form	int?	No	watch 12 Length
materialCode	form	string	No	Article Material Code
materialDescription	form	string	No	Article Material Description
colorCode	form	string	No	Article Color Code
colorDescription	form	string	No	Article Color Description
buckleWidth	form	string	No	Buckle Witdh
liningCode	form	string	No	Article Lining Code
liningDescription	form	string	No	Article Lining Description
stitchingCode	form	string	No	Article Stitching Code
stitchingDescription	form	string	No	Article Stitching Description
edgeCode	form	string	No	Article Edge Code
edgeDescription	form	string	No	Article Edge Description
paddingCode	form	string	No	Article Padding Code
paddingDescription	form	string	No	Article Padding Description
specialtyCode	form	string	No	Article Speciality Code
specialtyDescription	form	string	No	Article Speciality Description
nuancierCode	form	string	No	Nuancier Code
isStrapVipOrder	form	bool?	No	Strap Vip Order

**EndCustomerDetails** Parameters:
Name	Parameter	Data Type	Required	Description
title	form	string	No	Title of the end Customer, e.g. 'MR', 'MRS'.
firstName	form	string	Yes	First Name of the end Customer
lastName	form	string	Yes	Last Name of the end Customer
email	form	string	No	Email of the end Customer
phone	form	string	No	Phone number of the end Customer, e.g. '0032477123456'.
country	form	string	Yes	Countr code in the shipping address, e.g. 'BE' (ISO Code)
city	form	string	Yes	City name in the shipping address
street	form	string	Yes	Street name in the shipping address
houseNumber	form	string	No	House number in the shipping address
building	form	string	No	Building number in the shipping address
postalCode	form	string	No	Postal code in the shipping address
region	form	string	No	Region code in the shipping address, e.g. 'VL' (ISO Code)
district	form	string	No	District name in the shipping address
additionalInfo	form	string	No	Additional Info number to the shipping address

**SimulateOrderResponseV2** Parameters:
Name	Parameter	Data Type	Required	Description
results	form	Dictionary<string, SplittedSimulateOrderResponse>	Yes	List of splitted order simulation results
shipTo	form	List<Party>	No	Addresses which order can be shipped to (common list for all splitted orders)
finalShipTo	form	List<Party>	No	Addresses which order can be final shipped to (common list for all splitted orders)
billTo	form	List<Party>	No	Addresses which order can be billed to (common list for all splitted orders)
soldTo	form	Party	No	Address which order is made to (common list for all splitted orders)
salesRepresentative	form	Party	No	Sales representatives (common list for all splitted orders)

**SplittedSimulateOrderResponse** Parameters:
Name	Parameter	Data Type	Required	Description
orderType	form	string	Yes	Order Type
productType	form	string	Yes	Product Type
orderItems	form	List<SimulateOrderItemResponseV2>	Yes	List of Articles simulated
totalValues	form	TotalValues	Yes	Total Values
shipTo	form	List<Party>	Yes	Addresses which order can be shipped to
finalShipTo	form	List<Party>	No	Addresses which order can be final shipped to
billTo	form	List<Party>	Yes	Addresses which order can be billed to
soldTo	form	Party	Yes	Address which order is made to
salesRepresentative	form	Party	No	Sales Representative
warnings	form	List<Warning>	Yes	Warning list

**SimulateOrderItemResponseV2** Parameters:
Name	Parameter	Data Type	Required	Description
lineNumber	form	int	Yes	Line Number, e.g 20, 40, 21, 41
parentLineNumber	form	int?	Yes	Parent Line Number, e.g 20, 40
requestLineNumber	form	int	Yes	Original line number in the request. Line numbers are remapped after the split
articleCode	form	string	Yes	Reference No of item, e.g.: CRWB521234
substitutedArticleCode	form	string	No	Substituted reference No of item, e.g.: CRWB520003
deliveryPlantId	form	string	Yes	DeliveryPlantId of item, e.g.: CHD6
expectedDeliveryDate	form	string	No	Expected Delivery Date, e.g. '2020-12-30'
buckleSummary	form	string	No	Buckle Summary, need to be forwarded to order creation
materialSummary	form	string	No	Material Summary, need to be forwarded to order creation
contentSummary	form	string	No	Content Summary, need to be forwarded to order creation
strapSummary	form	string	No	Strap Summary, need to be forwarded to order creation
totalValues	form	ItemTotalValues	Yes	Item Total Values
warnings	form	List<Warning>	Yes	Warning list

**ItemTotalValues** Parameters:
Name	Parameter	Data Type	Required	Description
requestedQuantity	form	Quantity	No	Requested Quantity
confirmedQuantity	form	Quantity	No	Confirmed Quantity
availableQuantity	form	Quantity	No	Available Quantity
grossWeightMeasure	form	Quantity	No	Gross Weight
netWeightMeasure	form	Quantity	No	Net Weight
volumeMeasure	form	Quantity	No	Volume
netAmount	form	Amount	No	Net Amount Line Total
netPrice	form	AmountAndQuantity	No	Net Price Line Total
taxAmount	form	Amount	No	Tax Amount Line Total
retailSalesPriceAmount	form	Amount	No	Retail Sales Price Line Total

**Quantity** Parameters:
Name	Parameter	Data Type	Required	Description
unit	form	string	Yes	Unit
value	form	decimal	Yes	Value

**Amount** Parameters:
Name	Parameter	Data Type	Required	Description
value	form	decimal	Yes	Value
currency	form	string	Yes	Currency

**AmountAndQuantity** Parameters:
Name	Parameter	Data Type	Required	Description
amount	form	Amount	Yes	Amount
baseQuantity	form	Quantity	Yes	Base Quantity

**Warning** Parameters:
Name	Parameter	Data Type	Required	Description
id	form	string	Yes	Id
message	form	string	Yes	Message
severityCode	form	int	Yes	Severity code, possible values: 1, 2, 3, 4

**TotalValues** Parameters:
Name	Parameter	Data Type	Required	Description
grossWeightMeasure	form	Quantity	Yes	Gross Weight
netWeightMeasure	form	Quantity	Yes	Net Weight
grossVolumeMeasure	form	Quantity	Yes	Gross Volume
grossAmount	form	Amount	Yes	Gross Amount
netAmount	form	Amount	Yes	Net Amount
taxAmount	form	Amount	Yes	Tax Amount

**Party** Parameters:
Name	Parameter	Data Type	Required	Description
id	form	string	Yes	Internal ID of the Element
name	form	string	Yes	Formatted Name of the Element
address	form	Address	No	Geographic Address of the Element

**Address** Parameters:
Name	Parameter	Data Type	Required	Description
countryId	form	string	No	Country ID
stateId	form	string	No	State ID
city	form	string	No	City Name
street	form	string	No	Street Name and Number
zipCode	form	string	No	Postal Code

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

HTTP + JSV

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

{
	brand: String,
	posCode: String,
	customerReference: String,
	notes: String,
	orderDate: 0001-01-01,
	orderItems: 
	[
		{
			lineNumber: 0,
			articleCode: String,
			quantity: 0,
			requestedDeliveryDate: 0001-01-01,
			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: text/jsv
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
		}
	}
}