bannerNotification

The bannerNotification extension point defines the contents of banner notifications that display when customizing a mass action or order view button.

Example mass action customizations

The following example defines success and error messages for multiple mass actions.

Copy
bannerNotification: {
    getMassActions() {
      return {
        order: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected orders were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected orders'
          }
        ],
        product: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected products were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected products'
          }
        ],
        customer: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected customers were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected customers'
          }
        ]
      }
    }
}
Copied to your clipboard
bannerNotification: {
    getMassActions() {
      return {
        order: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected orders were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected orders'
          }
        ],
        product: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected products were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected products'
          }
        ],
        customer: [
          {
            actionId: `${extensionId}::mass-action`,
            successMessage: 'Selected customers were updated successfully',
            errorMessage: 'App could not proceed with mass action on selected customers'
          }
        ]
      }
    }
}

Parameters

where banner notification will be customized. It should be the same one that is defined in the customer mass action extension point. customer.successMessage | No | The success message to display when mass action is successful. A default message is displayed if this parameter is not defined. customer.errorMessage | No | The error message to display when mass action fails. A default message is displayed if this parameter is not defined. order.actionId | string | Yes | The actionId of an order mass action. order.successMessage | No | The success message to display when mass action is successful. A default message is displayed if this parameter is not defined. order.errorMessage | No | The error message to display when mass action fails. A default message is displayed if this parameter is not defined. product.actionId | Yes | The actionId of a product mass action. product.successMessage | No | The success message to display when mass action is successful. A default message is displayed if this parameter is not defined. product.errorMessage | No | The error message to display when mass action fails. A default message is displayed if this parameter is not defined.

Example order view button customization

The following example defines success and error messages for a custom order view button.

Copy
bannerNotification: {
  getOrderViewButtons() {
    return [
      {
        buttonId: 'order-custom-view-button::create-return',
        successMessage: 'Order View Button Success',
        errorMessage: 'Order View Button Error'
      }
    ]
  }
}
Copied to your clipboard
bannerNotification: {
  getOrderViewButtons() {
    return [
      {
        buttonId: 'order-custom-view-button::create-return',
        successMessage: 'Order View Button Success',
        errorMessage: 'Order View Button Error'
      }
    ]
  }
}

Parameters

Last updated 6/26/2024

Was this helpful?

Yes

No