Correios Automático Para desenvolvedores

API do Correios Automático e do PRO: ações, filtros, rotas REST e metadados para plugins de nota fiscal, ERPs e marketplaces.

Correios Automático 1.14.0PRO 1.6.4REST infixs-correios-automatico/v1WP 6.0+ · PHP 7.4+ · HPOSGuia de instalaçãoPlugin no WordPress.orgCorreios Automático PRO
Visão geral

Plugins de nota fiscal, ERPs e marketplaces se conectam ao Correios Automático (grátis, no WordPress.org) e ao Correios Automático PRO por ações e filtros PHP, rotas REST do namespace infixs-correios-automatico/v1 e metadados do pedido. A NF-e da sua integração viaja com o objeto, a pré-postagem automática do PRO espera a nota, o armazém Correios LOG+ recebe o XML e o rastreio volta para o seu sistema.

Comece pelos Primeiros passos e vá direto ao guia de integração com NF-e na pré-postagem. A referência lista cada ação, filtro, rota e metadado, com o arquivo e a linha no código da versão indicada.

Selos usados na referência: ação filtro GET POST DELETE · Grátis PRO. Tudo o que não traz o selo PRO funciona no plugin grátis. Abaixo de cada gancho e de cada rota está o arquivo e a linha onde ele aparece no código da versão indicada, para você ler o docblock completo no código.

Tópicos

IntroduçãoPrimeiros passosTudo o que um plugin precisa para conversar com o Correios Automático: detectar o plugin, registrar os ganchos no momento certo e seguir as convenções de nomes e de pedidos.GuiasIntegração com NF-e na pré-postagemCom poucos ganchos, o seu plugin de nota fiscal ou ERP entrega a NF-e à pré-postagem do Correios Automático: o objeto sai com a nota da loja no lugar da DC-e, a pré-postagem automática do PRO espera a nota, a etiqueta imprime a DANFE simplificada, a lista de pedidos mostra o status da nota, a devolução reaproveita o documento da ida e o armazém Correios LOG+ recebe o XML. Integrações como SquidCore e Bling já funcionam assim.ReferênciaAções (eventos)Eventos para o seu plugin reagir ao que acontece no Correios Automático, e os dois eventos que o seu plugin dispara para avisar sobre a NF-e.ReferênciaFiltrosPontos para o seu plugin ajustar valores e decisões do Correios Automático. Todos seguem add_filter( $nome, $callback, $prioridade, $argumentos ): devolva sempre um valor do tipo esperado e, quando a decisão não for sua, o valor recebido.ReferênciaAPI RESTAs rotas do namespace infixs-correios-automatico/v1 atendem o painel do plugin e integrações de fora do WordPress. Base: https://sua-loja.com.br/wp-json/infixs-correios-automatico/v1. Em sites com /wp-json/ desativado, use https://sua-loja.com.br/index.php?rest_route=/infixs-correios-automatico/v1/….ReferênciaMetadadosOs metadados que o Correios Automático lê e grava. O seu plugin grava só os dois da NF-e; os demais servem para leitura. Use sempre os métodos do pedido (get_meta, update_meta_data, save), que funcionam com HPOS.RecursosBoas práticas e suporteO que deixa uma integração rápida, previsível e fácil de dar suporte.