Criar um novo pedido de carta ou telegrama

post

https://escrybe.com.br/api/v2/post

Utilize as informações abaixo para criar um novo pedido.Observação sobre o header Content-Type:- Deve ser setado como multipart/form-data para enviar o PDF como ARQUIVO- Pode ser setado como application/x-www-form-urlencoded ou application/json se o PDF for enviado como LINK ou base64Modalidades disponíveis (campo shipType): 1 = Carta Simples; 2 = Registrada; 3 = Registrada + AR; 4 = Telegrama; 5 = Mala Direta; 6 = Sedex; 7 = Sedex + AR; 8 = eCarta; 9 = eCarta Registrada; 10 = eCarta Registrada + AR

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userSecurityToken

string

required

name

string

required

Nome do destinatário para quem esta correspondência será enviada

addr1

string

required

Primeira linha de endereço (logradouro). Nome da Rua, Avenida, Alameda, Praça. Identificação principal da localização do destinatário

street_number

string

required

Número do prédio, podendo ser acompanhado de identificação de bloco ou "S/N", se não aplicável, do destinatário.

addr2

string

required

Identificação específica de complemento como: casa, conjunto, apartamento, sala, bloco ou andar do destinatário.

zip

string

required

CEP do destinatário (somente números, 8 dígitos)

city

string

required

Cidade do destinatário

state

string

required

Estado do destinatário (abreviado, 2 caracteres)

country

string

required

País do destinatário

name_sender

string

Nome do remetente da correspondência. Se os campos name_sender, addr1_sender, addr2_sender, zip_sender, city_sender, state_sender não forem preenchidos, os dados serão puxados do cadastro do usuário.

addr1_sender

string

Primeira linha de endereço (logradouro). Nome da Rua, Avenida, Alameda, Praça acompanhado do número do prédio. Identificação principal da localização do remetente

street_number_sender

string

Número do prédio, podendo ser acompanhado de identificação de bloco ou "s/n", se aplicável, do remetente.

addr2_sender

string

Identificação específica de complemento como: casa, conjunto, apartamento, sala, bloco ou andar do remetente

zip_sender

string

CEP do remetente

city_sender

string

Cidade do remetente

state_sender

string

Estado do remetente (abreviado, 2 caracteres)

country_sender

string

País do remetente

pdfFile

string

Campo obrigatório para pedidos de carta/Sedex. Deve conter um PDF de uma das seguintes formas: 1. Um link que esteja disponível publicamente para o arquivo PDF, 2. Caminho local da sua máquina para o arquivo PDF ou 3. String do arquivo PDF encodado em base64

virtualbox

boolean

Defaults to false

Uso do VirtualBox

telegram_msg

string

Conteúdo da mensagem do telegrama. Obrigatório se modalidade 4 (Telegrama)

telegram_post_dated

boolean

Defaults to false

Se o telegrama deve ser pós-datado

telegram_post_dated_date

string

Data em que o telegrama deve ser enviado (pós-datado) (YYYY-MM-DD)

telegram_sender_copy

boolean

Defaults to false

Se o remetente do telegrama deve receber uma cópia

telegram_delivery_confirmation

boolean

Se o remetente do telegrama deve receber uma confirmação de que o destinatário recebeu o telegrama enviado.

test

boolean

Se definido como 1, a API irá analisar todos os campos e retornará código 200 (em caso de sucesso) porém não registrará no sistema. Também retornará o valor do pedido caso ele não fosse um teste. Se não for bem sucedida, informará qual o erro como qualquer requisição.

shipType

string

Defaults to 1

Modalidades de envio da correspondência. 1 - Simples 2 - Registrada 3 - Registrada + AR 4 - Telegrama 5 - Mala Direta 6 - Sedex 7 - Sedex + AR

tag

string

Tag para uso interno do cliente, de forma a facilitar o agrupamento e filtro de envios de correspondências (ex: campanha publicitária)

paymentMethod

string

Defaults to escrybe_credits

Se o usuário possui um contrato que permite faturamento, o método de pagamento pode ser 'invoice', se não o padrão será 'escrybe_credits'

ar_type

string

Defaults to physical

Tipo do AR (physical/electronic)

ecarta_msg

string

Conteúdo da eCarta. Obrigatório se shipType for 8, 9 ou 10

use_client_contract

string

Defaults to 0

Usar contrato dos Correios do cliente (somente para Telegrama e eCarta)

Headers

Content-Type

string

Defaults to application/json

multipart/form-data para arquivo no campo pdfFile ou application/x-www-form-urlencoded ou json para pdfFile como link externo ou base64

Responses

200200

400400

401401