Void Label Element
The Void Label Element enables a user to void a specific shipping label.
React Component
SDK
Args/Props | Required? | Description |
---|---|---|
labelId | required | string, The unique identifier for the label you wish to void. |
onComplete | required | function, (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void A callback function that will be invoked when the request to void a given shipping label is completed. |
onSuccess | optional | function, (label: SE.Label, shipment: SE.SalesOrderShipment) => void A callback function that will be invoked when the request to void a given shipping label is successful. |
onViewShipment | required | function, (shipment: SE.SalesOrderShipment) => void; A callback function that will be invoked when the user clicks the View Shipment button. We recommend using this callback to render the Shipment Summary Element. |