Get Related Orders
The Get Related Orders operation searches for all orders related to a specified order number. The operation uses the OrderSearch element.
URI Summary
|
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
|---|---|---|---|---|---|---|
|
Get related orders |
POST |
/vM.m/stores/STOREID/orders/relatedOrders/get.format |
/v1.0/stores/ABCD/orders/relatedOrders/get.xml |
Search for all orders related to a specified order number. |
No |
Order-Service-RelatedOrderSearch-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
RelatedOrderSummaryRequest receives RelatedOrderSummaryResponse.
Request XML
<?xml version="1.0" encoding="UTF-8"?>
<RelatedOrderSummaryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" >
<RelatedOrderSearch>
<CustomerOrderId>##CUSTOMER_ORDER_ID##</CustomerOrderId>
</RelatedOrderSearch>
</RelatedOrderSummaryRequest>Response XML
<?xml version="1.0" encoding="UTF-8"?>
<RelatedOrderSummaryResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderSummary id="order-123" orderType="SALES" testType="TEST_ORDER"
modifiedTime="2011-02-22T22:09:56+00:00">
<CustomerOrderId>0002620100010200</CustomerOrderId>
<CustomerId>0000420100003000</CustomerId>
<OrderDate>2010-11-11T18:59:48+00:00</OrderDate>
<DashboardRepId>admin</DashboardRepId>
<Status>Cancelled</Status>
<OrderTotal>0.00</OrderTotal>
<Source>Web</Source>
</OrderSummary>
</RelatedOrderSummaryResponse>