Partners

A query partners retorna informações de parceiros, podendo ser filtrada por nomes ou tabelas de preço específicos.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
Parâmetros de paginação		Sim	Parâmetros utilizados na paginação por cursor
names	[String]	Não	Lista de nomes de parceiros específicos a serem buscados
priceTableIds	[Int]	Não	Lista de IDs de tabelas de preço específicas a serem buscadas
sortDirection	Enum SortDirection	Não	Direção de ordenação. Por padrão é ASC
sortKey	Enum PartnerSortKeys	Não	Chave de ordenação. Por padrão é ID

Campos

Campo	Descrição
alias	Alias do parceiro
endDate	Data de expiração do parceiro
logoUrl	URL da imagem de logo associada ao parceiro
name	Nome do parceiro
origin	Origem do parceiro
partnerAccessToken	Token do parceiro (também utilizado em outras queries)
partnerId	ID de cadastro do parceiro
portfolioId	ID do portfolio associado ao parceiro
priceTableId	ID da tabela de preço associada ao parceiro
startDate	Data de início do parceiro
type	Tipo do parceiro

Exemplos

Exemplo 1

Neste exemplo são pedidas informações dos 2 primeiros parceiros:

query {
  partners(first:2){
    edges{
      node{
        partnerId
        name
        startDate
        endDate
        priceTableId
        portfolioId
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "partners": {
      "edges": [
        {
          "node": {
            "partnerId": 79,
            "name": "Parceiro-Aberto",
            "startDate": "2016-06-03T16:27:00.000-03:00",
            "endDate": "2022-10-01T16:24:00.000-03:00",
            "priceTableId": 99,
            "portfolioId": 0
          }
        },
        {
          "node": {
            "partnerId": 82,
            "name": "Parceiro Aberto Teste",
            "startDate": "2018-10-18T11:21:00.000-03:00",
            "endDate": "2020-10-22T11:21:00.000-03:00",
            "priceTableId": 73,
            "portfolioId": 0
          }
        }
      ]
    }
  }
}

Exemplo 2

Pedido do partnerAccessToken de um parceiro associado a uma tabela de preços específica:

query {
  partners(first:1, priceTableIds:[99]){
    edges{
      node{
        partnerId
        name
        partnerAccessToken
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "partners": {
      "edges": [
        {
          "node": {
            "partnerId": 79,
            "name": "Parceiro-Aberto",
            "partnerAccessToken": "wbwc8cneC77PLgs44euLOr89WZspsY5qou4bb02PiyTgUhCW4JGtOO7X67uejqPuYu7+cvGL9Aaq8sBgMX2QfuiOSpZ5vZU2jP1wnrFkL3/hH79K2cU12zWPiT3Xb5lk"
          }
        }
      ]
    }
  }
}

Exemplo 3

Pedido de informações de um parceiro por um nome específico:

query {
  partners(first:1, names:["Parceiro-Aberto"]){
    edges{
      node{
        partnerId
        priceTableId
        portfolioId
        type
        startDate
        endDate
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "partners": {
      "edges": [
        {
          "node": {
            "partnerId": 79,
            "priceTableId": 99,
            "portfolioId": 0,
            "type": "Aberto",
            "startDate": "2016-06-03T16:27:00.000-03:00",
            "endDate": "2022-10-01T16:24:00.000-03:00"
          }
        }
      ]
    }
  }
}