POST
https://www.allpost.com.br/api/v1/plp/novo

Cria PLP.

Módulo: PLP

Descrição

Crie uma nova PLP e inclua as NFe relacionadas durante o processo de envio.
Embora não existam restrições em relação ao número de Notas Fiscais Eletrônicas (NFes) que podem ser incluídas em uma Pré-Lista de Postagem (PLP), é altamente recomendável evitar a inclusão de um grande número de itens. Isso ocorre porque o tamanho do arquivo PDF gerado como retorno pode se tornar excessivamente grande, resultando em lentidão durante a consulta ou até mesmo em timeouts.

Caso seja necessário realizar o envio de um grande volume de NFes, é recomendável dividir a carga em várias PLPs menores, distribuindo as NFes de forma equilibrada entre elas. Essa abordagem ajudará a evitar o congestionamento do sistema e melhorará o desempenho durante a consulta das PLPs e o processamento das informações.

Portanto, é sempre prudente considerar a quantidade de itens incluídos em uma PLP, levando em conta o impacto potencial no tamanho do PDF de retorno e no desempenho geral do sistema. Ao adotar uma abordagem cuidadosa e eficiente, é possível evitar problemas relacionados à lentidão ou timeouts e garantir uma operação suave e eficaz no gerenciamento das NFes.

Atualmente, toda comunicação com sistemas de terceiros é realizada de forma síncrona. Quando o allPost está integrado e a conexão com a transportadora está ativa, é possível ocorrer lentidão nos processamentos. Isso ocorre devido ao processo do allPost, que envia informações para APIs de terceiros e aguarda o retorno.

Parâmetros de Entrada

Campo Descrição Tipo Tamanho Obrigatório
filialERP Código da Filial string 30 sim
listaChaveNFe Lista de chaves das NFe array sim

Parâmetros de Retorno

Campo Descrição Tipo Tamanho
mensagem Mensagem de retorno: sucesso string 255
idPLP Código da PLP que foi criada integer
status Situação da PLP: Pendente string 255
erros Lista de erros a serem corrigidos array|string 255
listaPedidos Lista de pedidos que compõem a PLP
documento Chave do pedido string 255
numeroPedido Seu número de pedido string 100
chaveNF Chave da Nota Fiscal string 44
idEnvio Código da Entrega integer
protocolo Código de rastreio de sistemas terceiros. Exemplo protocolo de rastreio dos Correios string 255
erros Lista erros de integração se houver string 255

Body

{
	"filialERP": "",
	"listaChaveNFe": [
		""
	]
}

Response

{
    "mensagem": "sucesso",
    "idPLP": 0,
    "status": "Pendente",
    "erros": [],
    "listaPedidos": [
        {
            "documento": "",
            "numeroPedido": "",
            "chaveNF": "",
            "idEnvio": 0,
            "protocolo": "",
            "erros": ""
        }
    ]
}