API docs by Redocly

SaiuPraEntrega (0.1.0)

Download OpenAPI specification:Download

Email para suporte: [email protected]

API do SaiuPraEntrega

Autorização & Autenticação

A autenticação é realizada através do método Bearer Token, utilizando a chave de API do usuário. Para mais detalhes sobre como gerar a sua chave API acesse nossa documentação

Toda requisição precisa ter o header Accept:

Accept: application/json

Para mais detalhes sobre a API clique aqui.

Como sei que deu certo?

Acompanhe a tela de estatísticas da sua conta. Nela, temos todos os gráficos referente aos envios diários das funcionalidades. Como a quantidade de envios de SMS ou E-mails em sua conta, entre outros.

Caso não saiba onde fica essa tela, acesse este artigo para saber como verificar as estatísticas.

Padrão de datas

Todas as datas contidas no payload a ser enviado para a API devem ser no Timezone UTC +0, de preferencia, seguindo o padrão da ISO 8601.

"created_at": "2020-03-10T13:26:57+00:00"

Teste de endpoint

Sempre que for fazer algum teste, recomendamos que altere os valores do Request Body para evitar problemas. Caso tenha alguma dúvida, acesse este artigo.

Depreciação de campo em Event Group

Foi depreciado o campo address de Event Group, para mais detalhes sobre acesse nossa documentação.

Caso ainda não tenha realizado a mudança em seu projeto, sugerimos substitua o o campo address pelo unit_address.

Pacotes

Lista pacotes

Lista uma coleção de todos os pacotes.

Authorizations:
bearer_token
query Parameters
include
string
Enum: "latest_event" "items" "destination_address"

Adiciona o evento mais recente do pacote, lista um item do pacote e mostra o endereço de destino do pacote.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria pacote

Cria um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
description
required
string

Descrição do produto.

customer_name
string or null

Nome do cliente.

customer_email
string or null

E-mail de contato.

customer_phone
string or null

Telefone de contato.

tracking_code
required
string

Código de rastreamento do produto.

shipping_company
required
string
Enum: "caniao" "correios" "jadlog" "movvi" "yellow-log" "tnt" "total-express"

Indica o nome da transportadora do produto.

object or null

Grupo com os dados da nota fiscal.

required
Array of objects

Grupo de itens do pacote.

Responses

Request samples

Content type
application/json
{
  • "description": "Figure art do goku transformado em Super Saiyajin 2",
  • "customer_name": "Goku",
  • "customer_email": "[email protected]",
  • "customer_phone": "+5533933333333",
  • "tracking_code": "2131",
  • "shipping_company": "correios",
  • "fiscal_invoice": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mostra pacote

Mostra um pacote específico.

Authorizations:
bearer_token
query Parameters
include
string
Enum: "latest_event" "items" "destination_address"

Adiciona o evento mais recente do pacote, lista um item do pacote e mostra o endereço de destino do pacote.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza pacote

Atualiza um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
description
string

Descrição do produto.

customer_name
string or null

Nome do cliente.

customer_email
string or null

E-mail de contato.

customer_phone
string or null

Telefone de contato.

Array of objects

Grupo de itens do pacote.

Responses

Request samples

Content type
application/json
{
  • "description": "Figure art do goku transformado em Super Saiyajin 2",
  • "customer_name": "Goku",
  • "customer_email": "[email protected]",
  • "customer_phone": "+5533933333333",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Exclui pacote

Exclui um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "error": "resource not found"
}

Eventos

Lista eventos

Lista todos eventos de um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Mostra evento

Mostra um evento específico de um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Lista todos eventos

Lista uma coleção de todos eventos.

Authorizations:
bearer_token
query Parameters
fields[events]
string
Value: "status"

Agrupa os status dos eventos.

filter[unique_status]
boolen

Verifica se deve ser feito o agrupamento.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Itens

Lista itens

Lista uma coleção de todos itens de um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Cria item

Cria um item em um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
required
string

Nome do item.

quantity
required
number

Quantidade do item.

value
required
number

Valor do item.

Responses

Request samples

Content type
application/json
{
  • "name": "Figure art do goku transformado em Super Saiyajin 2.",
  • "quantity": 1.5,
  • "value": 350
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mostra item

Mostra um item específico de um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza item

Atualiza um item em um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
string

Nome do item.

quantity
number

Quantidade do item.

value
number

Valor do item.

Responses

Request samples

Content type
application/json
{
  • "name": "Figure art do goku transformado em Super Saiyajin 2.",
  • "quantity": 1.5,
  • "value": 350
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Exclui item

Exclui um item de um pacote.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "error": "resource not found"
}

Métricas de Pacotes

Busca pacotes danificados

Busca quantidade de pacotes danificados dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes em progresso

Busca quantidade de pacotes em progresso dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes sem movimentação

Busca quantidade de pacotes sem movimentação dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes por transportadora

Busca quantidade de pacotes por transportadora dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes por mẽs

Busca quantidade de pacotes por mẽs dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca o tempo médio de entrega

Busca o tempo medio de entrega dos pacotes dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca utilização do plano atual

Busca os dados da utilização do plano atual naquele mẽs.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes recusados

Busca quantidade de pacotes recusados dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes apreendidos

Busca quantidade de pacotes apreendidos dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes bloqueados

Busca quantidade de pacotes bloqueados dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes em progresso

Busca quantidade de pacotes que estão em progresso dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes que estão coletando

Busca quantidade de pacotes que estão coletando dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca pacotes que precisam de ação

Busca quantidade de pacotes que precisam de alguma ação do usuário dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Métricas de Emails

Busca emails enviados por dia

Busca os emails enviados por dia dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca emails entregues por dia

Busca os emails entregues por dia dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Métricas de Sms

Busca sms enviados por dia

Busca os sms enviados por dia dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Busca sms entregues por dia

Busca os sms entregues por dia dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Métricas de OptOuts

Busca contatos bloqueados por dia

Busca os contatos bloqueados por dia dentro de um periodo.

Authorizations:
bearer_token
query Parameters
start_date
required
integer

Data do inicio do intervalo em formato timestamp.

end_date
required
integer

Data do final do intervalo em formato timestamp.

aggregate_by
required
string
Enum: "day" "week" "month"

Formato de agregação para os dados retornados.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Integrações

Instala a integração com o Notificações Inteligentes

Instala a integração com o Notificações Inteligentes, é importante lembrar que o usuário que for efetuar a instalação, tenha todos seus dados de endereço previamente cadastrados no Saiu Pra Entrega.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Desinstala a integração com o Notificações Inteligentes

Desinstala a integração com o Notificações Inteligentes.

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "error": "unauthorized"
}