Process return and create refund

Process a return and create a refund for the associated order. This endpoint finalizes the return flow by issuing a refund tied to an existing return.

Required fields:

  • order_id
  • return_id

A successful request returns the created refund details for the specified order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

erc-ecommerce-return:write

Body Params

Process return refund request containing order ID, return ID, line items, and payment details.

The process return and refund request body.

string
required
length between 1 and 255

The order ID to create the refund for.

string
required
length between 1 and 255

The return ID to process and refund. This field is required.

string
length between 1 and 255

The brand identifier. If the account is multi-brand, this parameter is required.

boolean

Whether to notify the customer about the refund.

string
length between 3 and 3

The currency code for the refund.

refund_line_items
array of objects

The line items to refund.

refund_line_items
transactions
array of objects

The payment transactions for the refund.

transactions
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json