---
title: "get invoice"
method: GET
path: "/freights/invoices/{orderId}"
tags: ["Freight"]
---

# get invoice

`GET /freights/invoices/{orderId}`

## Request

- Base URL: `https://stg.wearewarp.com/api/v1`
- URL: `https://stg.wearewarp.com/api/v1/freights/invoices/{orderId}`
- Auth: API key in header `apikey`

Returns the cost breakdown of an order. For LTL/PARCEL orders (and orders priced at shipment level) the amounts are the sum over all shipments of the order. The cost fields (`transitCost`, `volumeDiscount`, `fuelCost`, `serviceOptions`, `grandTotal`) are absent while the order has not been priced yet. `status` is `final` once the invoice has been sent, `pending` before that.

## Path parameters

- `orderId` string, required

## Response `200`

successful operation

- GetInvoiceSuccess
  - `orderId` string
  - `orderNumber` string: The display number (code) of the order.
  - `status` 'pending' | 'final': `final` once the invoice has been sent, `pending` before that.
  - `transitCost` number: Base freight charge (USD). Absent while the order has not been priced.
  - `volumeDiscount` number: Volume discount (USD).
  - `fuelCost` number: Fuel surcharge (USD).
  - `serviceOptions` object[]: Accessorial charges.
    - `name` string
    - `total` number
  - `grandTotal` number: Total amount of the order (USD).

## Other responses

- `400`: Bad Request - the request payload is missing fields or contains invalid data.
- `401`: Unauthorized - the apikey header is missing or does not match any active API key.
- `403`: Forbidden - the customer account is suspended. The body carries `message` only, without `code`.
- `429`: Too Many Requests - the quoting rate limit of the API key was exceeded (only POST /freights/quote, /freights/freight-quote and /freights/quote/multi-stops are rate limited; limits apply per UTC hour and per UTC day). The `Retry-After` header holds the number of seconds until the window resets.
- `500`: Internal Server Error - an unknown error has occurred.

---

[API](https://skmtc.dev/wearewarp/apis/warp-api-documentation.md) · [All operations](https://skmtc.dev/wearewarp/apis/warp-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/wearewarp/apis/warp-api-documentation/revisions/01526741bb48?raw)