Get Orders by Customer ID
The Get Orders by Customer ID operation searches for orders by customer ID. The operation uses the RelateadOrderSearch element.
Getting a customer's order history might require multiple requests. For example, the first request by customer ID retrieves order numbers for that customer, then the second request by order number retrieves order detail for a specific order.
URI Summary
|
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
|---|---|---|---|---|---|---|
|
Get orders by customer ID |
POST |
/vM.m/stores/STOREID/customers/orders/get.format |
/v1.0/stores/ABCD/customers/orders/get.xml |
Search for order by customer ID. |
No |
Order-Service-Search-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.
Order
Example
OrderSummaryRequest receives OrderSummaryResponse.
Request XML
<?xml version="1.0" encoding="UTF-8"?>
<OrderSummaryRequest maximumRecords="##MAX_RECORDS##"
xmlns="http://api.gsicommerce.com/schema/checkout/1.0" >
<OrderSearch>
<CustomerId>##CUSTOMER_ID##</CustomerId>
</OrderSearch>
</OrderSummaryRequest>Response XML
<?xml version="1.0" encoding="UTF-8"?>
<OrderSummaryResponse xmlns="http://schema.gspt.net/Order/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<OrderSummary id="order-20110316183534708195" enterpriseCode="TMSNA"
orderHeaderKey="20110316183534708195" orderType="SALES"
modifiedTime="2011-03-08T14:41:32+00:00">
<SourceId type="SELLER">140</SourceId>
<SourceId type="CHANNEL">TMSUS</SourceId>
<SourceId type="STORE">TMSUS</SourceId>
<OmsOrderId>47714110</OmsOrderId>
<CustomerId>customer47714110</CustomerId>
<OrderDate>2011-03-16T12:40:51+00:00</OrderDate>
<Status>Created</Status>
<OrderTotal>114.00</OrderTotal>
<Source>WEB</Source>
</OrderSummary>
</OrderSummaryResponse>