Create Refund with WooCommerce API

Pipedream makes it easy to connect APIs for WooCommerce and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Refund with the WooCommerce API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Refund with the WooCommerce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Refund action
1. Connect your WooCommerce account
2. Select a Order ID
3. Optional- Configure Amount
4. Optional- Configure Reason
5. Optional- Configure API Refund
6. Optional- Configure Line Items
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Refund on WooCommerce

Description:Create a new refund for an order. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-refund)

Version:0.0.1

Key:woocommerce-create-refund

View on GitHub

Code#

import app from "../../woocommerce.app.mjs";

export default {
  key: "woocommerce-create-refund",
  name: "Create Refund",
  description: "Create a new refund for an order. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-refund)",
  version: "0.0.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    orderId: {
      propDefinition: [
        app,
        "orderId",
      ],
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The total refund amount. If not specified, the amount will be calculated based on the line items",
      optional: true,
    },
    reason: {
      type: "string",
      label: "Reason",
      description: "Reason for the refund",
      optional: true,
    },
    apiRefund: {
      type: "boolean",
      label: "API Refund",
      description: "When true, the payment gateway API is used to generate the refund. When false, the refund is manual",
      optional: true,
    },
    lineItems: {
      type: "string[]",
      label: "Line Items",
      description: `Array of line items to refund. Each item must be a JSON string with the following structure:

**Properties:**
- \`id\` (integer, required): The ID of the line item in the order
- \`refund_total\` (number, required): The amount to refund for this line item, excluding taxes
- \`refund_tax\` (array, optional): Array of tax refund objects, each containing:
  - \`id\` (integer): The ID of the tax rate
  - \`refund_total\` (number): The amount of tax to refund

**Example:**
\`\`\`json
{
  "id": 111,
  "refund_total": 10,
  "refund_tax": [
    {
      "id": 222,
      "refund_total": 20
    }
  ]
}
\`\`\``,
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      ...Object.fromEntries(
        Object.entries({
          amount: this.amount,
          reason: this.reason,
          api_refund: this.apiRefund,
          line_items: this.lineItems?.map((item) => typeof item === "string"
            ? JSON.parse(item)
            : item),
        }).filter(([
          ,
          v,
        ]) => v !== undefined),
      ),
    };

    try {
      const response = await this.app.createRefund({
        orderId: this.orderId,
        data,
      });

      $.export("$summary", `Successfully created refund ID: ${response.id} for $${response.amount}`);

      return response;

    } catch (error) {
      throw new Error(JSON.stringify(error.response.data));
    }
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
WooCommerce	`app`	`app`	This component uses the WooCommerce app.
Order ID	`orderId`	`integer`	Select a value from the drop down menu.
Amount	`amount`	`string`	The total refund amount. If not specified, the amount will be calculated based on the line items
Reason	`reason`	`string`	Reason for the refund
API Refund	`apiRefund`	`boolean`	When true, the payment gateway API is used to generate the refund. When false, the refund is manual
Line Items	`lineItems`	`string[]`	Array of line items to refund. Each item must be a JSON string with the following structure: Properties: `id` (integer, required): The ID of the line item in the order `refund_total` (number, required): The amount to refund for this line item, excluding taxes `refund_tax` (array, optional): Array of tax refund objects, each containing: `id` (integer): The ID of the tax rate `refund_total` (number): The amount of tax to refund Example: `{ "id": 111, "refund_total": 10, "refund_tax": [ { "id": 222, "refund_total": 20 } ] }`