Refund order - Automate.ax

webflow.refundOrder refunds an ecommerce order with an optional reason.

Example

automations/webflow-refund-order.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { webflow } from "automate.ax/webflow"

export default automation("Refund order", () => {
  onDashboardRun({ title: "Refund order" })

  webflow.refundOrder({
    siteId: "site-id",
    orderId: "order-id",
    reason: "requested",
  })
})

Inputs

Every input accepts a compatible signal. It requires the ecommerce:write OAuth scope.

Field	Type	Required	Description
`reason`	`Webflow.OrdersRefundRequestReason`	No	Webflow `reason` value.
`siteId`	`string`	Yes	Webflow site ID.
`orderId`	`string`	Yes	Webflow order ID.

This operation changes or permanently removes provider data. Confirm the IDs before you deploy it.

Output

Returns an object with the fields below. Automate.ax converts provider Date values to ISO 8601 strings.

Field	Type	Description
`orderId`	`string`	Webflow order ID.
`status`	`Webflow.OrderStatus`	Webflow `status` value.
`comment`	`string`	Webflow `comment` value.
`orderComment`	`string`	Webflow `orderComment` value.
`acceptedOn`	`string`	Webflow `acceptedOn` value.
`fulfilledOn`	`string`	Webflow `fulfilledOn` value.
`refundedOn`	`string`	Webflow `refundedOn` value.
`disputedOn`	`string`	Webflow `disputedOn` value.
`disputeUpdatedOn`	`string`	Webflow `disputeUpdatedOn` value.
`disputeLastStatus`	`Webflow.OrderDisputeLastStatus`	Webflow `disputeLastStatus` value.
`customerPaid`	`Webflow.OrderPrice`	Webflow `customerPaid` value.
`netAmount`	`Webflow.OrderPrice`	Webflow `netAmount` value.
`applicationFee`	`Webflow.OrderPrice`	Webflow `applicationFee` value.
`allAddresses`	`Webflow.OrderAddress[]`	Webflow `allAddresses` value.
`shippingAddress`	`Webflow.OrderShippingAddress`	Webflow `shippingAddress` value.
`billingAddress`	`Webflow.OrderBillingAddress`	Webflow `billingAddress` value.
`shippingProvider`	`string`	Webflow `shippingProvider` value.
`shippingTracking`	`string`	Webflow `shippingTracking` value.
`shippingTrackingUrl`	`string`	Webflow `shippingTrackingUrl` value.
`customerInfo`	`Webflow.OrderCustomerInfo`	Webflow `customerInfo` value.
`purchasedItems`	`Webflow.OrderPurchasedItem[]`	Webflow `purchasedItems` value.
`purchasedItemsCount`	`number`	Webflow `purchasedItemsCount` value.
`stripeDetails`	`Webflow.StripeDetails`	Webflow `stripeDetails` value.
`stripeCard`	`Webflow.StripeCard`	Webflow `stripeCard` value.
`paypalDetails`	`Webflow.PaypalDetails`	Webflow `paypalDetails` value.
`customData`	`Record<string, Encodable>[]`	Webflow `customData` value.
`metadata`	`Webflow.OrderMetadata`	Webflow `metadata` value.
`isCustomerDeleted`	`boolean`	Webflow `isCustomerDeleted` value.
`isShippingRequired`	`boolean`	Webflow `isShippingRequired` value.
`hasDownloads`	`boolean`	Webflow `hasDownloads` value.
`paymentProcessor`	`string`	Webflow `paymentProcessor` value.
`totals`	`Webflow.OrderTotals`	Webflow `totals` value.
`downloadFiles`	`Webflow.OrderDownloadFilesItem[]`	Webflow `downloadFiles` value.