Execute Return

post

https://api.signifyd.com/v3/orders/events/returns/executions

Use this endpoint to inform Signifyd of subsequent actions on a return/refund/exchange request that was previously submitted for evaluation via the Attempt Return API. Integration of this endpoint is required if your organization has subscribed to Returns Abuse Prevention coverage from Signifyd.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

Unique identifier for the order.

returnId

string

required

Unique identifier for the Return.

returnStatus

string

enum

The status of the Return. For every update you get to a Return after creation, you can call executeReturn to update the status of the return. If no returnStatus is provided, the default will be OPEN.

OPEN - The return has been approved, but not processed.
CANCELED - The return has been closed by either the customer or the merchant.
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.
IN_ANALYSIS - The return is being analyzed by the merchant.
DECLINED - The return has been declined by the merchant.
RETURN_PENDING - The return is pending and has not been processed.
PARTIAL_SETTLEMENT - The request has been processed and a partial settlement (e.g., discount to keep, partial credits) was issued.

executedAt

date-time

Timestamp indicating when the return's status or fulfillment details were updated.

200If an action on a Return has already been executed in the Signifyd system with the same orderId and returnId, then no updates to the Return will occur. We will simply return the existing Return details.

201Return executed

400Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.

401Response if the provided authentication credentials are not known or do not match what is on file for the specified user.

403Response if the authenticated user does not have permission to perform the requested action.

404Response if the requested entity can't be found.

500Response if an unexplained error occurs on the server.