Pedido

Busca de Pedidos

Lê uma lista de Pedidos com base no filtro informado na URL da requisição.

get/api/comercial/v1/pedido

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/comercial/v1/pedido
  • Auth: HTTP bearer

Query parameters

IdFilialstring
Numerostring
Codigostring
SituacoesRadarAPIModelComercialDtosV1PedidoEnumsTipoSituacaoPedidoDto[]
SituacoesProducaoRadarAPIModelComercialDtosV1PedidoEnumsTipoSituacaoProducaoPedidoDto[]
OrigemRadarAPIModelComercialDtosV1PedidoEnumsOrigemPedidoDto[]
DataPedidoInicialstring date
DataPedidoFinalstring date
DataPedidoEntregaInicialstring date
DataPedidoEntregaFinalstring date
DataHoraBaseAlteracaostring date-time
IdClientestring
IdClientesstring[]
IdRepresentantesstring[]
IdVendedoresstring[]
IdTransportadorasstring[]
idProdutostring nullable
idItemGrade1string nullable
idItemGrade2string nullable
idItemGrade3string nullable
IdServicosstring[]
IdNaturezaOperacaoProdutosstring[]
IdNaturezaOperacaoServicosstring[]
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

Response

OK

idstring nullable
codigoIntegradorstring nullable
numerostring nullable
codigostring nullable
idFilialstring nullable
dataEmissaostring date
dataEntregastring date
dataCompetenciastring date
dataHoraGravacaostring date-time
dataHoraUltimaAlteracaostring date-time
dataHoraCancelamentostring date-time
indicadorPresencaComprador'NaoSeAplica' | 'OperacaoPresencial' | 'OperacaoNaoPresencialInternet' | 'OperacaoNaoPresencialTeleatendimento' | 'NfceEmOperacaoEntregaDomicilio' | 'OperacaoPresencialForaEstabelecimento' | 'OperacaoNaoPresencialOutros'
situacao'EmAnalise' | 'Bloqueado' | 'Pendente' | 'Cancelado' | 'ParcialmenteFaturado' | 'Faturado' | 'ParcialmenteAtendido' | 'Atendido'
situacaoProducao'EmProducao' | 'ParcialmenteEmProducao' | 'SemStatusDaProducao'
idClientestring nullable
idContatostring nullable
consumidorFinal'Normal' | 'ConsumidorFinal'
idOperacaoComercialstring nullable
idNaturezaOperacaoProdutostring nullable
idNaturezaOperacaoServicostring nullable
idClassificacaostring nullable
numeroOrdemComprastring nullable
idFluxoPedidostring nullable
idFluxoPedidoItemstring nullable
observacaostring nullable
tipoRateio'RateioPeloTotalDoPedido' | 'RateioPorItem'

Changes

No recorded changes to this operation across all 1 revision of this API.