Related Documents
Document Properties
KbidC28316
Last Modified23-Jun-2020
Added to KB21-Jun-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Cancel order


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/orders/<OrderID>

Http Method

PUT

Short Description

Cancel an order

Query Parameters

none

Example Requests

/orders/0TvAqMgoG2gAAAE8cnoQb4up

HTTP Status Codes

200 OK
400 Bad Request    
       Possible values for header "error-key":

    • order.wrong_status
    • order.cancel.error
    • order.cancel.not_possible.error

401 Unauthorized
403 Forbidden
404 Not found
409 Conflict
       Possible values for header "error-key":

    • order.cancel.not_possible.status

Description

Cancel an order (set status to 'canceled')

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Access Restrictions

Requires authentication with user having assigned the following permissions:

  • Purchase (APP_B2B_PURCHASE, only in B2B applications)

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

Request Example

{
    "status": "canceled"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

Response Example

{
    "type": "Order",
    ...
    "status": "canceled",
    ...
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Order>
	<status>canceled</status>
</Order>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Order type="Order">
    ... 
    <status>canceled</status>
	...
</Order>

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets