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

# get documents

`GET /freights/documents/{orderId}`

## Request

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

Returns the documents (BOL, POD, other files) of every shipment of the order. Without `type` all document types are returned. `podType` only applies to POD documents: with `type=pod` (or no `type`) it filters the PODs; combined with `type=bol` or `type=other` the result is empty. PODs are taken from the delivery task of the last active leg of each shipment, and a POD is only returned once it has been confirmed/approved by WARP.

## Path parameters

- `orderId` string, required

## Query parameters

- `type` 'bol' | 'pod' | 'other'
- `podType` 'Photo' | 'BOL' | 'Signature'

## Response `200`

successful operation

- GetDocumentsSuccess
  - `orderId` string
  - `orderNumber` string: The display number (code) of the order.
  - `data` object[]: One entry per document file. Empty when the order has no document yet.
    - `type` 'pod' | 'bol' | 'other'
    - `podType` 'Photo' | 'BOL' | 'Signature', nullable: Only present for POD documents.
    - `shipmentId` string: The ID of the shipment the document belongs to.
    - `shipmentNumber` string: The display number (code) of the shipment.
    - `url` string: Download URL of the file.
    - `stop` object: The stop the POD was captured at. Only present for POD documents.
      - `type` 'PICKUP' | 'DROPOFF': Type of the stop
      - `name` string: Location Name/ Shipper Name / Consignee Name
      - `street` string: Street
      - `city` string: City
      - `state` string: State
      - `zipcode` string: Zipcode

## 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)