The Order API provides the main interaction for placing an order, retrieving order information, and performing actions on an existing order.

URI Summary

Order URIs use the service identifier orders.



URI Template

URI Example

Transaction Type

Unique RequestID Needed for Duplicate Detection?

Non-URI Request Payload

Create Order




Create new order.



Get Order Detail




Search for order by shopper's order number.



Get Related Orders




Search for all orders related to a specified order number.



Cancel Order




Cancel existing order.



Get Orders by Customer ID




Search for order by customer ID.



Order Price Adjustment




Adjust order price.



Order Line Cancel




Cancel line item on order.



Get Return Labels




Create return labels for an order.



Gift Search




Search for a gift order.



Create Reship




Create zero cost reship request.



Get Reship Details




Return information for existing reship request.



Hold Order




Place hold on order, or release hold on order.



Update Order




Submit a modified order to replace a previous order that was placed on hold.



URI domain name: Radial recommends using the new domain at To connect to production Radial APIs, use the following form of the URL:

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.

Best Practices

The following best practices help ensure that the Order API processes orders properly.

Order Number Prefix

A unique five-digit numeric channel (order) identifier is assigned to each Radial client. You must add this identifier as a prefix to each order number before the order is submitted to the Order API for processing. The prefix ensures that order numbers are unique among Radial clients. Orders without a valid five-digit prefix on the order number fail.

Customer Number Prefix

A unique five-digit numeric customer (shopper) identifier is assigned to each Radial client. You must add this identifier as a prefix to each customer identifier before you submit the order to the Order API. The prefix ensures that customer identifiers are unique among Radial clients. Once created, the prefixed customer number should be reused for the following reasons:

  • Maintain consistency through the system.
  • Coordinate order history through the system.
  • Help customer service representatives easily and securely look up information for individual customers.

Order Line Numbers

To correlate order line numbers in your e-commece application with order line numbers in the Radial order management system, use the WebLineID parameter and provide a positive integer for each line. These integers are retained and returned in the Order Detail Responses for those items. This allows multiple line items containing products with the same SKU (such as differently valued gift cards) to be reconciled with any order data such as promotions, and to rebuild the shopping cart view in the customer history.

Estimated Delivery Date

Estimated delivery date information received from the Inventory Details Response message is not required and does not have to pass validation to accept an order. The Federal Trade Commission (FTC), however, requires this information for email triggering if a shipment is delayed past a committed time frame.

Order Create Requests

Order create requests for PayPal orders must provide the following values:

Element or Attribute Value
<PaymentAccountUniqueId> PAYPAL
isToken true
<Authorization><ResponseCode> AUTHORIZED (for approved PayPal authorizations)

Order create requests for all other payment types, where an order is eligible for submission, should provide the following values:

Element or Attribute Value
<PaymentAccountUniqueId> Tokenized value returned by the payment authorization response
isToken true
<Authorization><ResponseCode> APPROVED, DECLINE, or TIMEOUT (depending on the payment authorization response)

Fraud Protection

Several required elements in an order create request provide fraud protection. One required element is the <JavaScriptData> element. This element provides a repository for the response from the 41st Parameter’s JavaScript collector code. This collector code must be implemented on the last page of the order completion process. Documentation for the implementation of the JavaScript collector code is included in the file 41stcollectordeployguide.pdf.

JavaScript code components are included in a .zip file provided by Radial. Each code component has examples to demonstrate the correct implementation. The best implementation is to install all collectors on the server page and randomly fire one at run-time. This minimizes the potential for spoofing the collector and making false credit card orders.

Example: Implementation of the JavaScript collector code during the OnSubmit event

Copy this code sample.

<jsp:useBean id="fraudnetScriptProvider"
<% String fraudnetScriptName = fraudnetScriptProvider.getFraudnetScriptName(); %>
<script language="JavaScript" style="behavior:url(#default#clientcaps)" id="clientCapsRef">
<%= fraudnetScriptProvider.getFraudnetScript(fraudnetScriptName) %>
<script type="text/javascript">
document.observe("dom:loaded", function(e){
<%= fraudnetScriptProvider.getFraudnetScriptInvocation(fraudnetScriptName,
"userPrefs") %>
return true;
v.observe('change', function(e) {
$('reviewForm').insert(new Element('input',
//disable buttons so IE6 doesn't submit them
$$('button').each(function(v) {
v.disabled = true;
$('reviewForm') .submit();
<%-- Setting up a hidden form field so as to capture the collected customer browser 
data on the server side for the 41st javascript collector implementation --%>
<input type="hidden" name="userPrefs" id="userPrefs" value="">

Order Status in Response Messages

Order response messages provide two levels of order status:

  • Order detail calls return responses with line-level status (single line for multi-quantity items).
  • Order search and order detail calls return responses with header status. This status provides an overall aggregated status of the entire order, calculated and derived based on the status of individual line items in the order. For a list of commonly used header-level order status values, see Order Fulfillment Workflow and Order Status Values.

An order response message can include one of the following order status response strings:

Response String Status Phase (Informational Only)
Draft Order Created In Process
Created In Process
Pre-Sell Line Created In Process
OGC Line Created In Process
Warranty Line Created In Process
OrderLine Invoiced In Process
Pre-Fulfilled Line Created In Process
Reserved Awaiting Acceptance In Process
Reserved In Process
Being Negotiated In Process
Accepted In Process
Backordered Backordered
Unexected Backorder Backordered
Awaiting Scheduling In Process
Companion Backorder In Process
Accessory Backorder In Process
Unscheduled In Process
Scheduled In Process
Awaiting Chained Order Creation In Process
Chained Order Created In Process
Released In Process
Included In Shipment In Process
Shipped Fulfilled
Ready For Pickup Awaiting Consumer (In-Store pickup only)
Pickup Complete Fulfilled
Pending Pickup Cancel In Process
OrderLineInvoiced Fulfilled
PO Shipped Fulfilled
GC Shipped Fulfilled
GC Activated Fulfilled
Warranty Line Processed Fulfilled
OGC Activated Fulfilled
Fulfilled and Invoiced Fulfilled
Return Created Return In Progress
In-Store Return Created Return In Progress
Dummy Return Created n/a
Return Received Returned
STS Order Cancelled Cancelled (Ship to Store only)
ISPU Order Cancelled Cancelled (In-Store pickup only)
OrderLine Invoiced Fulfilled
PO Shipped higher than fulfilled and invoiced Fulfilled
GC Activated higher than fulfilled and invoiced Fulfilled
GC Shipped higher than fulfilled and invoiced Fulfilled
OGC Activated higher than fulfilled and invoiced Fulfilled
Unreceived In Process
Received Returned
Receipt Closed In Process
Cancelled Cancelled