Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Consultar a integração de dados da rede de associados.

Chamada

GET [URLAPI]/IntegradorAssociadosAPI/api/v1/Integracao/consultar-integracao-dados

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
SeqIntegracaoDadosIdentificador da integraçãonumber($double)Não há.
SeqAssociadoSequencial do associadointeger($int64)Não há.
OrigemOrigem da integraçãointeger($int32)Origem da requisição da integração: 1 - Manual, 2 - Serviço.
StatusStatus da integraçãointeger($int32)Status da integração: 1 - Executando, 2 - Finalizada, 3 - Erro.
DataInclusaoData da inclusão da replicaçãostring($date-time)Não há.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

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": [
    {
      "seqIntegracaoDados": 0,
      "associados": [
        {
          "seqAssociado": 0
        }
      ],
      "origem": 0,
      "status": 0,
      "erro": "string",
      "dtaHorInclusao": "2023-08-09T12:44:01.467Z",
      "detalhes": [
        {
          "seqIntegracaoDados": 0,
          "seqIntegracaoDadosDetalhe": 0,
          "seqAssociado": 0,
          "seqLoja": 0,
          "nroEmpresa": 0,
          "tipo": 0,
          "situacao": 0,
          "observacao": "string",
          "erro": "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
    }
  ]
}