GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. Retail Experience Cloud Bridge

Create a Refund

post
https://api.talkdeskapp.com/erc/ecommerce/refund

Create a direct refund for an order. Supports refunding specific line items, shipping costs, and duties with configurable payment transactions and refund methods.

Required fields:

  • order_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

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

The create refund request body.

string
required
length between 1 and 255

The order ID to create the refund for.

string
length between 1 and 255

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

string

A note describing the reason for the refund.

boolean

Whether to notify the customer about the refund.

string

The currency code for the refund.

shipping
object

Shipping refund details.

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
refund_methods
array of objects

The refund methods to use.

refund_methods
Responses

Updated 2 months ago

Did this page help you?
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

Updated 2 months ago

Did this page help you?