Skip to main content
The v2 order API covers every physical and hybrid product. The shipType field selects the product and determines which fields are required.

​
Shipment types

Sedex (shipType 6 and 7) only ships from Jaú/SP. Either send virtualbox=1, which replaces the sender with Escrybe’s facility, or use a sender address in Jaú/SP. Any other sender city is refused with 400.

​
Endpoints

Full request/response schemas live in the API Reference tab.

​
Sending the document

The pdfFile field accepts three forms:
  • Base64 — a base64-encoded PDF string
  • URL — a publicly reachable URL (fetched server-side through a proxy); public Google Docs/Drive links are supported
  • File upload — a multipart/form-data file part
PDFs must be ≤ 150 pages and not password-protected.
Always run a test=1 request first to validate the address, page count and pricing without charging credits.

​
Telegrams & e-Carta

These products carry a text body instead of a PDF (rendered content is limited to 10 pages):
  • shipType=4 requires telegram_msg (min 10 chars) and the flags telegram_post_dated, telegram_sender_copy and telegram_delivery_confirmation (each must be present with value 0 or 1). When telegram_post_dated=1, telegram_post_dated_date must be a future date.
  • shipType=8|9|10 require ecarta_msg (min 10 chars, may contain HTML).

​
Downloading files

/api/v2/download/{securityToken}/{job_id}/{type} returns base64 content. The type parameter selects the file: