- Menu
- Sitemap
REST API - Create new order
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 | {
"basketID": "mwnAqMgoQWUAAAE8irJXwIE5",
"acceptTermsAndConditions": "true"
}
|
Response Data Format | application/json |
Response related java object | com.intershop.sellside.rest.common.capi.resource.OrderListResource com.intershop.sellside.rest.common.capi.resourceobject.OrderValidationRO com.intershop.component.rest.capi.resourceobject.LinkRO |
Response Example | Successful order creation:
{
"name": "ConfirmedOrder",
"type": "Link",
"uri": "inSPIRED-inTRONICS_Business-Site/-/orders/mwnAqMgoQWUAAAE8irJXwIE5"
}
Create order failed due to an non-existing basket:
Bad Request (No basket found for the given ID.) Create order failed due to an existing but invalid basket:
{
"type": "OrderValidation",
"errorMessage": "Error(s) occurred during order creation.",
"basketLink": {
"type": "Link",
"uri": "inSPIRED-inTRONICS_Business-Site/-/baskets/qNoKAB2YN1YAAAFb.MpGYEhO",
"title": "BasketLink"
},
"validOrder": false,
"failures": [
"CostCenterMissing"
],
"warnings": []
}
In general, failures that occur during the order creation will be sent with the "failures" field of the response.
Create order failed because another workflow needs to be triggered (e.g., approval) or a redirect needs to happen (e.g., payment) before the order creation can be finished:
{
"type": "OrderValidation",
"errorMessage": "Order creation has not yet finished.",
"validOrder": false,
"failures": [],
"warnings": [],
"stopAction": {
"type": "StopActionRO",
"actionType": "WORKFLOW",
"actionHint": "approval.workflow"
}
}
The "stopAction" field will display the type and a hint of the action to be performed before the order creation can be continued. |
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.OrderValidationRO com.intershop.component.rest.capi.resourceobject.LinkRO |
XML Response Example | Successful order creation:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
<title>ConfirmedOrder</title>
<uri>inSPIRED-inTRONICS-Site/-/orders/7BsKAB2Y0fUAAAFbJQhGYEhm</uri>
</Link>
Create order failed due to an non-existing basket:
Bad Request (No basket found for the given ID.) Create order failed due to an existing but invalid basket:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OrderValidation type="OrderValidation">
<basketLink type="Link">
<title>BasketLink</title>
<uri>inSPIRED-inTRONICS_Business-Site/-/baskets/YKEKAB2YqesAAAFbrDA4PEh6</uri>
</basketLink>
<errorMessage>Error(s) occurred during order creation.</errorMessage>
<failures>
<failure>CostCenterMissing</failure>
</failures>
<validOrder>false</validOrder>
<warnings/>
</OrderValidation>
In general, failures that occur during the order creation will be sent with the failures field of the response.
Create order failed because another workflow needs to be triggered (e.g., approval) or a redirect needs to happen (e.g., payment) before the order creation can be finished:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OrderValidation type="OrderValidation">
<errorMessage>Order creation has not yet finished.</errorMessage>
<stopAction type="StopActionRO">
<actionHint>approval.workflow</actionHint>
<actionType>WORKFLOW</actionType>
</stopAction>
<validOrder>false</validOrder>
<failures/>
<warnings/>
</OrderValidation>
The "stopAction" field will display the type and a hint of the action to be performed before the order creation can be continued. |
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.