Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Listar associados já cadastrados, para a busca de dados que serão utilizados nas negociações da 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": "2023-01-12T17:45:36.430Z",
      "usuarioInclusao": "string",
      "dtaHrAlteracao": "2023-01-12T17:45:36.430Z",
      "usuarioAlteracao": "string",
      "status": "string",
      "qtdLojas": 0,       
      "associadoLojas": [
        {
          "seqAssociado": 0,
          "seqLoja": 0,
          "nroEmpresa": 0,
          "seqPessoa": 0,
          "nomeReduzido": "string",
          "indAssocMatriz": "string",
          "areaLoja": 0,
          "dtaInclusao": "2023-01-12T17:45:36.430Z",
          "usuInclusao": "string",
          "dtaAlteracao": "2023-01-12T17:45:36.430Z",
          "usuAlteracao": "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
    }
  ]
}