Create Refund

post

https://loyalty.yotpo.com/api/v2/refunds

Send a new refund to the Yotpo API to adjust previously processed order. Requests are processed asynchronously. If you're on SFCC use the following URL instead of the below, with the same parameters POST: https://loyalty.yotpo.com/commerce-cloud/refunds

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

An unique identifier used to identify this refund in your system. If you don't track these explicitly in your database then we will create one internally. Requests are processed asynchronously. A HTTP 200 success response acknowledges the receipt of the request

order_id

string

required

The identifier used to uniquely identify the order in your system. It must match the order_id used when the order was created initially.

total_amount_cents

int32

required

The total amount the customer was refunded in cents.

items

array of objects

An array of items refunded

items

currency

string

The currency used (e.g. 'USD') This is required if you're using multi currency. If not provided or the refund+order currency do not match, errors will be returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

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

application/json

text/plain

201201

400400

404404

422422