Consultar clientes

Diferente do resto da integração, essas rotas são síncronas: a resposta traz os dados na hora, sem operationId nem webhook.

Listar clientes


GET /v1/Clients

Parâmetro	Tipo	Obrigatório	Descrição
`document`	string	não	CPF do cliente
`email`	string	não	E-mail do cliente
`page`	int	não	Página dos pedidos (padrão `1`)
`pageSize`	int	não	Tamanho da página (padrão `10`)


curl "$GROCERS_API/v1/Clients?document=12345678900&pageSize=5" \
  -H "Authorization: Basic $BASIC" \
  -H "x-contractAccountId: $TENANT"

A paginação se aplica aos pedidos de cada cliente, não à lista de clientes. Um cliente com 200 pedidos volta com os 10 primeiros por padrão.

Consultar um cliente


GET /v1/Clients/{clientId}

clientId é o GUID do cliente. Aceita os mesmos page e pageSize.


curl "$GROCERS_API/v1/Clients/f98228c0-1e49-47bf-d1a9-08dd0a764110" \
  -H "Authorization: Basic $BASIC" \
  -H "x-contractAccountId: $TENANT"

Formato da resposta

Ambas devolvem o cliente com seus pedidos aninhados — a lista devolve um array desses objetos, a consulta por id devolve um só:


{
  "user": {
    "id": "f98228c0-1e49-47bf-d1a9-08dd0a764110",
    "firstName": "João",
    "lastName": "Silva",
    "email": "joao.silva@email.com",
    "document": "12345678900",
    "phoneDDI": "55",
    "phoneNumber": "21999999999",
    "birthDate": "1997-01-13",
    "active": true,
    "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5"
  },
  "orders": [
    {
      "id": "19cc15c4-004d-4aa9-b058-08dd4f63c168",
      "status": 300,
      "number": 1000401,
      "createdAt": "2025-02-20T20:26:48.823269",
      "items": [
        {
          "orderedQuantity": 2,
          "name": "Arroz Branco Prato Fino 1kg",
          "sku": {
            "ean": "7896891504153",
            "reference": "12345",
            "unitOfMeasure": "Un",
            "arithmeticFactor": 1
          },
          "salePrice": 24.58,
          "totalPerProduct": 49.16
        }
      ],
      "orderStatusRegistry": [
        { "orderId": "19cc15c4-004d-4aa9-b058-08dd4f63c168", "status": 1 },
        { "orderId": "19cc15c4-004d-4aa9-b058-08dd4f63c168", "status": 100 },
        { "orderId": "19cc15c4-004d-4aa9-b058-08dd4f63c168", "status": 200 },
        { "orderId": "19cc15c4-004d-4aa9-b058-08dd4f63c168", "status": 300 }
      ],
      "shippingPolicy": { "name": "Mais Rápido - 2h" },
      "subtotal": {
        "subtotal": 49.16,
        "discount": 0,
        "couponDiscount": 0,
        "frete": 14,
        "isFreeShipping": false,
        "total": 63.16
      },
      "deliveryType": "ExpressDelivery",
      "canBeCancelled": false
    }
  ]
}