Cancel fraud order by order ID
If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if it is confirmed as fraudulent, this endpoint is used to cancel the order.
Note: If you do not have order ID, use the corresponding order number-based endpoint - POST - /orders/order-number/{orderNumber}/actions/fraud-cancel
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
24-character system-generated order ID returned in the response of Create Order - POST /orders
endpoint.
Body
Fraud cancellation
Merchant-defined reason code for fraud cancellation
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Employee (ID or name) who initiated the request of fraud cancellation
Additional info, if any
Subreason code for fraud cancellation, for another layer of classification
Was this page helpful?