Pedidos
Permite adicionar novos pedidos ou consultar pedidos existentes.
Propriedades
Pedido
| Nome | Descrição | Tipo | Tamanho | Obrigatório | Obs
|
| numero | Número do pedido | number | 9 | N |
|
| data | Data do pedido no formato ISO 8601 'YYYY-MM-DD"T"HH:MI:SS TZH:TZM' | string | 10 | N |
|
| vlTotal | Valor total | number | 20,10 | S |
|
| vlDesconto | Valor do Desconto | number | 20,10 | S |
|
| vlAcrescimo | Valor de Acréscimo | number | 20,10 | N |
|
| vlFrete | Valor de Frete | number | 20,10 | N |
|
| tipoPagamento | AV (A vista) - AP (A prazo) | string | 2 | S |
|
| enderecoEntrega | Endereço de Entrega | string | 50 | S |
|
| bairroEntrega | Bairro de Entrega | string | 30 | S |
|
| cepEntrega | CEP de Entrega | string | 9 | S |
|
| idCidadeEntrega | Id da Cidade de Entrega | number | 12 | N |
|
| codIbgeCidadeEntrega | Código do IBGE da cidade de entrega | number | 8 | N |
|
| cidadeEntrega | Descrição da cidade | string | 50 | N |
|
| ufCidadeEntrega | UF da cidade | string | 2 | N |
|
| cnpjIntermediador | CNPJ do Intermediador | string | 18 | N |
|
| cliente | Cliente do pedido | Cliente | - | S |
|
| itens | Itens do Pedido | array(ItemPedido) | - | S |
|
| mensagens | Mensagens do Pedido | array(Mensagem) | - | N |
|
| parcelas | Parcelas do Pedido | array(Parcela) | - | N |
|
| situacao | Situação do Pedido | string | 100 | N | "Rascunho", "Aguardando Aceite", "Em Aberto", "Bloqueado", "Cancelado", "Liberado para Faturamento" e "Liquidado"
|
| statusSeparacao | Status de separação do Pedido | string | 100 | N | "Aguardando Envio para Separação", "Aguardando Início de Separação", "Em Separação", "Separação Concluída"
|
| numeroPedidoOrigem | Número do Pedido de Origem | string | 20 | N |
|
| obs | Obs do Pedido | string | 2000 | N |
|
| origem | Origem do Pedido | string | 20 | N |
|
| links | Referências a recursos relacionados ao pedido, como o arquivo de comartilhamento (XML NFE) | Array | | N |
|
| contato | Contato Pedido | Contato | - | N | A partir da versão 811 |
Cliente
| Nome | Descrição | Tipo | Tamanho | Obrigatório | Obs
|
| nomeRazaoSocial | Nome/Razão Social do cliente | string | 100 | S |
|
| nomeFantasia | Nome/Fantasia do cliente | string | 30 | S |
|
| cpfCnpj | CPF/CNPJ do cliente | string | 18 | S |
|
| tipoPessoa | F (Física) ou J (Jurídica) | string | 1 | S |
|
| rgInscEst | RG/Inscrição Estadual | string | 25 | S |
|
| idCidade | Id da Cidade | number | 12 | S |
|
| codIbge | Código do IBGE da cidade | number | 8 | S |
|
| cidade | Descrição da cidade | string | 50 | S |
|
| uf | UF da cidade | string | 2 | S |
|
| endereco | Endereço do cliente (rua, número) | string | 50 | S |
|
| bairro | Bairro do cliente | string | 30 | S |
|
| referencia | Referência para o endereço | string | 50 | N |
|
| cep | Cep do cliente | string | 9 | S |
|
| email | E-Mail do cliente | string | 100 | S |
|
| fone1 | Fone1 do cliente | string | 15 | S |
|
| fone2 | Fone2 do cliente | string | 15 | N |
|
| classificacaoICMS | Código da Classificação de ICMS | String | 3 | N | A partir da versão 811
|
| consumidorFinal | S (Sim) ou N (Não) | string | 1 | N | A partir da versão 811 |
ItemPedido
| Nome | Descrição | Tipo | Tamanho | Obrigatório | Obs
|
| produto | código do produto do item | string | 25 | S |
|
| quantidade | Quantidade do item | number | 20,10 | S |
|
| unidade | Unidade do item | string | 3 | N | A partir da versão 813
|
| vlUnitarioBruto | Valor Unitário Bruto | number | 20,10 | N | Verificar disponibilidade na API
|
| percDescVlUnitario | Perc. Desconto do Valor Unitário | number | 8,5 | N | Verificar disponibilidade na API
|
| codTabpreco | Código da Tabela de Preços | number | 4 | N |
|
| vlUnitario | Valor Unitário do item | number | 20,10 | S |
|
| vlTotal | Valor Total do item | number | 20,10 | S |
|
| codCultura | Código da Cultura | number | 6 | N | Verificar disponibilidade na API
|
| codDiagnostico | Código do Diagnóstico | number | 6 | N | Verificar disponibilidade na API
|
| safra | Safra | string | 5 | N | Verificar disponibilidade na API
|
| dtPrevEntrega | Data de Previsão de entrega | date | - | N | Verificar disponibilidade na API
|
Mensagem
| Nome | Descrição | Tipo | Tamanho | Obrigatório
|
| sequencia | Sequência da mensagem | number | 2 | S
|
| texto | Texto da mensagem | string | 500 | S |
Parcela
| Nome | Descrição | Tipo | Tamanho | Obrigatório
|
| sequencia | Sequência da parcela | number | 3 | S
|
| vencimento | Vencimento da parcela | date | - | S
|
| valor | Valor da parcela | number | 20,10 | S |
Contato
| Nome | Descrição | Tipo | Tamanho | Obrigatório | Obs
|
| nome | Nome da pessoa de contato | String | 100 | S |
|
| fone | Fone da pessoa de contato | String | 18 | N |
|
| email | E-mail da pessoa de contato | String | 100 | N |
|
| funcao | Função da pessoa de contato | String | 50 | N | |
Endpoints
GET /api/pedidos
Retorna uma lista de pedidos
Parâmetros
| Nome | Descrição | Tipo
|
| empresa | Código da Empresa | number
|
| situacao | Situação do Pedido (Em Aberto, Aguardando Aceite, Cancelado, Liberado para Fat, Liquidado, Bloqueado) | string
|
| modificadosApos | Data de modificação do registro (formato ISO 8601 'YYYY-MM-DD"T"HH:MI:SS TZH:TZM'). Retorna todos os registros com data/hora de alteração posterior ao parâmetro | date |
Exemplo
curl --request GET \
--url ${URL_BASE}/api/pedidos \
--header 'Accept: application/json' \
--header 'Authorization: ${TOKEN}' \
--insecure
HTTP/1.1 200 OK
[
{
"id": 165798,
"empresaM": 1,
"empresa": 4,
"nrDocto": 23641,
"dtEmissao": "2009-07-14T00:00:00-03:00",
"dataSaida": "2009-07-14T00:00:00-03:00",
"aVista": "S",
"vlBruto": 119.55,
"vlIpi": 0,
"vlFrete": 0,
"vlDesc": 0,
"vlDocto": 119.55,
"idCliente": 24800,
"nome": "Consumidor Final",
"endereco": "Rua dos Pinguins, 345",
"bairro": "Centro",
"cidade": "ERECHIM",
"uf": "RS",
"enderecoEntrega": null,
"bairroEntrega": null,
"cepEntrega": null,
"idCidadeEntrega": null,
"cidadeEntrega": null,
"ufEntrega": null,
"cnpjIntermediador": null,
"dataModificacao": "2020-11-14T14:05:15-02:00",
"situacao": "Liberado para Fat"
}
]
GET /api/pedidos/{id}
Retorna o pedido do id solicitado.
Exemplo
curl --request GET \
--url ${URL_BASE}/api/pedidos/165798 \
--header 'Accept: application/json' \
--header 'Authorization: ${TOKEN}' \
--insecure
HTTP/1.1 200 OK
{
"id": 165798,
"empresaM": 1,
"empresa": 4,
"nrDocto": 23641,
"dtEmissao": "2009-07-14T00:00:00-03:00",
"dataSaida": "2009-07-14T00:00:00-03:00",
"aVista": "S",
"vlBruto": 119.55,
"vlIpi": 0,
"vlFrete": 0,
"vlDesc": 0,
"vlDocto": 119.55,
"idCliente": 24800,
"nome": "Consumidor Final",
"endereco": "Rua dos Pinguins, 345",
"bairro": "Centro",
"cidade": "ERECHIM",
"uf": "RS",
"enderecoEntrega": null,
"bairroEntrega": null,
"cepEntrega": null,
"idCidadeEntrega": null,
"cidadeEntrega": null,
"ufEntrega": null,
"cnpjIntermediador": null,
"dataModificacao": "2020-11-14T14:05:15-02:00",
"situacao": "Liberado para Fat"
}
POST /api/pedidos
Envia um pedido. Retorna o id do Pedido criado no ERP.
Os dados do cliente são enviados diretamente no pedido. Caso já exista cliente cadastrado com esse CPF/CNPJ, este será utilizado, do contrário será criado um cliente com os dados enviados.
Exemplo
curl --request POST \
--url ${URL_BASE}/api/pedidos \
--header 'Accept: application/json' \
--header 'Authorization: ${TOKEN}' \
--insecure
--data '{
"numero": 99998,
"data": "2019-07-23T11:39:17.865Z",
"vlTotal": 200,
"vlDesconto": "10.00",
"cnpjIntermediador": "07.884.965/0001-33",
"cliente": {
"nomeRazaoSocial": "Toyoko Santos",
"nomeFantasia": "Toyoko Santos",
"cpfCnpj": "08396130086",
"rgInscEst": "ISENTO",
"tipoPessoa": "F",
"codIbge": "4307005",
"cidade": "Erechim",
"uf": "RS",
"endereco": "Rua ABC, 123",
"bairro": "Bairro",
"referencia": "Apto 1",
"cep": "99700000",
"email": "tsantos@wonder.com.br",
"fone1": "99999999",
"fone2": "35203500",
"consumidorFinal": "S",
"classificacaoICMS": "NC"
},
"contato": {
"nome": "Alice",
"fone": "(54) 99991-8881",
"email": "alice@wonder.com.br",
"funcao": "Comprador"
},
"itens": [{
"produto": "590",
"quantidade": 2,
"vlUnitario": 100,
"vlTotal": 200
}],
"mensagens": [{
"sequencia": "1",
"texto": "mensagem do pedido para o movimento"
}],
"parcelas": [{
"sequencia": "1",
"vencimento": "2021-08-09T00:00:00-03:00",
"valor": "50.00"
},
{
"sequencia": "2",
"vencimento": "2021-08-20T00:00:00-03:00",
"valor": "50.00"
},
{
"sequencia": "3",
"vencimento": "2021-08-30T00:00:00-03:00",
"valor": "90.00"
}
]
}'
HTTP/1.1 201 OK
{
"id": 617387
}
POST /api/pedidos/{id}/cancelar
Cancela um pedido existente.
- É necessário que o pedido a ser cancelado tenha sido criado pelo mesmo usuário que solicitará o cancelamento.
- O pedido também precisa estar em situaçao "Aguardando Aceite" ou "Rascunho", ou seja, ainda não ter sido processado no ERP.
- O integrador precisa enviar juntamente com o id do pedido a ser cancelado o id da justificativa de cancelamento e o motivo de cancelamento.
Parâmetros
| Nome | Descrição | Tipo | Tamanho | Obrigatório
|
| idJustificativa | Id da justificativa de cancelamento | number | 12 | S
|
| motivo | Motivo específico para cancelamento deste pedido | string | 1000 | S |
Exemplo
curl --request POST \
--url ${URL_BASE}/api/pedidos/555555/cancelar \
--header 'Accept: application/json' \
--header 'Authorization: ${TOKEN}' \
--insecure
--data '{
"idJustificativa": 30,
"motivo": "Marketplace notificou falta de estoque para este pedido"
}'
HTTP/1.1 200 OK
{
"mensagem": "Cancelado com sucesso"
}