Skip to main content
POST
Criar um pedido

Corpo

userSecurityToken
string
obrigatório

Seu token de segurança.

shipType
enum<integer>
obrigatório

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) só é aceito com virtualbox=1 ou quando o endereço do remetente é em Jaú/SP.

Opções disponíveis:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
name
string
obrigatório

Nome do destinatário.

Maximum string length: 60
addr1
string
obrigatório
Maximum string length: 60
street_number
string
obrigatório
Maximum string length: 15
zip
string
obrigatório

CEP do destinatário. Validado nos Correios para endereços brasileiros; a UF é conferida contra o CEP.

city
string
obrigatório
Maximum string length: 40
state
string
obrigatório

Para endereços brasileiros deve ser a UF de 2 letras (ex.: SP).

Maximum string length: 40
country
string
obrigatório
Maximum string length: 60
paymentMethod
enum<string>
padrão:escrybe_credits
Opções disponíveis:
escrybe_credits,
invoice,
team
team_member_id
integer

Obrigatório quando paymentMethod=team.

ar_type
enum<string>
padrão:physical

electronic só é permitido para shipTypes 3, 7 e 10.

Opções disponíveis:
physical,
electronic
virtualbox
enum<string>
padrão:0

Serviço Virtual Box — quando 1 (ou "true"), o endereço do remetente é substituído pela unidade da Escrybe (Jaú/SP) e a precificação do Virtual Box é aplicada.

Opções disponíveis:
0,
1
addr2
string
Maximum string length: 40
name_sender
string

Usa os dados do seu perfil quando omitido.

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>
padrão:0

Considerado apenas para shipTypes 2, 3, 6, 7 e 10; forçado para 0 nos demais.

Opções disponíveis:
0,
1
tag
string

Rótulo livre para sua própria referência.

test
enum<integer>
padrão:0

Quando 1, valida sem criar o pedido e retorna o preço calculado.

Opções disponíveis:
0,
1
pdfFile
string

Obrigatório para shipTypes 1,2,3,5,6,7. String base64, URL (links públicos de Google Docs/Drive suportados) ou arquivo multipart. Máx. 150 páginas; PDFs com senha são rejeitados.

duplex_printing
enum<integer>
padrão:1

Também aceita "true"/"false". Forçado para 1 em PDFs de página única e para 0 quando envelope_type=autoenvelope.

Opções disponíveis:
0,
1
envelope_type
enum<string>
padrão:regular

autoenvelope exige um PDF de página única.

Opções disponíveis:
regular,
autoenvelope
telegram_msg
string

Obrigatório para shipType=4. Mín. 10 caracteres; conteúdo renderizado limitado a 10 páginas.

telegram_post_dated
enum<integer>

Obrigatório (0 ou 1) quando shipType=4.

Opções disponíveis:
0,
1
telegram_post_dated_date
string<date>

Obrigatório quando telegram_post_dated=1; deve ser uma data futura (amanhã ou depois).

telegram_sender_copy
enum<integer>

Obrigatório (0 ou 1) quando shipType=4.

Opções disponíveis:
0,
1
telegram_delivery_confirmation
enum<integer>

Obrigatório (0 ou 1) quando shipType=4.

Opções disponíveis:
0,
1
ecarta_msg
string

Obrigatório para shipTypes 8,9,10. Mín. 10 caracteres; pode conter HTML. Conteúdo renderizado limitado a 10 páginas.

use_client_contract
enum<string>
padrão:0

Fatura o envio pelo seu próprio contrato dos Correios. Apenas para shipTypes 2,3,4,6,7,8,9,10; exige conta PJ com número/cartão de contrato dos Correios e um plano que permita.

Opções disponíveis:
0,
1

Resposta

Pedido aceito (ou teste validado)

status
integer
Exemplo:

200

status_message
string
data