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.

​
Billing a team

paymentMethod=team bills the order to the owner of a team you belong to (instead of your credits or your own invoice). It requires team_member_id, and that number is not the team id: it is the id of your membership in that team, different for each member. Two ways to get it:
  • GET /api/v2/teams/{securityToken} lists the teams you can bill, each with its team_member_id. It is the same list as the “Times” group of the payment method on the panel’s send pages: active memberships only, and only teams whose owner is on a plan that allows invoicing.
  • In the panel, under Times, every team shows “ID para a API” with a copy button.
The team owner is listed too (you_are_owner: true) and bills their own team with their own team_member_id. A team_member_id that is not one of your memberships answers 403; a team whose owner cannot be invoiced answers 400. The same field applies to /api/email/v1/post and /api/whatsapp/v1/post.

​
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 ≤ 20 MB (≤ 4 MB when fetched from a URL), ≤ 150 pages and not password-protected. A larger file is refused with 400 whichever way it is sent.
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.
  • Optional telegram_sender_copy_format and telegram_delivery_confirmation_format choose how each additional reaches you: physical (paper, by mail), electronic (e-mail from Correios to the account e-mail) or both (default). telegram_additional_email replaces the account e-mail for the electronic copy; a malformed address returns 400.
  • Each additional posted on paper is its own Correios object with its own tracking code. GET /api/v2/get returns them in telegram_info (tracking_pc, tracking_cc) together with their Correios timeline and derived state (tracking_pc_records, tracking_pc_state, …), refreshed hourly. The telegram’s own status and status_delivery are not affected by them.
  • For the electronic copy, the PDF the Correios e-mail is attached to the order automatically (within 15 minutes of arrival): the sender copy sets sender_copy_available = true and the delivery confirmation lands in files as rr_electronic, with the rr.created webhook.
  • 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: