Download OpenAPI specification:Download
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.
bonus_credit_amount_cents
(applicable for instant store credit refunds).UNEVEN_GC
item refund type value is renamed to INSTANT_STORE_CREDIT
.EVEN_EXCHANGE
item refund type value is renamed to INSTANT_EXCHANGE
.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.
Success
A shopper created an RMA and selected all items to be refunded to the shopper's original form of payment.
{- "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",
- "return_reason": "Too Small",
- "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,
- "concept": "concept"
}