Richemont.Booster2.PublicApi

<back to all web services

CreateOrderV2

Requires Authentication
The following routes are available for this service:
POST/purchase/v2Create Order
CreateOrderV2 Parameters:
NameParameterData TypeRequiredDescription
orderIdbodystringYesPurchase order ID, total length-max with x-booster-App header: 99
posCodebodystringYesGlobal Pos Code for the intended Order e.g. ES100:102048
brandbodystringYesBrand Trigram of the intended Order, e.g. 'IWC', 'CAR', etc.
notesbodystringNoAdditional Notes regarding the Order
customerReferencebodystringNoCustomer Reference
customerReferenceConsignmentbodystringNoCustomer Reference for Consignment Order
orderDatebodyDateTime?NoPurchase order date, e.g. '2020-12-31'
SplittedOrdersbodyList<SplittedOrder>NoDetails of the end Customer
endCustomerBooster1IdbodystringNoBooster1 ID of the end Customer
endCustomerDetailsbodyEndCustomerDetailsNoDetails of the end Customer
SplittedOrder Parameters:
NameParameterData TypeRequiredDescription
shipToIdformstringYesShip To Pos Code
finalShipToIdformstringNoFinal Ship To Pos Code
billToIdformstringYesBill To Pos Code
soldToIdformstringYesSold To Pos Code
salesRepresentativeIdformstringNoSales Representative Code
orderItemsformList<CreateOrderItemRequestV2>YesList of Articles to be created
CreateOrderItemRequestV2 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'
strapformStrapItemNoStrap definition
orderTypeformstringNoPurchase order type, e.g. 'WCFS', null. Null for ordinary order
deliveryPlantIdformstringNoDeliveryPlantId of item, e.g.: CHD6
reasonCodeformstringYesReason Code
orderDeliveryPriorityformint?NoOrder Delivery Priority, e.g.: 10, 20, 30, 40, 50
buckleSummaryformstringNoBuckle Summary, can be get from order simulation
materialSummaryformstringNoMaterial Summary, can be get from order simulation
contentSummaryformstringNoContent Summary, can be get from order simulation
strapSummaryformstringNoStrap Summary, can be get from order simulation
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

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/v2 HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orderId: String,
	posCode: String,
	brand: String,
	notes: String,
	customerReference: String,
	customerReferenceConsignment: String,
	orderDate: 0001-01-01,
	splittedOrders: 
	[
		{
			shipToId: String,
			finalShipToId: String,
			billToId: String,
			soldToId: String,
			salesRepresentativeId: String,
			orderItems: 
			[
				{
					lineNumber: 0,
					articleCode: String,
					quantity: 0,
					requestedDeliveryDate: 0001-01-01,
					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/jsv
Content-Length: length

{
	
}