shipment grid columns

The shipment grid columns extension point adds columns to the grid on the Sales > Shipments page in the Adobe Commerce Admin. It calls a runtimeAction in your App Builder app directly, the same as the order and product grid columns extension points.

Example customization

The following example creates a custom column labeled Carrier, backed by a get-shipment-grid-columns runtime action.

adminUi: {
  shipment: {
    gridColumns: {
      label: 'Shipment grid columns',
      description: 'Adds custom columns to the shipment grid',
      runtimeAction: 'shipment-custom-grid-columns/get-shipment-grid-columns',
      columns: [
        { id: 'carrier', label: 'Carrier', type: 'string', align: 'left' },
      ],
    },
  },
},

How it works

1. A merchant opens the shipment grid (Sales > Shipments) in the Commerce Admin.
2. Commerce sends a POST request to your runtime action with the grid type and the visible shipment IDs: { requestId, gridType: 'shipment', ids: ['000000001', '000000002', ...] }.
3. Your action looks up the column values for each shipment ID and returns them.
4. Commerce renders the returned values in the corresponding columns, alongside the built-in columns.

For IDs your action does not return, Commerce falls back to the default values your action declares. If no default is provided, the cell is left empty.

Parameters