# Delete a shipment

```http
DELETE https://secure.yoprint.com/v2/api/store/{team_slug}/v2/shipment/{unique_key}
```

- API version: v2
- Operation ID: `v2_public_shipment_destroy`
- Section: Shipping › [Shipments](https://developer.yoprint.com/reference/shipments.md)
- Web page: https://developer.yoprint.com/reference/shipments/v2-shipment-destroy/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Deletes a shipment with its lines, packages and shipping estimates. It can't be undone.

Every Shippo label on it is voided: YoPrint asks Shippo for a refund in the background (refusals are not reported back). For a Shopify shipment, its Shopify fulfillment is cancelled first, while you wait.

Deleting a shipment that is already deleted succeeds and changes nothing.

## Permission

Needs permission to edit the shipment's order: the team owner, a role whose Manage Sales Orders permission is "update all", or "update assigned" when you created the order or are assigned to it, or, on a draft order, its creator when their role can create sales orders. Otherwise 403 `user_is_not_authorized`. Reading needs only team membership.

## Business rules

- The role check comes first: a shipment that is already deleted still needs permission to edit its order.
- On a draft order, a shipment with a Shippo label can't be deleted: "Publish this order before deleting a shipment with a shipping label." The same applies to Shopify-linked and other externally synced shipments.
- A Shopify shipment with items fulfilled by a third party can't be deleted.
- A shipment managed by Shopify, or with a broken Shopify link, can't be deleted (`shopify_managed_shipment_locked`, `shopify_broken_link_shipment_locked`).
- On an order deleted in Shopify: 422 `shopify_order_deleted_externally`.
- If Shopify refuses to cancel the fulfillment, the shipment is not deleted and the error is returned.

## Side effects

- Requests a refund from Shippo for each Shippo label, in the background.
- Cancels the Shopify fulfillment of a Shopify shipment (calls Shopify while you wait).
- Recalculates the order lines' shipped status and the order's shipping totals; on an Auto Invoice order, updates its shipping fee lines.
- Open Admin Portal pages refresh, and so do Customer Portal pages the order's customer has open.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `unique_key` (string, required): The shipment's `id` (a hash id), as its answers show it. Its unique key (`shp_...`) also works, but API answers don't include it. Example `MQyJUnd3oty75h`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/v2/shipment/MQyJUnd3oty75h' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role can't edit this order (`user_is_not_authorized`). Nothing is deleted. Fix: Ask the team owner to adjust your role or assign you to the order.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: The shipment isn't your team's. Fix: Check the id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A draft order with labels or external links, a third-party fulfilled item, a Shopify lock (`shopify_managed_shipment_locked`, `shopify_broken_link_shipment_locked`) or an order deleted in Shopify (`shopify_order_deleted_externally`). Fix: Publish the order, or handle the shipment in Shopify.

## Related

- [Get a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-show.md): `GET /v2/api/store/{team_slug}/v2/shipment/{unique_key}`
- [Delete a package (voids its label)](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment_package/{hash_id}`
- [Delete all shipments of an order (retired)](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-destroy-all.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/delete_all`