Calculate Return Refund Amount

post

https://api.talkdeskapp.com/erc/ecommerce/return/calculations

Calculate the expected refund amount for a return request.

Required fields:

order_id
return_line_items

A successful request returns the expected refund amounts for the return request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

erc-ecommerce-return:read

Body Params

Return calculation request containing order details, return items, and optional exchange items.

The return calculate request body.

order_id

string

required

length between 1 and 255

The order ID.

brand

string

length between 1 and 255

The brand identifier for calculating the expected return refund amount. If the account is multi-brand, this parameter is required.

return_line_items

array of objects

required

length ≥ 1

The line items to be returned.

return_line_items*

line_item_id

string

required

length between 1 and 255

The ID of the item from the Get Order Items API.

delivery_id

string

length between 1 and 255

The ID of the order delivery from the Get Order Items API.

quantity

integer

required

1 to 100000

Defaults to 1

The quantity to return, which must be positive.

restocking_percentage

integer

1 to 99

The restocking fee percentage, which must be between 1 and 99.

exchange_line_items

array of objects

The line items to be exchanged, used to calculate the exchange amounts. When the store uses AfterShip for returns, the exchange items are ignored and only the returned items are calculated.

exchange_line_items

return_shipping_fee

number

> 0

The return shipping fee.

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 calculated return amounts.

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method not supported

500Internal Server Error

502Bad Gateway