Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta de fornecedores.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Fornecedor

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

IdFornecedor

Lista de identificadores de fornecedores

array[integer]Não há.
CpfCnpjFornecedor

Lista de CPF/CNPJ de fornecedores

array[integer]Não há.
DtaHorAlteracaoData e hora da alteração.string($date-time)

Não há.

StatusOpções de Status para filtro.stringOpções: A - Ativo / I - Inativo
ExpandOpção de expandir.

string

Não há.
FieldsCampos.stringNão há.
OrderOrdenação dos campos.stringNão há.

Page

Número da página.integer($int32)Não há.
PageSizeTamanho da página.integer($int32)Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "idFornecedor": 0,
      "tipo": "string",
      "microEmpresa": "string",
      "condicaoFrete": "string",
      "status": "string",
      "dadosAdicionais": "string",
      "pessoa": {
        "idPessoa": 0,
        "nomeRazaoSocial": "string",
        "fantasia": "string",
        "tipoPessoa": "string",
        "sexo": "string",
        "status": "string",
        "nomeCidade": "string",
        "ufCidade": "string",
        "paisCidade": "string",
        "nomeBairro": "string",
        "descricaoLogradouro": "string",
        "numeroLogradouro": "string",
        "complementoLogradouro": "string",
        "cep": "string",
        "telefoneDDD1": "string",
        "telefoneNumero1": "string",
        "telefoneComplemento1": "string",
        "telefoneDDD2": "string",
        "telefoneNumero2": "string",
        "telefoneComplemento2": "string",
        "telefoneDDD3": "string",
        "telefoneNumero3": "string",
        "telefoneComplemento3": "string",
        "numeroCPFCNPJ": 0,
        "digitoCPFCNPJ": 0,
        "inscricaoEstadualRG": "string",
        "email": "string",
        "homePage": "string",
        "estadoCivil": "string",
        "contribuinteICMS": "string",
        "produtorRural": "string",
        "microEmpresa": "string",
        "inscricaoProdutorRural": "string",
        "numeroCNPJProdutorRural": 0,
        "digitoCNPJProdutorRural": 0,
        "produtorRuralComCPF": "string",
        "numeroCPFProdutorRural": 0,
        "digitoCPFProdutorRural": 0
      },
      "fornecedorDivisao": [
        {
          "idDivisao": 0,
          "numeroRegimeTributacao": 0,
          "idComprador": 0,
          "prazoMedioVisita": 0,
          "prazoMedioEntrega": 0,
          "prazoMedioAtrasoEntrega": 0,
          "prazoPagamento": "string",
          "formaPagamento": "string",
          "valorMinimoPedidoCompra": 0,
          "classificacaoComercialABC": "string",
          "status": "string",
          "tipoDataBaseVencimento": "string",
          "tipoValorMinimo": "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
    }
  ]
}