> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# voidCarrierShipment

> Void a purchased carrier shipment and refund its label charge. Returns null if the shipment does not exist. Idempotent: voiding an already-voided shipment returns the original result.

**Required scopes:** [`shipping_write`](/docs/api-reference/v3/reference/scopes#scope-shipping_write)

## Arguments

<ResponseField name="shipmentId" type="ID!" required>
  The shipment to void, as returned by purchaseCarrierShipment.
</ResponseField>

## Returns

<ResponseField name="voidCarrierShipment" type={<a href="/docs/api-reference/v3/reference/shipping/void-carrier-shipment-result">VoidCarrierShipmentResult</a>}>
  The outcome of voiding a carrier shipment.

  <Expandable title="fields" lazyRender>
    <ResponseField name="refundStatus" type={<a href="/docs/api-reference/v3/reference/shipping/shipment-refund-status">ShipmentRefundStatus</a>}>
      Refund status; null while the refund is pending confirmation.
    </ResponseField>

    <ResponseField name="shipmentId" type="ID!" required>
      The id of the voided shipment.
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

```graphql theme={null}
mutation {
  voidCarrierShipment(shipmentId: "...") {
    refundStatus
    shipmentId
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.