Skip to content

Documents

Contents 26 pages

The files ShipEasy shares in your library, the same as Library in the web app: rate sheets, insurance certificates, invoices, and paperwork for a shipment. Reading needs documents:read.

Organizations only: library paperwork can print a buyer's name, so a Shopify store's key gets not_available_for_shopify and opens these in the ShipEasy app inside Shopify admin.

List documents#

GET/api/v1/documentsScope documents:read
Request
curl "https://app.shipeasyco.com/api/v1/documents?kind=insurance" \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"
Response
{
	"object": "list",
	"data": [
		{
			"object": "document",
			"id": "cm6d0lib3…",
			"title": "Cargo insurance certificate",
			"description": null,
			"kind": "insurance",
			"shipment_id": "cm2k8x7d2…",
			"created_at": "2026-11-12T10:00:00.000Z"
		}
	],
	"has_more": false,
	"next_cursor": null
}

Newest first, at most 100; has_more says there are more, so narrow with q (words in the title, description or reference) or kind.

Download one#

GET/api/v1/documents/{documentId}Scope documents:read

The file itself, a PDF or an image, counted as a download like the web app's. In an AI app, list_documents and get_document (AI agents).