Get order cancellation preview

Retrieves pre-cancellation preview data for a customer's order.

Use this endpoint to populate the cancellation UI before submitting the
cancel request. The response includes:

  • use_new_cancel_flow — whether to render the rich cancel popup
    (Shopify) or the legacy single-field flow (BigCommerce, Custom).
  • supports_refund_on_cancel — whether the order has a paid balance
    eligible for refund on cancellation.
  • cancel_reasons — the list of selectable cancellation reason options.
  • refund_payments — the suggested refund amount and payment gateway
    for the original payment method.
  • refundable_items — line items that would be included in the refund.

For BigCommerce and Custom integrations, use_new_cancel_flow is always
false. In that case, cancel_reasons and refundable_items are returned
as empty lists, and refund_payments is empty lists.

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

Scope

erc-ecommerce-orders:read

Path Params
string
required
length between 1 and 255

The customer identifier.

string
required
length between 1 and 255

The order identifier.

Query Params
string
length between 1 and 50

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json