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. Campos obrigatórios enviados em branco (ou só com espaços) são recusados.

Required string length: 1 - 60
addr1
string
obrigatório
Required string length: 1 - 60
street_number
string
obrigatório

Número do imóvel. Para Telegrama e eCarta (shipTypes 4, 8, 9, 10) precisa ter ao menos uma letra ou dígito — os Correios exigem o número em seu próprio campo. Use S/N quando não houver; - e . são recusados.

Required string length: 1 - 15
zip
string
obrigatório

CEP do destinatário, 8 dígitos. A pontuação é removida, então 78470-000 e 78470000 são equivalentes; qualquer valor que não tenha 8 dígitos é recusado. Validado nos Correios para endereços brasileiros e a UF é conferida contra o CEP. Um CEP que os Correios ALTERARAM NÃO é recusado: o pedido é criado com o CEP novo e a status_message de sucesso informa a troca (ex.: "CEP do destinatario 78460-000 foi alterado pelos Correios e corrigido automaticamente para 78470-000.").

Pattern: ^\d{5}-?\d{3}$
city
string
obrigatório
Required string length: 1 - 40
state
string
obrigatório

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

Required string length: 1 - 40
country
string
obrigatório
Required string length: 1 - 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. É também o caminho para enviar Sedex (shipType 6 e 7) com remetente fora de Jaú/SP, que de outro modo é recusado.

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

Bloco do remetente. Se QUALQUER campo de remetente faltar, o bloco INTEIRO vem do cadastro da sua conta — inclusive os campos que você enviou, que são sobrescritos. Envie os sete campos de remetente juntos, ou nenhum deles. Se o cadastro também estiver incompleto, a requisição falha com 400.

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

CEP do remetente, 8 dígitos. Mesmas regras do zip, incluindo a correção automática de CEP alterado.

Pattern: ^\d{5}-?\d{3}$
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
string
padrão:0

Modo de validação. Aceita 1/true/yes/on para validar sem criar o pedido (o preço calculado é devolvido) e 0/false/no/off para enviar de verdade. QUALQUER outro valor é recusado com 400 — antes ele caía num pedido real e cobrável.

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.

docxFile
string

Optional alternative to pdfFile for shipTypes 1,2,3,5,6,7: a Word (.docx) template as base64 or multipart file. Every {{variable}} in the document (body, headers, footers) is replaced with the value given in variables for this recipient, then the result is converted to the PDF that gets printed. When both are sent, docxFile wins. Returns 503 if DOCX conversion is not available on the server.

variables
string

Objeto JSON opcional {"nome": "Ana", "valor": "R$ 120,00"} com os valores deste destinatário para os marcadores {{variavel}} em telegram_msg, ecarta_msg ou docxFile. Nomes ignoram maiúsculas e acentos ({{ Número do Contrato }} = numero_do_contrato); marcador sem valor sai em branco. Máximo de 50 variáveis, 2000 caracteres cada. Páginas e preço são calculados sobre o texto renderizado. Os campos do destinatário desta requisição estão SEMPRE disponíveis como marcadores, em inglês ou português, sem precisar enviá-los aqui: {{name}}/{{nome}}, {{addr1}}/{{endereco}}, {{street_number}}/{{numero}}, {{addr2}}/{{complemento}}, {{zip}}/{{cep}} (formatado 00000-000, após a correção dos Correios), {{city}}/{{cidade}}, {{state}}/{{uf}}, {{country}}/{{pais}}. Um valor enviado em variables com um desses nomes é ignorado em favor do campo.

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

Post through your own Correios contract. Only for shipTypes 2,3,4,6,7,8,9,10; requires a PJ account with Correios credentials (API user, token, contract number and card) registered and a plan that allows it. Pricing changes: Correios bills postage, freight, AR, Mão Própria and telegram extras to YOUR contract, and Escrybe charges only handling/printing per your plan (plus extra sheets, single-sided printing, AutoEnvelope and VirtualBox where they apply). The Correios freight is quoted on your contract when the order is placed and returned as shipping_cost by GET /order — reported, not charged. A failed authentication or quote on your contract refuses the order with HTTP 400.

Opções disponíveis:
0,
1

Resposta

Pedido aceito (ou teste validado)

status
integer
Exemplo:

200

status_message
string
data