Integrations

Synchronize returns, refunds and credit notes

Use scoped operational APIs or mapped Integration Hub imports.

How to do it

  1. Register an OAuth app and request returns.read/write, refunds.read/write or credits.read/write as needed.
  2. Use GET /api/v1/commerce/returns, refunds or credit_notes for lists and details. POST an allowed lifecycle action with data, or a records array containing stable external IDs.
  3. In Integration Hub, map an import operation to return, refund or credit_note. Map the original orderId or returnId, fields, items and configured relationships.
  4. Review per-record results and Logs. Retry with the same external IDs; use explicit actions for approval, inspection and settlement.

Check your result

Imports are bounded to 100 records per page. Existing external records update configured metadata without repeating stock movement or changing reserved financial totals. New return.updated, refund.updated and credit_note.updated events can feed configured event routes.

Good to know

Native Shopify/WooCommerce refund synchronization is not automatic through this feature. Configure the source API, mapping, scheduler and provider credentials, and verify its results. OpenAPI is available at /api/v1/openapi.

Still need help?

Tell us your BU code and the step where you got stuck. Do not include passwords, BU PINs, tokens or recovery codes.

Contact SupaChrome support