Consulta Lojas de forma paginada

Requisição

Ambiente	Método	Endpoint
Sandbox	GET	`https://merchantapisandbox.cieloecommerce.cielo.com.br/merchants/paged?{documentnumber}&{email}&{pageSize}&{page}`
Homologação	GET	`https://merchantapisandbox.cieloecommerce.cielo.com.br/merchants/paged?{documentnumber}&{email}&{pageSize}&{page}`
Produção	GET	`https://merchantapi.cieloecommerce.cielo.com.br/merchants/paged?{documentnumber}&{email}&{pageSize}&{page}`

Query Parameters

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
email	String	45	Sim	Email de cadastro da loja
DocumentNumber	String	15	Não	Número do documento do lojista (CPF ou CNPJ sem máscara)
pageSize	Integer	3	Não	Quantidade de itens por página. Máximo de 100 por página.
page	Integer	—	Não	Página a ser retornada (usar quando houver múltiplas páginas)

{
  "Page": 1,
  "TotalPages": 1,
  "TotalElements": 2,
  "Content": [
    {
      "Owner": {
        "Name": "nome sobrenome",
        "Email": "[email protected]",
        "PhoneNumber": "1234567",
        "MessengerPhone": "1234567"
      },
      "SubordinatedMerchantId": "12345678-1234-1234-1234-123456789012",
      "Address": {
        "ZipCode": "999999",
        "Street": "endereco",
        "Number": "123",
        "Complement": ""
      },
      "TradeName": "nome descricao",
      "CompanyName": "nome da loja",
      "Email": "[email protected]",
      "PhoneNumber": "1234567",
      "Mcc": 412,
      "DocumentNumber": "1234567",
      "SoftDescriptor": "description 1",
      "DocumentType": "Cpf",
      "MerchantGroup": [
        {
          "Name": "grupo",
          "SubAcquirer": "SubAquirer",
          "Origin": "123",
          "Id": "123"
        }
      ],
      "MerchantGroupNames": ["name1", "name2"]
    },
    {
      "Owner": {
        "Name": "nome sobrenome",
        "Email": "[email protected]",
        "PhoneNumber": "1234567",
        "MessengerPhone": "1234567"
      },
      "SubordinatedMerchantId": "12345678-1234-1234-1234-123456789012",
      "Address": {
        "ZipCode": "999999",
        "Street": "endereco",
        "Number": "123",
        "Complement": ""
      },
      "TradeName": "nome descricao",
      "CompanyName": "nome da loja",
      "Email": "[email protected]",
      "PhoneNumber": "1234567",
      "Mcc": 412,
      "DocumentNumber": "1234567",
      "DocumentType": "Cpf",
      "SoftDescriptor": "description 2",
      "MerchantGroup": [
        {
          "Name": "grupo",
          "SubAcquirer": "SubAquirer",
          "Origin": "123",
          "Id": "123"
        }
      ],
      "MerchantGroupNames": ["name1", "name2"]
    }
  ],
  "Size": 10
}

Resposta

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
Page	Integer	—	Sim	Número da página atual
TotalPages	Integer	—	Sim	Quantidade total de páginas
TotalElements	Integer	—	Sim	Quantidade total de itens encontrados
Size	Integer	—	Sim	Quantidade de itens por página
Content.SubordinatedMerchantId	String (Guid)	36	Não
Content.Address.ZipCode	String	9	Sim	CEP
Content.Address.Street	String	120	Não	Localização
Content.Address.Number	String	9	Sim	Número do endereço
Content.Address.Complement	String	120	Não	Complemento do endereço
Content.TradeName	String	35	Sim	Nome fantasia
Content.CompanyName	String	35	Não	Razão social (obrigatório quando DocumentType = Cnpj)
Content.Email	String	45	Sim	Endereço de email da loja
Content.PhoneNumber	String	14	Sim	Telefone da loja
Content.Mcc	Integer	4	Sim	Ramo de atividade (MCC), obtido via tabela MCC
Content.DocumentNumber	String	20	Sim	CPF ou CNPJ da loja
Content.DocumentType	String	4	Sim	Enum: Cpf, Cnpj
Content.SoftDescriptor	String	13	Não	Descrição da fatura
Content.Owner.Name	String	50	Sim	Nome do proprietário
Content.Owner.Email	String	45	Sim	Email do proprietário
Content.Owner.PhoneNumber	String	14	Sim	Telefone do proprietário
Content.Owner.MessengerPhone	String	14	Sim	WhatsApp do proprietário
Content.MerchantGroup	array[string]	—	Não	Lista de objetos do tipo MerchantGroup
Content.MerchantGroup.Name	string	—	Sim	Nome do grupo
Content.MerchantGroup.SubAcquirer	string	—	Sim	Subadquirente
Content.MerchantGroup.Origin	string	—	Sim	Origem
Content.MerchantGroup.Id	string	—	Sim	Id do grupo do lojista
Content.MerchantGroupName	array[string]	—	Não	Lista de nomes dos grupos do lojista