# ShipEngine Documents API

**Canonical:** https://apis.io/apis/shipengine/shipengine-documents-api/  
**Provider:** ShipEngine — https://apis.io/providers/shipengine/  
**Base URL:** https://api.shipengine.com  
**Documentation:** https://docs.shipstation.com/apis/shipengine/openapi

ShipEngine Documents API is one of 25 APIs that [ShipEngine](https://apis.io/providers/shipengine/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.

Document Upload lets you submit self-prepared customs paperwork — such as Pro Forma Invoices, USMCA forms (for example, the USMCA Certification of Origin), and other supporting documents — directly to the carrier. Use it whenever a shipment requires supplemental international documentation, helping to prevent customs delays and delivery issues. Documents can be provided at either the **shipment level** or the **label level** — that is, before or after a label is generated: - **Shipment level (before a label exists).** Register the document with [Register a document for a shipment](#operation/register_shipment_document). Documents registered at the shipment level are forwarded to the carrier automatically. - **Label level (after a label is generated).** Register the document with [Register a document for a label](#operation/register_label_document), then call [Send label documents](#operation/send_label_documents) to transmit it to the carrier. To enable document upload for a shipment or label, set the `pending_documents` flag on the shipment's `customs` object. SS API: You can also suppress a carrier-generated document by setting the `suppress_carrier_generated_documents` [advanced option](/apis/@shipengine/docs/carriers/advanced-options.md) on the shipment. Currently, only the commercial invoice is supported, and only for UPS. Carrier Document Upload is currently supported for **UPS** and **FedEx** only. Accepted document types and file size vary by carrier — see the [Carrier Document Upload guide](/apis/@shipengine/docs/labels/carrier-document-upload.md) for the full list. For **step-by-step instructions on uploading documents through the ShipStation API dashboard**, see the [Customs Declarations: Document Upload help article](https://help.shipstation.com/hc/en-us/articles/50888603341211). This is useful for operations teams who need to upload documents manually or as a fallback if API integration issues occur.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/labels/{label_id}/documents` | Register a document for a label |
| GET | `/v1/labels/{label_id}/documents` | List documents for a label |
| DELETE | `/v1/labels/{label_id}/documents/{document_id}` | Delete a label document |
| POST | `/v1/labels/{label_id}/documents/send` | Send label documents |
| GET | `/v1/documents/{document_id}/download` | Download a document |
| POST | `/v1/shipments/{shipment_id}/documents` | Register a document for a shipment |
| GET | `/v1/shipments/{shipment_id}/documents` | List documents for a shipment |
| DELETE | `/v1/shipments/{shipment_id}/documents/{document_id}` | Delete a shipment document |
| GET | `/v1/shipments/{shipment_id}/labels` | List shipments and their document statuses |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/shipengine/openapi/shipengine-documents-api-openapi.yml
- **Documentation** — https://docs.shipstation.com/apis/shipengine/docs/getting-started/get-started
- **APIReference** — https://docs.shipstation.com/apis/shipengine/openapi
- **JSONSchema** — https://artifacts.apis.io/shipengine/json-schema/index.json

## Other ShipEngine APIs (12)

- [ShipEngine Account API](https://apis.io/apis/shipengine/shipengine-account-api/)
- [ShipEngine Addresses API](https://apis.io/apis/shipengine/shipengine-addresses-api/)
- [ShipEngine Batches API](https://apis.io/apis/shipengine/shipengine-batches-api/)
- [ShipEngine Carrier Accounts API](https://apis.io/apis/shipengine/shipengine-carrier-accounts-api/)
- [ShipEngine Carriers API](https://apis.io/apis/shipengine/shipengine-carriers-api/)
- [ShipEngine Checkout Rates API](https://apis.io/apis/shipengine/shipengine-checkout-rates-api/)
- [ShipEngine Delivery Predictions API](https://apis.io/apis/shipengine/shipengine-delivery-predictions-api/)
- [ShipEngine Downloads API](https://apis.io/apis/shipengine/shipengine-downloads-api/)
- [ShipEngine Freight API](https://apis.io/apis/shipengine/shipengine-freight-api/)
- [ShipEngine Insurance API](https://apis.io/apis/shipengine/shipengine-insurance-api/)
- [ShipEngine Labels API](https://apis.io/apis/shipengine/shipengine-labels-api/)
- [ShipEngine Mailing API](https://apis.io/apis/shipengine/shipengine-mailing-api/)

## Tags

Documents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/shipengine/shipengine-documents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/shipengine/.
