API Reference
API Reference

Record Return

post
https://api.signifyd.com/v3/orders/events/returns/records

Call this endpoint to record a return, exchanges, cancel a guarantee (within 30 days of order placement) and/or refund that does not need a decision from Signifyd.

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

The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event.

string
enum

The status of the Return. For every update you get to a Return after creation, you can call recordReturn to update the status of the return.

  • CANCELED - Request has been canceled by user.
  • REFUNDED - The return request has been processed and refunded.
  • REPLACED - If a return resulted in a new item being sent, the replacement item has been allocated for delivery to the customer.
  • DECLINED - The return has been declined by the merchant.
Allowed:
string
required

Unique identifier for the Return.

date-time

The time the return occurred. If this field is empty the present time is used instead.

device
object

Data about the device that was used by the user to complete the actions.

returnedItems
array of objects

A list of products that are going to be returned by the buyer.

returnedItems
replacementItems
object
refund
object

Details about the reimbursement that will be issued to the buyer if the return is approved.

initiator
object

Unique identifier for who initiated the return. This will be used if an internal employee initiated the return.

tags
array of strings

A list of attributes or short descriptors associated with the return.

tags
trackingNumbers
array of strings

The tracking number(s) for the returned item(s).

trackingNumbers
string

Transaction id for the refund issued for a refund claim.

string

Id for the store credit issued for a refund claim.

string

Unique identifier for the replacement order issued either as a response to a refund claim or as an exchange for a return.

Headers
int64

The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.

Responses

204

A 204 response indicates that the request was processed but no response is expected.

Updated 7 days ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago

Did this page help you?

Terms

Acceptable Use

Privacy

Your privacy choices