Processing Transactions

Overview

This article will show you how to process an Order using the RevCascade API. In summary, the process can be broken down into 3 steps:

  1. Retrieve New Orders - Periodically poll the Orders endpoint (e.g. every 15 mins) for new Orders.
  2. Acknowledge Orders - Once you store the Order in your OMS, acknowledge receipt with RevCasacde.
  3. Ship Items - Inform RevCascade once the Order has been fulfilled by posting a Shipment

Step 1: Retrieving New Orders

When looking for new orders to pull down from RevCascade, the recommended practice is to ask for orders that have not yet been acknowledged, like so:

GET https://api.revcascade.com/v1/brands/500/orders/?is_acknowledged=false

Orders that are "acknowledged" indicate to RevCascade (and to Retailers) that you have received the Order and are intending to fulfill the Order. Therefore, filtering the Orders request to only return Orders that have not yet been acknowledged is a reliable way to find new Orders. Depending on your use case, you may want to attach additional filters to this request. Please consult the Orders documentation for a complete list of filters available.

Next, for each new Order you receive, you'll probably want to take the information supplied by RevCascade and create an order in your OMS. Sorry, but you're on your own with this step!

Step 2: Acknowledging Orders

To provide the best customer experience, many Retailers want to know whether or not you intend to fulfill an Order before you actually fulfill the Order. In fact, many Retailers (but not all) have SLAs in place for when the acknowledgment event is required to happen. Recommended practice is to acknowledge orders after:

  • You have successfully copied the Order into your OMS.
  • You have confirmed that all Order Lines are in stock and ready to ship.

To acknowledge an Order, simply:

PUT https://api.revcascade.com/v1/brands/{brand_id}/orders/{order_id}/acknowledge/

Step 3: FulFill Orders & Register Shipments with RevCascade

Once Orders ship, Retailers want to know the tracking number(s) so that they may relay the information to the Consumer. If you (or your warehouse) is capable of generating your own labels and packing slips, then all you need to do is provide the tracking number(s) to RevCascade. However, if you need us to generate shipping labels and/or packing slips, we can help, but we expect you to provide more information when creating the shipment.

After all Order Lines are fulfilled, RevCascade will automatically close the Order and, if applicable, proceed to the Invoicing stage.