PUT
https://www.allpost.com.br/api/v1/pedido/altera/{filtro}/{valor}

Altera dados do pedido.

Módulo: Pedido

Descrição

Altera dados de um pedido. Exemplo:
- https://www.allpost.com.br/api/v1/pedido/altera/pedido/123
- https://www.allpost.com.br/api/v1/pedido/altera/notafiscal/555
- https://www.allpost.com.br/api/v1/pedido/altera/chavenf/32000000000000000000000000000000000000000000
- https://www.allpost.com.br/api/v1/pedido/altera/documento/a041e5fb6a3fdb9612b7X43000x0x000
- https://www.allpost.com.br/api/v1/pedido/altera/cotacaoid/00000000000

Parâmetros de Path

Campo Descrição Tipo Tamanho Obrigatório
filtro Nome do campo a ser filtrado. Pode ser utilizado:
- pedido
- notafiscal
- chavenf
- documento
- cotacaoid 		string sim
valor Informar o valor do filtro string sim

Parâmetros de Entrada

Campo Descrição Tipo Tamanho Obrigatório
pedidoAuxiliar Número adicional de controle string 100 não
envio Informações sobre o envio. Um pedido pode ter mais de um envio. array não
peso Peso total do envio em Quilos(Kg) numeric (9,3) não
altura Dimensões da embalagem que compõem o envio. Em centímetros (cm). numeric (9,3) não
largura Dimensões da embalagem que compõem o envio. Em centímetros (cm). numeric (9,3) não
profundidade Dimensões da embalagem que compõem o envio. Em centímetros (cm). numeric (9,3) não
quantidade Quntidade de produtos que compõem o envio. integer não
quantidadeVolumes Total de volumes que compõem o envio. integer não
codigoRastreio Código de rastreio do envio. Para transporte correios o campo é obrigatório o preenchimento. string 20 não
plp Código plp dos correios. integer não
urlRastreioExterno Se informado a url de rastreio o sistema irá redirecionar automaticamente o cliente para esta url. Se o pedido possuir mais de um envio o sistema irá criar botões para que o usuário possa clicar e ser redirecionado. text não
linkComprovanteEntrega Url do comprovante de entrega. text não
mapaDeCarga Código do mapa de carga gerado pelo seu ERP. string 255 não
prazoDeEntrega Prazo limite de entrega date não
nomeTransportadora Nome da transportadora: informar o nome apenas se houver troca de transportadora, ou seja, a cotação foi realizada por uma transportadora e enviada por outra. O nome tem que ser igual ao cadastrado no allPost. string 100 não
nomeMetodoEnvio Nome do método de envio: informar o nome apenas se houver troca de transportadora, ou seja, a cotação foi realizada por uma transportadora e enviada por outra. O nome tem que ser igual ao cadastrado no allPost. string 100 não
idMetodo Código do método do envio: informar o nome apenas se houver troca de transportadora, ou seja, a cotação foi realizada por uma transportadora e enviada por outra. integer não
notaFiscal Informações da nota fiscal do envio. object não
filialERP Informar o código da filial ERP (centro de distribuição de origem) string 30 não
pedidoERP Informar o número do pedido no ERP string 30 não
chave Chave da nota fiscal string 44 não
data Data do faturamento date não
valorTotal Valor total da nota fiscal numeric (9,2) não
valorTotalProdutos Valor total dos produtos numeric (9,2) não

Parâmetros de Retorno

Campo Descrição Tipo
retornos array contendo a lista de campos e seus respectivos retorno array
campo Nome do campo string
mensagem Mensagem de retorno string

Body

Apenas os campos abaixo são aceitos para edição. Caso não queria alterar alguma informação basta não informar o campo no json.
{
	"pedidoAuxiliar": "",
	"envio": [{
		"idMetodo": 0,
		"nomeTransportadora": "",
		"nomeMetodoEnvio": "",
		"peso": 0,
		"altura": 0,
		"largura": 0,
		"profundidade": 0,
		"quantidade": 0,
		"quantidadeVolumes": 0,
		"codigoRastreio": "",
		"plp": "",
		"urlRastreioExterno": "",
		"linkComprovanteEntrega": "",
		"mapaDeCarga": "",
		"prazoEntregaPedido": "",
		"notaFiscal": {
			"filialERP": "",
			"pedidoERP": "",
			"chave": "",
			"data": "",
			"valorTotal": 0,
			"valorTotalProdutos": 0
		}
	}]
}

Response

{
    "retornos": [
        {
            "campo": "envio.0.notaFiscal.filialERP",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.notaFiscal.pedidoERP",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.notaFiscal.chave",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.notaFiscal.data",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.notaFiscal.valorTotal",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.notaFiscal.valorTotalProdutos",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.nomeTransportadora",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.nomeMetodoEnvio",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.peso",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.altura",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.largura",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.profundidade",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.quantidade",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.quantidadeVolumes",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.codigoRastreio",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.mapaDeCarga",
            "mensagem": "já alterado"
        },
        {
            "campo": "envio.0.prazoEntregaPedido",
            "mensagem": "sucesso"
        },
        {
            "campo": "pedidoAuxiliar",
            "mensagem": "já alterado"
        }
    ]
}