Edit in GitHubLog an issue

order view button

The order view button extension point allows you to add a customized button to the order view in the Adobe Commerce Admin.

Example customization​

Copied to your clipboard
order: {
viewButtons: [
{
buttonId: `${extensionId}::delete-order`,
label: 'Delete',
confirm: {
message: 'Are you sure your want to proceed to delete order?'
},
path: '#/delete-order',
class: 'custom',
level: 0,
sortOrder: 80
},
{
buttonId: `${extensionId}::create-return`,
label: 'Create Return',
path: '#/create-return',
class: 'custom',
level: 0,
sortOrder: 80
}
]
}

Parameters

FieldTypeRequiredDescription
buttonId
string
Yes
A unique ID to identify the button. We recommend using the format <extensionId>::<buttonName>.
label
string
Yes
The label of the button.
confirm.message
string
No
Confirmation message to display.
path
string
Yes
The relative path to the button page in the App. The order ID will be sent as part of the query.
level
integer
No
The position in which a set of buttons are placed in the toolbar. The possible values are -1 (left), 0 (center), and 1 (right).
sortOrder
integer
No
The order in which the button is placed inside the level.

Sample code

The Adobe Commerce Extensibility Code Samples repository demonstrates how to customize the order view button.

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.