Get Suggested Refund

post

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

Calculate the suggested refund for an order or return. Supports two workflows: (1) direct refund from an order with specified line items, or (2) refund after a return where line items and totals are pre-calculated from the return.

Required fields:

order_id or return_id (one must be provided)

A successful request returns the suggested refund details for the specified order or return.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

erc-ecommerce-return:read

Body Params

Suggested refund request containing either an order ID with line items, or a return ID.

The suggested refund request body.

order_id

string

length between 1 and 255

The order ID to calculate the suggested refund for. Either order_id or return_id must be provided.

return_id

string

length between 1 and 255

The return ID to calculate the suggested refund for. Either order_id or return_id must be provided.

brand

string

length between 1 and 255

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

refund_line_items

array of objects

The line items to include in the suggested refund calculation.

refund_line_items

shipping_amount

number

> 0

The shipping amount to refund. Must be positive.

refund_shipping

boolean

Whether to include shipping in the refund.

refund_duties

array of objects

The duties to include in the refund.

refund_duties

suggest_full_refund

boolean

Whether to suggest a full refund for the order.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200The suggested refund details.

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method not supported

500Internal Server Error

502Bad Gateway