Get Order Detail
The Get Order Detail operation searches for an order by the shopper's order number.
URI Summary
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
---|---|---|---|---|---|---|
Get order detail |
POST |
/vM.m/stores/STOREID/orders/get.format |
/v1.0/stores/ABCD/orders/get.xml |
Search for order by shopper's order number |
No |
Order-Service-Detail-1.0.xsd |
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
OrderDetailRequest receives OrderDetailResponse.
Request XML
<?xml version="1.0" encoding="UTF-8"?>
<OrderDetailRequest orderType="##ORDER_TYPE##"
xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CustomerOrderId>##CUSTOMER_ORDER_ID##</CustomerOrderId>
</OrderDetailRequest>
Response XML
<?xml version="1.0" encoding="UTF-8"?>
<OrderDetailResponse xmlns="http://schema.gspt.net/Order/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" orderType="SALES" testType=""
cancellable="false">
<Order webOrderId="810204507" omsOrderId="100000005692"
levelOfService="REGULAR" omsOrderHeaderKey="201106031517104927015">
. . .
<OrderItems>
<OrderItem id="item201106031517104927016" webLineId="1">
. . .
</OrderItem>
</OrderItems>
<Destinations>
. . .
</Destinations>
<Payment>
. . .
</Payment>
<ChargeGroups>
. . .
</ChargeGroups>
. . .
</Order>
</OrderDetailResponse>