Presence API - PEDIDOS

Presence API - PEDIDOS

Cabeçalho dos Pedidos de Venda

Este módulo é responsável por listar os pedidos da base da dados.

Parâmetros

Nome
Obrigatório
Tipo
Descrição
serie
NÃOInteiroNúmero da série do pedido.
numero
NÃOInteiroNúmero do pedido cadastrado na loja.
loja
NÃO
Texto(2)
Código da Loja
codigoPedidoExterno
NÃO
Texto
Número do pedido no sistema terceiro.
situacao
NÃO
Inteiro
1 - Em Edição
2 - Registrado
3 - Aprovado
4 - Bloqueado
5 - Com faturamento
6 - Concluído
7 - Cancelado
data_at
SIM quando não informado demais filtros
Data (AAAA-MM-DDT00:00:00)
Data de inicial de atualização dos dados. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_at_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de atualização dos dados. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_cadastro_ini
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de inicial de cadastro do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_cadastro_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de cadastro do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_aprovacao_ini
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de inicial de aprovação do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_aprovacao_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de aprovação do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_separacao_ini
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de inicial de separação do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_separacao_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de separação do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_bloqueio_ini
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de inicial de bloqueio do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_bloqueio_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de bolqueio do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_cancelamento_ini
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de inicial de cancelamento do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.
data_cancelamento_fim
NÃO
Data (AAAA-MM-DDT00:00:00)
Data de final de cancelamento do pedido. Padrão ISO8601. Caso o período seja a mesma data, deve-se informar a hora também.



BODY
  1. {
  2.   "data_at" : (Date, AAAA-MM-DD) ou (Date, AAAA-MM-DDT00:00:00)
  3. }
OU
  1. {
  2.   "loja" : (String)
  3. }
OU
  1. {
  2.   "serie" : (Integer),
  3.   "numero" : (Integer)
  4. }
OU
  1. {
  2.   "codigoPedidoExterno" : (String)
  3. }
OU (igual para todos os demais filtros de data)
  1. {
  2.   "data_cadastro_ini" : (Date, AAAA-MM-DD) ou (Date, AAAA-MM-DDT00:00:00),
  3.   "data_cadastro_fim" : (Date, AAAA-MM-DD) ou (Date, AAAA-MM-DDT00:00:00)
  4. }

JSON de Retorno
  1. {
  2.     "status": "ok",
  3.     "method": "PEDIDOS",
  4.     "data": [
  5.         {
  6.             "codSituacao": Integer,
  7.             "situacao": String,
  8.             "codSeparacao": Integer,
  9.             "separacao": String,
  10.             "serie": String,
  11.             "numero": Integer,
  12.             "descontoTotal": Double, (pode ser negativo)
  13.             "frete": Double,
  14.             "ipi": Double,
  15.             "valorLiquido": Double,
  16.             "valorTotal": Double,
  17.             "cpfCliente": String,
  18.             "nomeCliente": String,
  19.             "enderecoEntrega": String,
  20.             "numeroEntrega": String,
  21.             "complementoEntrega": String,
  22.             "bairroEntrega": String,
  23.             "cidadeEntrega": String,
  24.             "estadoEntrega": String,
  25.             "cepEntrega": String,
  26.             "dataCadastro": Date, AAAA-MM-DD 00:00:00.000,
  27.             "dataAprovacao": Date, AAAA-MM-DD 00:00:00.000,
  28.             "dataSeparacao": Date, AAAA-MM-DD 00:00:00.000,
  29.             "dataBloqueio": Date, AAAA-MM-DD 00:00:00.000,
  30.             "dataCancelamento": Date, AAAA-MM-DD 00:00:00.000,
  31.             "dataAtualizacao": Date, AAAA-MM-DD 00:00:00.000,
  32.             "lojaExpedidora": String,
  33.             "lojaEmitente": String,
  34.             "origem": String,
  35.             "plataforma": String,
  36.             "marketplace": String,
  37.             "codigopedidoexterno": Integer
  38.         }
  39. }

Validação no Presence Domain

- Módulo Pedidos / Consulta Pedidos - Produtos