Skip to main content
POST
Create an order

Body

userSecurityToken
string
required

Your account security token.

shipType
enum<integer>
required

1 Carta Simples · 2 Carta Registrada · 3 Carta Registrada + AR · 4 Telegrama · 5 Mala Direta · 6 Sedex · 7 Sedex + AR · 8 eCarta Simples · 9 eCarta Registrada · 10 eCarta Registrada + AR. Sedex (6, 7) is only accepted with virtualbox=1 or when the sender address is in Jaú/SP.

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
name
string
required

Recipient name.

Maximum string length: 60
addr1
string
required
Maximum string length: 60
street_number
string
required
Maximum string length: 15
zip
string
required

Recipient ZIP (CEP). Validated against Correios for Brazilian addresses; the state is cross-checked against the CEP.

city
string
required
Maximum string length: 40
state
string
required

For Brazilian addresses this must be the 2-letter UF (e.g. SP).

Maximum string length: 40
country
string
required
Maximum string length: 60
paymentMethod
enum<string>
default:escrybe_credits
Available options:
escrybe_credits,
invoice,
team
team_member_id
integer

Required when paymentMethod=team.

ar_type
enum<string>
default:physical

electronic is only allowed for shipTypes 3, 7 and 10.

Available options:
physical,
electronic
virtualbox
enum<string>
default:0

Virtual Box service — when 1 (or "true"), the sender address is replaced by Escrybe's facility (Jaú/SP) and Virtual Box pricing applies.

Available options:
0,
1
addr2
string
Maximum string length: 40
name_sender
string

Falls back to your profile when omitted.

Maximum string length: 60
addr1_sender
string
Maximum string length: 60
street_number_sender
string
Maximum string length: 15
addr2_sender
string
Maximum string length: 40
zip_sender
string
city_sender
string
Maximum string length: 40
state_sender
string
Maximum string length: 40
country_sender
string
Maximum string length: 60
toAddrOnly
enum<integer>
default:0

Only honored for shipTypes 2, 3, 6, 7 and 10; forced to 0 otherwise.

Available options:
0,
1
tag
string

Free-form label for your own reference.

test
enum<integer>
default:0

When 1, validates without creating the order and returns the calculated price.

Available options:
0,
1
pdfFile
string

Required for shipTypes 1,2,3,5,6,7. base64 string, URL (public Google Docs/Drive links supported), or multipart file. Max 150 pages; password-protected PDFs are rejected.

duplex_printing
enum<integer>
default:1

Also accepts "true"/"false". Forced to 1 for single-page PDFs and to 0 when envelope_type=autoenvelope.

Available options:
0,
1
envelope_type
enum<string>
default:regular

autoenvelope requires a single-page PDF.

Available options:
regular,
autoenvelope
telegram_msg
string

Required for shipType=4. Min 10 chars; rendered content limited to 10 pages.

telegram_post_dated
enum<integer>

Required (0 or 1) when shipType=4.

Available options:
0,
1
telegram_post_dated_date
string<date>

Required when telegram_post_dated=1; must be a future date (tomorrow or later).

telegram_sender_copy
enum<integer>

Required (0 or 1) when shipType=4.

Available options:
0,
1
telegram_delivery_confirmation
enum<integer>

Required (0 or 1) when shipType=4.

Available options:
0,
1
ecarta_msg
string

Required for shipTypes 8,9,10. Min 10 chars; may contain HTML. Rendered content limited to 10 pages.

use_client_contract
enum<string>
default:0

Bill shipping through your own Correios contract. Only for shipTypes 2,3,4,6,7,8,9,10; requires a PJ account with a Correios contract number/card and a plan that allows it.

Available options:
0,
1

Response

Order accepted (or test validated)

status
integer
Example:

200

status_message
string
data