Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para retornar uma lista de pedidos realizados no módulo de Compras do ERP.

Chamada

GET /api/v1/PedidoCompras/consulta-pedido-compra

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NroPedidoNúmero interno do pedido.

integer($int64)

Não há.
NroPedFornecedorNúmero do pedido do fornecedor.stringNão há.

DtaEmissaoInicio

Data de inicio em que o pedido foi emitido. Não pode ser maior que a Data Emissão Termino. Obrigatório.string($date-time)Não há.
DtaEmissaoTerminoData de termino em que o pedido foi emitido. Não pode ser menor que a Data Emissão Inicio. Obrigatório.string($date-time)Não há.
DtaReceberInicioData de inicio em que o pedido será recebido. Não pode ser maior do que a Data Receber Termino.string($date-time)Não há.
DtaReceberTerminoData de termino em que o pedido será recebido. Não pode ser menor que a Data Receber Inicio.string($date-time)Não há.
LoteNúmero do lote gerado pelo Gerenciador de Compras e Abastecimento Automático.

integer($int64)

Não há.
EmpresaNúmero da empresa do pedido, ou seja, empresa em que o pedido será entregue pelo fornecedor. Pode ser informada mais de uma empresa. Obrigatório.

array[integer]

Não há.
TipoPedidoTipo do pedido negociado com o fornecedor: 'C' = Compra, 'B' = Bonificação com incidência, 'E' = Bonificação sem incidência; 'T' = Transferência a receber; 'X' = Transferência a expedir; 'M' = Importação direta. Obrigatório.array[integer]Não há.
LocalEmissaoIndica qual foi o local de emissão do pedido, se foi em uma central ou loja: C - Central; L - Loja.stringNão há.
NroFornecedorNúmero único do fornecedor no módulo Compras - Linha Consincointeger($int64)Não há.
DocumentoFornecedorÉ o número do CNPJ ou CPF do fornecedor do pedido.stringNão há.
CompradorNúmero do comprador cadastrado no módulo Parâmetros - Linha Consinco.integer($int64)Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • Success (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS


[
 {
   "nroPedido": 0,
   "nroPedidoFornecedor": "string",
   "empresa": 0,
   "documentoEmpresa": "string",
   "tipoPedido": "string",
   "documentoFornecedor": "string",
   "razaoSocialFornecedor": "string",
   "fantasiaFornecedor": "string",
   "dataEmissao": "string",
   "dataRecebimento": "string",
   "valorTotal": "string",
   "valorCancelado": "string",
   "lote": 0,
   "nomeComprador": "string"
  }}}
 ]


application/json, text/json

CODE 400 - BAD

{
 "code": "string",
 "message": "string",
 "detailedMessage": "string",
 "helpUrl": "string",
 "details": [
   {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "notificationType": 0,
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "status": 0
    }
  ]
}
  • Sem rótulos