Order get custom fees

The order get custom fees extension point displays one or more customized fees or discounts on the following locations:

• The Orders Total section of the Create Order page and related pages in the Admin.
• Invoice pages in the Admin.
• Credit memo pages in the Admin.
• Order history pages on the storefront.

The fee amounts are in the base currency of the store.

Example customization​

The following example enables the display of two fees on the Admin and storefront. The first instance applies a $1.00 fee to all orders. The second instance applies a fee of $5.00 when the order total is $20.00 or more.

Copy
order: {
    getOrderCustomFees() {
      return [
        {
          id: 'test-fee-1',
          label: 'Test Fee 1',
          value: 1.00,
          applyFeeOnLastCreditMemo: false
        },
        {
          id: 'test-fee-2',
          label: 'Test Fee 2',
          value: 5.00,
          orderMinimumAmount: 20,
          applyFeeOnLastInvoice: true
        }
      ]
    }
}
Copied to your clipboard

order: {
    getOrderCustomFees() {
      return [
        {
          id: 'test-fee-1',
          label: 'Test Fee 1',
          value: 1.00,
          applyFeeOnLastCreditMemo: false
        },
        {
          id: 'test-fee-2',
          label: 'Test Fee 2',
          value: 5.00,
          orderMinimumAmount: 20,
          applyFeeOnLastInvoice: true
        }
      ]
    }
}

Parameters

Last updated 5/17/2024

Was this helpful?

Yes

No