Visão geral
A API do Enviando permite que sistemas externos — ERPs, e-commerces, marketplaces e aplicações próprias — criem e consultem produtos e pedidos, mapeiem estoque e acompanhem o rastreio de envios de forma programática, sem intervenção manual no painel.
É uma API REST (respostas em JSON) e conta também com um motor GraphQL para consultas avançadas.
Para quem é destinada
- Times técnicos: desenvolvedores que vão integrar o Enviando ao ERP, à loja ou a sistemas internos.
- Times de negócio: use esta página para entender o que pode ser automatizado (cadastro de produtos, entrada de pedidos, baixa de estoque, rastreio) antes de acionar a área técnica.
Ambientes e URL base
| Ambiente | URL base | Uso |
|---|---|---|
| Sandbox (testes) | https://sandbox.enviando.stage.nordware.io |
Homologação e testes de integração |
| Produção | https://{slug}.enviando.nordware.io |
Operação real — substitua {slug} pelo nome da sua conta |
Todas as rotas usam o prefixo /webapi. O slug é o identificador da sua conta no Enviando e aparece também no caminho de cada requisição.
Autenticação
A autenticação é feita por token (Bearer). Para obter o token, entre em contato com o suporte — ele é gerado pela nossa equipe e enviado por e-mail.
Envie o token no cabeçalho Authorization de toda requisição, no formato:
Authorization: Bearer SEU_TOKENO token é pessoal e intransferível. Em caso de comprometimento, solicite a revogação ao suporte.
Início rápido
Exemplo de consulta de um pedido pelo número, no ambiente de sandbox:
curl -X GET \
"https://sandbox.enviando.stage.nordware.io/webapi/order/1001/minhaconta" \
-H "Authorization: Bearer SEU_TOKEN"Recursos disponíveis
| Recurso | Método | Rota | Descrição |
|---|---|---|---|
| Produtos | GET | /webapi/product/{slug} |
Consulta dados de produtos da conta |
| Produtos | POST | /webapi/product/{slug} |
Cria um novo produto |
| Produtos | PATCH | /webapi/product/{code}/{slug} |
Atualiza um produto existente |
| Estoque | POST | /webapi/product/stock/{slug} |
Mapeia o estoque de um produto em um endereço |
| Pedidos | GET | /webapi/order/{number}/{slug} |
Consulta um pedido pelo número |
| Pedidos | GET | /webapi/order/{slug} |
Lista pedidos da conta (com filtros) |
| Pedidos | POST | /webapi/order/{slug} |
Cria um novo pedido |
Exemplo: criar um pedido
POST /webapi/order/{slug} — campos obrigatórios: number, date, situation, store, client, transport, items.
{
"number": 1001,
"date": "2026-06-30",
"situation": "Aguardando",
"store": "001",
"shippingValue": 25.90,
"totalProducts": 2,
"totalSale": 199.80,
"client": {
"name": "Maria Souza",
"cnpj": "12345678000199",
"address": "Rua das Flores",
"number": "100",
"complement": "Sala 2",
"city": "Curitiba",
"district": "Centro",
"postalCode": "80010000",
"province": "PR",
"email": "maria@exemplo.com",
"phone": "41999999999"
},
"items": [
{
"item": {
"code": "SKU-001",
"gtin": "7891234567890",
"description": "Camiseta Branca P",
"quantity": 2,
"unitaryValue": 99.90,
"weight": 0.3
}
}
],
"transport": {
"carrier": "Correios",
"shippingType": "PAC",
"volumeQuantity": 1,
"addressDelivery": {
"name": "Maria Souza",
"address": "Rua das Flores",
"number": "100",
"city": "Curitiba",
"district": "Centro",
"postalCode": "80010000",
"province": "PR"
},
"volumes": [
{
"volume": {
"service": "PAC",
"estimatedShippingValue": 25.90,
"declaredValue": 199.80,
"dimensions": {
"weight": 0.6,
"height": 10,
"width": 20,
"length": 30
}
}
}
]
}
}Exemplo: criar um produto
POST /webapi/product/{slug}
{
"code": "SKU-001",
"gtin": "7891234567890",
"description": "Camiseta Branca P",
"is_active": true,
"external_stock": 100,
"minimal_stock": 5,
"published_stock": 95,
"unitary_value": 99.90,
"url_image": "https://exemplo.com/img/sku-001.jpg",
"weight": 0.3
}Exemplo: mapear estoque
POST /webapi/product/stock/{slug} — todos os campos são obrigatórios.
{
"code": "SKU-001",
"address": "A-01-02-03",
"quantity": 50
}Listagem e filtros de pedidos
A rota GET /webapi/order/{slug} aceita paginação pelo parâmetro page (padrão: 1) e diversos filtros opcionais via query string, entre eles:
-
order,order_source_number,invoice_number,tracking_code— busca por identificadores. -
client_document,postal_code,item_code,item_gtin,batch— busca por cliente, item ou lote. -
order_date_gte/order_date_lte,dispatch_at_gte/dispatch_at_lte,integrated_at_gte/integrated_at_lte— filtros por intervalo de datas (formatoAAAA-MM-DD). -
without_label_tracking— booleano para pedidos sem etiqueta/rastreio.
Exemplo:
curl -X GET \
"https://sandbox.enviando.stage.nordware.io/webapi/order/minhaconta?page=1&order_date_gte=2026-06-01&order_date_lte=2026-06-30" \
-H "Authorization: Bearer SEU_TOKEN"Códigos de resposta
| Código | Significado |
|---|---|
| 200 | Requisição processada com sucesso |
| 401 | Token ausente ou inválido |
| 404 | Recurso não encontrado (conta, pedido ou produto inexistente) |
| 422 | Erro de validação — confira os campos obrigatórios e os formatos enviados |
Motor GraphQL
Para consultas avançadas, o Enviando expõe um endpoint GraphQL em /webapi/graphql. Na aba Headers, adicione: { "Authorization": "Bearer SEU_TOKEN" }.
Referência completa (Swagger)
A especificação interativa com todos os campos e modelos está disponível no Swagger:
https://sandbox.enviando.stage.nordware.io/webapi/swagger
Suporte
Para solicitar o token de acesso ou tirar dúvidas sobre a integração, entre em contato com o nosso suporte.