Nexlogiq Commerce OS icon

Nexlogiq Commerce OS

Unified SaaS Engine for Shopify and WooCommerce

Refund → Create

AI-generated

Summary

Create a refund for an order on either Shopify or WooCommerce platform.

Inputs

  • Platform (required) — Select either 'Shopify' or 'WooCommerce' as the e-commerce platform.
  • Store URL (required) — The URL of the store to connect to.
  • API Key / Consumer Key (required) — The API key (Shopify) or Consumer key (WooCommerce) used for authentication.
  • API Secret / Consumer Secret — The API secret (Shopify) or Consumer secret (WooCommerce). Required only for WooCommerce.
  • Order ID (required) — For Shopify: The ID of the order to refund. For WooCommerce: The order ID to refund.
  • Full Refund? — Shopify only: If true, processes a full refund automatically calculating the full amount.
  • Currency — Shopify only and only when Full Refund? is false: The currency code (default 'USD') for the refund.
  • Refund Line Items — Shopify only and only when Full Refund? is false: Specific line items to refund with their line item IDs and quantities.
  • Amount (required) — WooCommerce only: The refund amount (e.g., 15.50).
  • Reason — WooCommerce only: Reason for the refund.

Output shape

a single record containing details of the created refund

The operation sends a refund creation request to the chosen platform's API and returns the refund object details or an error if the operation fails.

Examples

Example 1: Create a full refund for a Shopify order

Set Platform to 'Shopify', provide Store URL, API Key, Order ID, and set 'Full Refund?' to true

Example 2: Create a partial refund on Shopify specifying line items

Set Platform to 'Shopify', provide Store URL, API Key, Order ID, set 'Full Refund?' to false, specify 'Currency' and 'Refund Line Items' with line item IDs and quantities

Example 3: Create a refund amount on WooCommerce

Set Platform to 'WooCommerce', provide Store URL, API Key, API Secret, Order ID, refund Amount, and optionally Reason

Links

Discussion