RMAs (2.0.0)

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 configured URL. The url endpoint will need to return an HTTP 200 to 299 status for a webhook to be successful.

RMA Event

Request
header Parameters
X-Optiturn-Id
required
string
Example: Modrno
X-Optiturn-Api-Version
required
string
Value: 2
Request Body schema: application/json

RMA object

rma_identifier
required
string

Identifier of the RMA.

status
required
string

The status of the RMA.

Enum: "CREATED" "REFUNDED" "PARTIAL_REFUND" "CANCELED"
created_at
required
string

Creation date in ISO 8601 format, UTC.

updated_at
string

Last updated date in ISO 8601 format, UTC.

receiving_complete
boolean

This is for RM only.

gift_refund_only
required
boolean

If true, only issue a gift card and do not refund original purchase payment.

giftee_email
string

Email to send gift card when gift_refund_only is true

warehouse_id
string

Warehouse that return goods will be shipped to when using dynamic package routing

required
Array of objects

List of items that are being returned in the RMA.

Array
order_identifier
required
string

Public facing identifier for the original order.

secondary_identifier
string

OMS or backend system identifier for the original order. Used when ecommerce and fulfillment platforms have unique identifiers.

exchange_order_identifier
string

The identifier of the exchange order when the item being returned is for a new exchange.

original_order_identifier
string

Only populated when returning an exchange item. Refers back to the original order that was exchanged.

is_exchange
boolean

Indicates whether the RMA item belongs to an exchange order

order_line_item_identifier
required
string

The order item's identifier from either the original order or if an exchange, the exchange order.

package_tracking_status
string

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

Enum: "PRE_TRANSIT" "ACCEPTED" "TRANSIT" "DELIVERED" "RETURNED" "FAILURE"
receiving_status
string

The item's receiving status. Only populated when using Optoro's Returns Management.

Enum: "PENDING" "RECEIVED" "NOT_RECEIVED"
required
object

RMA item financial information used for calculating the refund amount.

estimated_refund_amount_cents
required
integer

Total possible refund amount based on goods returned.

optoro_refund_amount_cents
required
integer

Amount Optoro will be paid based on instant exchange usage.

shopper_refund_amount_cents
required
integer

Estimated amount the shopper will be refunded based on instant exchange usage.

refund_type
required
string

The refund type for the item.

Enum: "REFUND" "EVEN_EXCHANGE" "UNEVEN_GC"
return_reason
required
string

The shopper chosen reason for returning the item.

sku
required
string

Unique product identifier of item.

upc
required
string

Unique product code of item.

tracking_number
string

Tracking number of the package the item is located in.

return_method
string

Return method used to return the RMA.

Enum: "mail-back" "express-returns" "customer-keep" "home-pickup"
return_shipping_cost_cents
integer

The return shipping cost.

Responses
200

Success

post/rmas
Request samples
application/json
{
  • "rma_identifier": "RMA123",
  • "status": "CREATED",
  • "created_at": "2018-08-30T15:39:42.025Z",
  • "updated_at": "2018-08-30T15:39:42.025Z",
  • "receiving_complete": false,
  • "gift_refund_only": false,
  • "giftee_email": "giftee@example.com",
  • "warehouse_id": "WH62",
  • "items": [
    ],
  • "return_method": "mail-back",
  • "return_shipping_cost_cents": 100
}
© 2010 – 2024 Optoro, Inc. For official use only by authorized users. Use subject to terms of license agreement.