Hold Order

The Hold Order operation lets an external system (such as a customer service system) place a hold on a customer's order after the order is submitted but before it is released for fulfillment. Order hold is possible only during this limited period of time. Not all orders can be placed on hold.

Putting an order on hold stops the order from proceeding to fulfillment so the order can be modified and resubmitted. The actual changes to the order are accomplished with the Update Order operation. (See Update Order.)

The Hold Order can also be called to release a hold on an order that was previously placed on hold.

Order Hold URI Summary

Operation	Action	URI Template	URI Example	Transaction Type	Unique RequestID Needed for Duplicate Detection?	Non-URI Request Payload
Hold order	POST	/vM.m/stores/STOREID/orders/hold.format	/v1.0/stores/ABCD/orders/hold.xml	Place hold on order, or release hold on order.	No	Order-Service-Hold-Request-1.0.xsd

Schemas

Examples

Create a hold

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<OrderHoldRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" orderType="SALES"> 
   <CustomerOrderId>100013413613</CustomerOrderId>
   <OrderHold type="ORDER_MODIFY_HOLD" action="CREATE" /> 
   <ReasonCode>EP</ReasonCode>
   <ReasonDesc>Customer Requested</ReasonDesc>
   <RequestingApplication>Customer Care</RequestingApplication>
   <CustomerServiceInfo>
      <Agent id="43383313AC1169BE00830D56FA7A7015" name="test name" />
      <InteractionId>ADB56493AC1169BC00BCB09C88AF99F4</InteractionId>
      <TransactionId>243129</TransactionId>
   </CustomerServiceInfo>
</OrderHoldRequest>

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<OrderHoldResponse orderType="SALES">
   <CustomerOrderId>100013413613</CustomerOrderId> 
   <OrderHold type="ORDER_MODIFY_HOLD" action="CREATE" />
   <OrderHoldStatus> 
      <ShortDesc>CodeShortDescription</ShortDesc>
      <LongDesc>CodeLongDescription</LongDesc>
      <HoldDuration unitOfMeasure="MINUTES">60</HoldDuration>
   </OrderHoldStatus> 
</OrderHoldResponse>

Release a hold

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<OrderHoldRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" orderType="SALES">
   <CustomerOrderId>100013413613</CustomerOrderId>
   <OrderHold type="ORDER_MODIFY_HOLD" action="RESOLVE" />
   <ReasonCode>EP</ReasonCode>
   <ReasonDesc>Customer Requested</ReasonDesc>
   <RequestingApplication>Customer Care</RequestingApplication>
   <CustomerServiceInfo>
      <Agent id="43383313AC1169BE00830D56FA7A7015" name="test name" />
      <InteractionId>ADB56493AC1169BC00BCB09C88AF99F4</InteractionId>
      <TransactionId>243129</TransactionId>
   </CustomerServiceInfo>
</OrderHoldRequest>

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<OrderHoldResponse orderType="SALES">
   <CustomerOrderId>100013413613</CustomerOrderId> 
   <OrderHold type="ORDER_MODIFY_HOLD" action="RESOLVE" /> 
   <OrderHoldStatus> 
      <ShortDesc>HOLD RESOLVED</ShortDesc> 
   </OrderHoldStatus> 
</OrderHoldResponse>