---
title: "Troubleshoot order"
description: "Why a customer did not get their invoice, in one call: the order (cancelled? has an email address?), whether an invoice exists and was ever emailed and to which address, bounces and rejections, the store's sender (verifi"
url: https://docs.invoicefalcon.com/v3-reference/orders/troubleshoot-order/
api: "API v3 reference"
method: GET
path: "/orders/{id}/troubleshoot"
---

# Troubleshoot order

`GET https://app.invoicefalcon.com/api/v3/external/orders/{id}/troubleshoot`

Why a customer did not get their invoice, in one call: the order (cancelled? has an email address?), whether an invoice exists and was ever emailed and to which address, bounces and rejections, the store's sender (verified?), whether sending is allowed, the Free plan limit and the automatic-invoice rules. Ends with a `diagnosis` that names the request fixing each finding.

**Note:** Read-only. Start here for a missing-invoice complaint, then run the request a finding names (sends and deletes preview or ask first). Write the `#` of an order number as `%23` in a REST path.

## Path parameters

- `id` (string, required): A Shopify id (gid://shopify/Order/123 or 123) or the order number as the store shows it (&quot;#1001&quot; or &quot;1001&quot;).

## Returns

- `order` (object)
  - `shopify_order_id` (string): e.g. `gid://shopify/Order/5552001`
  - `order_number` (string): e.g. `#1080`
  - `created_at` (string): e.g. `2026-03-01T10:00:00Z`
  - `financial_status` (string): e.g. `paid`
  - `fulfillment_status` (string): e.g. `fulfilled`
  - `cancelled_at` (string, nullable)
  - `email` (string): e.g. `ann@example.com`
- `document` (object)
  - `id` (integer): e.g. `980191022`
  - `type` (string): e.g. `invoice`
  - `number` (string): e.g. `INV-1`
  - `sent_at` (string): e.g. `2026-11-10T09:07:40Z`
- `diagnosis` (array of objects)
  - `code` (string): e.g. `sender_unverified`
  - `severity` (string): e.g. `warning`
  - `message` (string): e.g. `The custom from address invoicefalcon@molecularapps.com i…`
  - `fix` (string): e.g. `Verify the sender domain (GET /account/sending shows the …`
- `verdict` (string): e.g. `The email to bad@example.com bounced ({"type"=>"Permanent…`

Rate limit: this call costs 1 point ([rate limits](https://docs.invoicefalcon.com/v3/docs/api-v3/rate-limits/)).

## Example request

```sh
curl "https://app.invoicefalcon.com/api/v3/external/orders/{id}/troubleshoot" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
```

## 200

The requested resource.

```json
{
  "order": {
    "shopify_order_id": "gid://shopify/Order/5552001",
    "order_number": "#1080",
    "created_at": "2026-03-01T10:00:00Z",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "cancelled_at": null,
    "email": "ann@example.com"
  },
  "document": {
    "id": 980191022,
    "type": "invoice",
    "number": "INV-1",
    "sent_at": "2026-11-10T09:07:40Z"
  },
  "diagnosis": [
    {
      "code": "sender_unverified",
      "severity": "warning",
      "message": "The custom from address invoicefalcon@molecularapps.com is not verified, so emails do not go out as that address.",
      "fix": "Verify the sender domain (GET /account/sending shows the state), or clear the address in PATCH /account/sending."
    },
    {
      "code": "automation_off",
      "severity": "info",
      "message": "Automatic invoices are off, so invoices go out only when someone sends them.",
      "fix": "Send it with POST /documents/invoices/:id/send, or turn it on with PATCH /account/automation."
    },
    {
      "code": "delivery_failed",
      "severity": "problem",
      "message": "The email to bad@example.com bounced ({\"type\"=>\"Permanent\"}).",
      "fix": "Confirm the address with the customer and resend with `to`."
    }
  ],
  "verdict": "The email to bad@example.com bounced ({\"type\"=>\"Permanent\"})."
}
```

## 401

Missing or unknown `X-Auth-Token`, or the shop uninstalled the app.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "unauthorized"
}
```

## 403

`v3_required`: the shop still runs the previous dashboard. `paid_plan_required`: API access needs a paid plan.

```json
{
  "errors": [
    "API access requires a paid plan"
  ],
  "code": "paid_plan_required"
}
```

## 404

The resource does not exist for this shop, or no action is registered at this path.

```json
{
  "errors": [
    "Resource not found"
  ],
  "code": "not_found"
}
```

## 422

The request failed validation. Nothing was saved.

```json
{
  "errors": [
    "id is missing"
  ]
}
```

## 429

Rate limited: cost-weighted per key (reads cost less than writes). Wait `Retry-After` seconds; see `X-RateLimit-*` headers.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited"
}
```

