Record PostSale Action

post

https://api.signifyd.com/v3/orders/events/postsale/actions/record

Use this when the entire return, refund, or appeasement has already been completed and you’re sending the outcome retrospectively.

This is the right choice for:

Batch ingestion of historical return/refund data
In-store returns (BORIS) where online events are logged post-fact
Use cases where Create and Update were not called in real-time

It supports:

Guarantee cancellation if the status is REFUNDED or PARTIAL_SETTLEMENT
Partial refund logic via amount field
Matching to the original orderId and Signifyd guarantee

Record PostSale Action replaces Create + Update in one step. Do not use it in combination with the above two.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

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

postSaleActionId

string

required

Unique identifier for this return, refund, or appeasement request.

status

string

enum

Final outcome of the post-sale action. This status should reflect what has already occurred (e.g., REFUNDED, REPLACED).

CANCELED - The request was canceled before fulfillment, refund, or processing.
REFUNDED - A refund has been issued for the request.
REPLACED - A replacement item has been issued to the buyer.
DECLINED - The request was reviewed and denied (e.g., due to policy or abuse).
PARTIAL_SETTLEMENT - A partial refund, appeasement, or resolution has been granted.

Allowed:

requestedAt

date-time

Timestamp of when the post-sale action occurred. Defaults to current time if not provided.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601."

device

object

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

items

array of objects

Array of items included in the completed return, exchange, or appeasement request.

items

refund

object

Object containing details about a refund that was issued for the post-sale action. Include only if a refund has been issued.

replacement

object

Object containing details about any replacement that was issued for the post-sale action. Include only if a replacement has been issued.

initiator

object

Unique identifier for who initiated the post-sale action. This will be used if an internal employee initiated the post-sale action.

201

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.

409Response if the Request is considered to conflict with data already on the system.

500Response if an unexplained error occurs on the server.