Cancel Order

The Cancel Order operation cancels an existing order.

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/stores/STOREID/orders/cancel.format	/v1.0/stores/ABCD/orders/cancel.xml	Cancel existing order.	No	Order-Service-Cancel-1.0

Schemas

Example

OrderCancelRequest receives OrderCancelResponse.

Request XML

<?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

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