When an RMA event occurs in the returns portal, Optoro will notify your webhook about the RMA and its details. These events can be at the time your customer has created an RMA or when the RMA has been shipped.
Optoro's system will make an HTTP POST request to the API endpoint at the configured URL. The API endpoint will need to return an HTTP 200-299 status for a webhook to be considered successful.
See the Webhook Message Behaviors for more details about aspects to consider regarding message delivery.
The RMA webhook provides details of the return as it progresses through the various lifecycle events.
On the right you will find example payloads listed that correspond to a specific type of the return. These are not inclusive of events that could happen on the RMA such as a warehouse receipt or tracking event.
The status of the RMA.
List of items that are being returned in the RMA.
OMS or backend system identifier for the original order. Used when ecommerce and fulfillment platforms have unique identifiers.
The identifier of the exchange order. Used when the item being returned was chosen to be exchanged.
Only populated when returning an exchange item. Refers back to the order that was exchanged.
The shopper chosen reason for returning the item.
Indicates whether the RMA item belongs to an exchange order
Tracking number of the package the item is located in.
The status of the package that the RMA item is in. For Express Returns, ACCEPTED is when item has been accepted at a dropoff location. For Home Pickups, ACCEPTED is when the item has been picked up by a pickup provider. Upon carrier scan a package status can be moved to TRANSIT
The item's receiving status. Only populated when using Optoro's Returns Management.
RMA item financial information used for calculating the refund amount.
Total possible refund amount based on goods returned.
Amount Optoro will be paid based on instant exchange usage.
Return method used to return the RMA.
If true, only issue a gift card and do not refund original purchase payment.
Email to send gift card when gift_refund_only is true
Warehouse that return goods will be shipped to when using dynamic package routing
curl -i -X POST \
https://developer.optoro.com/_mock/openapi/rmas/4/openapi/rmas \
-H 'Content-Type: application/json' \
-H 'X-Optiturn-Api-Version: 3' \
-H 'X-Optiturn-Id: Modrno' \
-d '{
"rma_identifier": "rma1234",
"status": "CREATED",
"created_at": "2018-08-30T15:39:42.025Z",
"updated_at": "2018-08-30T15:39:42.025Z",
"items": [
{
"order_line_item_identifier": "1",
"order_identifier": "o12345",
"secondary_identifier": "soi12345",
"exchange_order_identifier": "eoid23456",
"original_order_identifier": "ooid3456",
"return_reason": "Too Small",
"is_exchange": true,
"sku": "Sku1234",
"upc": "UPC1234",
"tracking_number": "1Z403818413131",
"package_tracking_status": "PRE_TRANSIT",
"receiving_status": "PENDING",
"refund_financials": {
"estimated_refund_amount_cents": 1000,
"optoro_refund_amount_cents": 0,
"shopper_refund_amount_cents": 1000
},
"refund_type": "REFUND"
}
],
"return_method": "mail-back",
"return_shipping_cost_cents": 100,
"bonus_credit_amount_cents": 0,
"receiving_complete": false,
"gift_refund_only": false,
"giftee_email": "testemail@domain.com",
"warehouse_id": "1",
"vendor": "modrno",
"concept": "concept"
}'