The Cancel Order operation cancels existing orders or order lines. The response is the updated order snapshot.

URI Summary

Operation

Action

URI Template

URI Example

Transaction Type

Unique RequestID Needed for Duplicate Detection?

Non-URI Request Payload

Cancel order

POST

/vM.m/sellers/{sellerId}/orders/{orderId}/cancel

v1.0/seller/TMSUS/order-manage/orders/3000087032/cancel.json

Cancel existing order.

No

Order-Service-Cancel-1.0

URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:

https://apg.radial.com/v1.0/proxyname/storecode/function

You should have received the applicable information for proxyname, storecode, and function from your Radial representative.

Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.

Schemas

Example

OrderCancelRequest receives OrderCancelResponse.

Request XML

Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
orderType="SALES">
   <CustomerOrderId>##ORDER_ID_TO_CANCEL##</CustomerOrderId>
   <ReasonCode>##REASON_CODE##</ReasonCode>
   <Reason>##REASON_DESC##</Reason>
</OrderCancelRequest>

Response XML

Copy this code sample.
<?xml version="1.0" encoding="UTF8"?>
<OrderCancelResponse xmlns="http://schema.gspt.net/Order/1.0">
   <OmsOrderId>Y100000214</OmsOrderId>
   <CancelResponseStatus>CANCELLED</CancelResponseStatus>
</OrderCancelResponse>