Personal Library

Kbid	2588H0
Last Modified	23-Jun-2020
Added to KB	22-Jul-2014
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.7 ICM 7.8

REST API - Create new order (until 7.8)

https://support.intershop.com/kb/2588H0

URI	/orders
Http Method	POST
Short Description	Creates/submits an order
Query Parameters	none
Example Requests	/orders
HTTP Status Codes	201 Created 202 Accepted 400 Bad Request Possible values for header value "error-key": basket.not_found.error basket.id_required.error shopping_cart.create_order.error shopping_cart.giftcard.error shopping_cart.inventory.error shopping_cart.not_covered.error shopping_cart.payment_redirect.error shopping_cart.tax.calculation.error shopping_cart.terms_and_conditions.error 403 Forbidden 404 Not found 406 Not Acceptable
Description	The request creates / submits a new order based from the basket by the basket ID. If further order processing is required to create the order, e.g., order approval the basket will be accepted (return code = 202).
Cartridge	app_sf_rest
Application	B2C Web Shop, SMB Web Shop

Product Version	7.7
Product To Version	7.8
Status	final

JSON

Request Data Format	application/json
Request related java object	com.intershop.sellside.rest.common.capi.resource.OrderListResource com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO
Request Example	Simple order creation { "basketID": "mwnAqMgoQWUAAAE8irJXwIE5", "acceptTermsAndConditions": "true" } Advanced order creation with additional parameters. If the payment method is Credit Credit and a Credit Card Security Code has to be used this code has to be added here: { "basketID": "BUcKAB1773oAAAFG1fwnP90u", "acceptTermsAndConditions": "true", "paymentInformations" : { "parameters": [ { "key":"simpleCC", "property":"123" } ] } }
Response Data Format	application/json
Response related java object	com.intershop.sellside.rest.common.capi.resource.OrderListResource com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO com.intershop.component.rest.capi.resourceobject.LinkRO
Response Example	Successful order creation { "name": "ConfirmedOrder", "type": "Link", "uri": "PrimeTech-PrimeTechSpecials-Site/-/orders/mwnAqMgoQWUAAAE8irJXwIE5" } Create order failed due to an non-existing basket. Returned status code: 404 Not Found Example reason: wrong basket ID or order already created for this basket ID Bad Request (No basket found for the given ID.) Create order failed due to an existing but invalid basket. Returned status code: 406 Not Acceptable Example: missing invoice address { "type": "OrderValidation", "errorMessage": "The basket contains invalid invoice address.", "validOrder": false, "basketLink": { "type": "Link", "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/EaYKAM6kcBYAAAFG2us4qPtK", "title": "BasketLink" } }

XML

XML Request Data Format	text/xml
XML Request Java Objects	com.intershop.sellside.rest.common.capi.resource.OrderListResource com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO
XML Request Example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <OrderDescription> <acceptTermsAndConditions>true</acceptTermsAndConditions> <basketID>mwnAqMgoQWUAAAE8irJXwIE5</basketID> </OrderDescription>
XML Response Data Format	text/xml
XML Response Java Objects	com.intershop.sellside.rest.common.capi.resource.OrderListResource com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO com.intershop.component.rest.capi.resourceobject.LinkRO
XML Response Example	Successful order creation <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Link name="ConfirmedOrder" type="Link"> <uri>PrimeTech-PrimeTechSpecials-Site/-/orders/mwnAqMgoQWUAAAE8irJXwIE5</uri> </Link> Create order failed due to an non-existing basket. Returned status code: 404 Not Found Example reason: wrong basket ID or order already created for this basket ID Bad Request (No basket found for the given ID.) Create order failed due to an existing but invalid basket. Returned Status Code: 406 Not Acceptable example: missing invoice address <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <OrderValidation type="OrderValidation"> <basketLink type="Link"> <title>BasketLink</title> <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/EaYKAM6kcBYAAAFG2us4qPtK</uri> </basketLink> <errorMessage>The basket contains invalid invoice address.</errorMessage> <validOrder>false</validOrder> </OrderValidation>

Reference - WebShop REST APIs

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.