# Restore a deleted sales order or quote

```http
PATCH https://secure.yoprint.com/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/restore
```

- API version: v2
- Operation ID: `v2_public_order_restore`
- Section: Sales › [Sales orders](https://developer.yoprint.com/reference/sales-orders.md)
- Web page: https://developer.yoprint.com/reference/sales-orders/v2-order-restore/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Brings back a deleted sales order or quote with its lines, jobs, invoices, shipments and messages.

Restoring an order that isn't deleted answers **HTTP 200** with `{"status": 500, "success": false, "error": {"code": "action_not_allowed", "message": null}}`. Do not rely on the HTTP status code alone: check `success` in the response body to confirm the restore succeeded. The answer is otherwise the restored order.

`{order_unique_key}` is the sales order or quote `id` (for example `V4keXwwxMQyXw7`) or its `unique_key` (it starts with `ord_`). The order number people see, such as SO1001, is not accepted here.

## Permission

Needs permission to edit this sales order or quote:

- The team owner
- A role with `update_all_order`
- A role with `update_self_order`, when the order was created by or is assigned to the API key's user
- The person who created a draft, with `create_order`

Quotes use the same sales order permissions.

## Business rules

- Only deleted orders can be restored. Restoring an order that is not deleted answers **HTTP 200** with `{"status": 500, "success": false, "error": {"code": "action_not_allowed", "message": null}}`. Always check `success` in the response body, not the HTTP status code.

## Side effects

- Sends the `order.restored` webhook (`quote.restored` for a quote); on a published order updates the customer's totals. Customer Portal pages the order's customer has open refresh (a live update, not an email).
- Stock is not reserved again: the lines come back not committed. Shippo labels voided by the delete stay voided.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `order_unique_key` (string, required): The sales order's or quote's `id` (a hash id), or its `unique_key` (`ord_…`). The order number (`scoped_id`) does not work. Example `V4keXwwxMQyXw7`.

## Request body

This operation takes no request body.

### Example request

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

## Response

`200` Successful response.

> **Warning: a 200 answer can still be a refusal.** Check `success` (and the fields named below) as well as the HTTP status.
> - The order is not deleted: `success: false`, `error.code` `action_not_allowed` (the body's `status` says 500). Fix: Check `success` in the response body, not the HTTP status code. Read the order first: `trashed` must be true.

Refusal example (Refused with HTTP 200: `success` is false):

```json
{
  "error": {
    "code": "action_not_allowed",
    "message": null
  },
  "status": 500,
  "success": false
}
```

Example response:

```json
{
  "data": {
    "assigned_users": [],
    "calc_deposit_total": 67500,
    "customer": {
      "id": "63KcENAAsKuipY",
      "is_external": false,
      "name": "Northwind Apparel",
      "tax_exempt": false
    },
    "customer_id": "63KcENAAsKuipY",
    "customer_po_number": "PO-1188",
    "deposit_amount_due": {
      "dp": 4,
      "value": 175000
    },
    "deposit_required": true,
    "deposit_total": 50000,
    "due_date": "2026-11-14T00:00:00+00:00",
    "id": "V4keXwwxMQyXw7",
    "internal_status": "published",
    "invoiced_discount_subtotal": {
      "dp": 4,
      "value": 0
    },
    "invoiced_order_item_subtotal": {
      "dp": 4,
      "value": 1250000
    },
    "invoiced_shipment_subtotal": {
      "dp": 4,
      "value": 0
    },
    "invoiced_tax_subtotal": {
      "dp": 4,
      "value": 100000
    },
    "invoiced_total": {
      "dp": 4,
      "value": 1350000
    },
    "is_rush": false,
    "issue_date": "2026-11-03T00:00:00+00:00",
    "mode": "view",
    "name": "Spring team shirts",
    "object_type": "sales_order",
    "order_balance_due": {
      "dp": 4,
      "value": 850000
    },
    "order_item_cart_total": {
      "dp": 4,
      "value": 1250000
    },
    "paid_amount": 50000,
    "quote": false,
    "scoped_id": "SO1001",
    "status": {
      "color": "#2196f3",
      "customer_label": "In Progress",
      "id": "52CuV8sWcDZLPm",
      "label": "In production",
      "position": 2,
      "role": "order",
      "trashed": false,
      "type": "in_progress"
    },
    "status_id": "52CuV8sWcDZLPm",
    "total_qty_need_ordering": "0.00000000",
    "trashed": false,
    "type": "order",
    "unique_key": "ord_EXAMPLEuniqueKey"
  },
  "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: The API key's role can't edit this order. Fix: Ask the team owner for sales order edit permission.
- `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: No such order in this team. Fix: Check the id. Find deleted orders with the filter `trashed_only`.
- `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 Shopify order: "Cannot restore Shopify-synced order from API." Fix: Shopify orders can't be restored through the API.

## Notes

- Do not rely on the HTTP status code alone. Check `success` in the response body to confirm the restore succeeded.
- Payments moved to the customer's credit when the order was deleted stay as credit.

## Related

- [Delete a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}`
- [Pay an order from the customer's credit](https://developer.yoprint.com/reference/payments/v2-sales-order-credit-pay-with-customer-credit.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/pay_with_customer_credit`