Risk Order Confirmation API

Overview

The Risk Assessment request message contains the information Radial needs to process the order and provide a fraud decision. After a client order management system receives the fraud decision and processes the order, the client should use the Risk Order Confirmation API to send Radial the final disposition of the order and other key information about the order.

URI Summary

Schemas

• Risk-OrderConfirmationRequest-1.0.xsd
• Risk-OrderConfirmationReply-1.0.xsd

Request Examples

The request is a RiskOrderConfirmationRequest message.

Request example with all elements

<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderConfirmationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <Order>
    <OrderId>123345459</OrderId>
    <StoreId>TMSUS</StoreId>
    <StatusDate>2016-05-19T09:30:47Z</StatusDate>
    <ConfirmationType>CREDIT ISSUED</ConfirmationType>
    <OrderStatus>IN_PROCESS</OrderStatus>
    <OrderStatusReason>a</OrderStatusReason>
    <LineDetails>
      <LineDetail>
        <SKU>a</SKU>
        <Quantity>0</Quantity>
        <ItemStatus>RETURNED</ItemStatus>
        <TrackingNumber>a</TrackingNumber>
        <ShippingVendorCode>OTHER</ShippingVendorCode>
        <DeliveryMethod>a</DeliveryMethod>
        <ShipScheduledDate>2001-12-17T09:30:47Z</ShipScheduledDate>
        <ShipActualDate>2001-12-17T09:30:47Z</ShipActualDate>
      </LineDetail>
      <LineDetail>
        <SKU>a</SKU>
        <Quantity>0</Quantity>
        <ItemStatus>PENDING</ItemStatus>
        <TrackingNumber>a</TrackingNumber>
        <ShippingVendorCode>FEDEX</ShippingVendorCode>
        <DeliveryMethod>a</DeliveryMethod>
        <ShipScheduledDate>2001-12-17T09:30:47Z</ShipScheduledDate>
        <ShipActualDate>2001-12-17T09:30:47Z</ShipActualDate>
      </LineDetail>
    </LineDetails>
    <CustomAttributesList>
      <CustomAttribute>
        <AttributeName>key1</AttributeName>
        <AttributeValue>value1</AttributeValue>
      </CustomAttribute>
      <CustomAttribute>
        <AttributeName>key2</AttributeName>
        <AttributeValue>value2</AttributeValue>
      </CustomAttribute>
    </CustomAttributesList>
  </Order>
</RiskOrderConfirmationRequest>        

Request example with only mandatory elements

<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderConfirmationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <Order>
    <OrderId>123345461</OrderId>
    <StoreId>MAGT1</StoreId>
    <StatusDate>2016-05-19T09:30:47Z</StatusDate>
    <ConfirmationType>CREDIT ISSUED</ConfirmationType>
    <OrderStatus>IN_PROCESS</OrderStatus>
  </Order>
</RiskOrderConfirmationRequest>

Request Elements

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderConfirmationReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>1234567890</OrderId>
  <StoreId>ABCTEST</StoreId>
  <CreateTimestamp>2001-12-17T09:30:47Z</CreateTimestamp>
  <OrderConfirmationAcknowledgement>true</OrderConfirmationAcknowledgement>
</RiskOrderConfirmationReply>

Response Elements

Integration Details

A RiskOrderConfirmationRequest API call should be made if any of the scenarios listed below occurs in the client order management system. Calls to the API should be made every time each scenario occurs. For example, if an order has three items and each was shipped separately for a total of three shipments, the result should be three API calls to RiskOrderConfirmationRequest for the order.

The client order management system can choose to send either all the items involved in order with every RiskOrderConfirmationRequest under LineDetails, or send only the items involved with that particular RiskOrderConfirmationRequest confirmation type under LineDetails element.

Below are some of the possible scenarios when RiskOrderConfirmationRequest is required, with examples of values for the different elements under the request.

Order shipped completely

In this scenario, all the items in an order are shipped. For this order, submit a RiskOrderConfirmationRequest with the following values:

Order shipped partially, some items still processing

In this scenario, some items in an order are shipped and some other items are either waiting for shipment, backordered, cancelled, or returned. For this order, submit a RiskOrderConfirmationRequest with the following values:

Items with backordered status should be sent as PENDING.

Order shipped partially, completes the order

In this scenario, some items in an order are shipped and some other items are either cancelled or returned which makes the whole order complete at this time. For this order, submit a RiskOrderConfirmationRequest with the following values:

Order cancelled completely

In this scenario, all the items in an order are cancelled. For this order, submit a RiskOrderConfirmationRequest with the following values:

Order cancelled partially, some items still processing

In this scenario, some items in an order are cancelled and some other items are either waiting for shipment, backordered, or returned. For this order, submit a RiskOrderConfirmationRequest with the following values:

Items with backordered status should be sent as PENDING

Order cancelled partially, completes the order

In this scenario, some items in an order are cancelled and some other items are either shipped or returned which makes the whole order complete at this time. For this order, submit a RiskOrderConfirmationRequest with the following values:

Return received partially and credit not issued, order is completed previously

In this scenario, items are received to warehouse and credit is still not issued to customer. All the items in order are already shipped or cancelled which makes order complete before return is received. For this order, submit a RiskOrderConfirmationRequest with the following values:

Return received partially and credit not issued, order is in process previously

In this scenario, items are received to warehouse and credit is still not issued to customer. Some of the items in an order are either backordered/waiting for shipment when return is received. For this order, submit a RiskOrderConfirmationRequest with the following values:

Items with backordered status should be sent as PENDING.

Return received completely and credit not issued

In this scenario, all the items in an order are returned and credit is still not issued to customer. For this order, submit a RiskOrderConfirmationRequest with the following values:

Return received partially and credit issued, order is completed previously

In this scenario, credit is issued to customer for the returned items. All the items in order are already shipped or cancelled which makes order complete before return is received. For this order, submit a RiskOrderConfirmationRequest with the following values:

The amount credited to customer should be listed under custom attributes with key as "RefundAmount"

Return received partially and credit issued, order is in process previously

In this scenario, credit is issued to customer for the returned items. Some of the items in an order are either backordered or waiting for shipment when return is received. For this order, submit a RiskOrderConfirmationRequest with the following values:

Items with backordered status should be sent as PENDING

Return received completely and credit issued

In this scenario, credit is issued to customer for the returned items. All the items in an order are returned. For this order, submit a RiskOrderConfirmationRequest with the following values:

Credit Issued

In this scenario, credit is issued to customer either due to price adjustment or customer appeasement or some other reason. For this order, submit a RiskOrderConfirmationRequest with the following values: