s1 API Host

<back to all web services

PlaceConsumerOrderRequest

The following routes are available for this service:
POST,OPTIONS/api/consumer/cart/place-consumer-orderPlaces an order with the provided items. Order will be delivered to the given consumer.
Parameters:
NameParameterData TypeRequiredDescription
PlaceConsumerOrderRequestbodyPlaceConsumerOrderRequestYesProvide the requested properties to place an order.

To override the Content-type in your clients 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 /jsv/reply/PlaceConsumerOrderRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: text/jsv
Content-Length: length

{
	externalSystemId: String,
	orderId: String,
	shippingMethod: String,
	shipping: 
	{
		method: String,
		type: String,
		fee: 0,
		date: String
	},
	payment: 
	{
		type: String,
		reference: String,
		status: String,
		shippingPrice: 0,
		fee: 0,
		totalPrice: 0,
		remark: String,
		transactionProvider: String,
		transactionReference: String,
		transactionType: String
	},
	customer: 
	{
		emailAddress: String,
		telephone: String,
		membership: 
		{
			cardId: String,
			paidCredits: 0
		},
		invoiceAddress: 
		{
			firstName: String,
			lastName: String,
			companyName: String,
			street: String,
			houseNumber: String,
			houseNumberAddition: String,
			zipCode: String,
			city: String,
			region: String,
			country: String
		},
		shippingAddress: 
		{
			firstName: String,
			lastName: String,
			companyName: String,
			street: String,
			houseNumber: String,
			houseNumberAddition: String,
			zipCode: String,
			city: String,
			region: String,
			country: String
		},
		nationalIdNr: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	consumerOrderId: String,
	comment: String
}