Listar Lojistas

Retorna a lista de comerciantes sob sua conta, com suporte a paginação e ordenação.

Endpoint

GET/v1/merchants

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
cursor	string	—	Token de paginação retornado pela resposta anterior. Omitir na primeira página.
limit	integer	—	Itens por página (padrão: 20, máximo: 100)
order_by	string	—	Campo utilizado para ordenação (ex.: created_at)
sort	string	—	Direção da ordenação: ASC ou DESC

Request

curl -X GET https://yby-dev.positivolabs.com.br/v1/merchants \
  -H "Authorization: Bearer <accessToken>" \
  -G \
  --data-urlencode "limit=20" \
  --data-urlencode "order_by=created_at" \
  --data-urlencode "sort=DESC"

Resposta

{
  "metadata": {
    "cursor": "d6uo5nc42nrc73gv867g",
    "limit": 20
  },
  "data": [
    {
      "id": "d6uo5nc42nrc73gv867g",
      "createdAt": "2026-03-20T10:00:00Z",
      "updatedAt": "2026-03-20T10:00:00Z",
      "type": "merchant",
      "dbaName": "Coffee Shop LTDA",
      "corporateName": "Coffee Shop Comércio LTDA",
      "taxId": "12345678000190",
      "parentId": "d59gpddc93gc73jvje0g",
      "merchantCategoryCode": "5347",
      "economicActivityCode": "4712100",
      "address": {
        "id": "d6uo5nc42nrc73gv8680",
        "postalCode": "01234567",
        "state": "SP",
        "city": "São Paulo",
        "neighborhood": "Centro",
        "street": "Rua das Flores",
        "number": "123",
        "country": "BR"
      },
      "contact": {
        "id": "d6uo5nc42nrc73gv8681",
        "email": "contact@coffeeshop.com",
        "phone": "+5511999999999"
      }
    }
  ]
}