Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de associados cadastrados na rede.

Chamada

GET [URLAPI]/IntegradorAssociadosAPI/api/v1/Associados

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NomeAssociadoDescrição do nome do AssociadostringNão há.
PagePáginas

integer($int64)

Não há.
PageSizeTamanho das páginasinteger($int64)Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - CREATED

{
  "hasNext": true,
  "items": [
    {
      "seqAssociado": 0,
      "nomeAssociado": "string",
      "urlAcessoServidor": "string",
      "usuarioAcessoServidor": "string",
      "senhaAcessoServidor": "string",
      "nroEmpresaAut": 0,
      "dtaHrInclusao": "2024-07-02T16:35:02.786Z",
      "usuarioInclusao": "string",
      "dtaHrAlteracao": "2024-07-02T16:35:02.786Z",
      "usuarioAlteracao": "string",
      "status": "string",
      "qtdLojas": 0,
      "associadoLojas": [
        {
          "seqAssociado": 0,
          "seqLoja": 0,
          "nroEmpresa": 0,
          "seqPessoa": 0,
          "nomeReduzido": "string",
          "indAssocMatriz": "string",
          "areaLoja": 0,
          "dtaInclusao": "2024-07-02T16:35:02.786Z",
          "usuInclusao": "string",
          "dtaAlteracao": "2024-07-02T16:35:02.786Z",
          "usuAlteracao": "string",
          "pessoa": {
            "idPessoa": 0,
            "fantasia": "string",
            "razao": "string",
            "pessoa": "string",
            "nroCgcCpf": "string",
            "digCgcCpf": "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
    }
  ]
}