Buscar dados de clientes e seus pedidos

Endpoint para buscar dados de clientes e seus pedidos de forma síncrona baseado em filtros como CPF e e-mail.

GET /v1/clients

Header

• Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
  • Exemplo: Basic <base64-encoded-credentials>
• x-contractAccountId: Identificador da conta do contrato do cliente.
  • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parâmetros da requisição

• page (int, opcional): Número da página de pedidos.
• pageSize (int, opcional): Tamanho da página de pedidos.
• document (string, opcional): CPF do cliente.
• email (string, opcional): E-mail do cliente.

Corpo da Requisição

A requisição não possui corpo.

Respostas

• 200: Retorna sucesso da operação. A resposta incluirá detalhes sobre o cliente e seus pedidos.
• 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de Resposta para Sucesso (200)

[
  {
    "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",
        "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5",
        "status": 300,
        "number": 1000401,
        "createdAt": "2025-02-20T20:26:48.823269",
        "updatedAt": "2025-02-25T12:50:28.6609645",
        "items": [
          {
            "orderedQuantity": 2,
            "id": "3ee3464e-919e-4a2f-1016-08dd03864ebc",
            "name": "Arroz Branco Prato Fino 1kg",
            "skuId": "4e2cb5e7-7bd1-4e94-61bd-08dd038649c3",
            "sku": {
              "id": "4e2cb5e7-7bd1-4e94-61bd-08dd038649c3",
              "name": "Arroz Branco Prato Fino 1kg",
              "ean": "7896891504153",
              "reference": "12345",
              "unitOfMeasure": 1,
              "arithmeticFactor": 1
            },
            "salePrice": 24.58,
            "totalPerProduct": 49.16,
            "imageURLs": [
              "https://example.com/images/arroz.jpg"
            ]
          }
        ],
        "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": {
          "id": "5062b4b8-a9e5-4546-f27c-08dd07e82e6f",
          "name": "Mais Rápido - 2h"
        },
        "subtotal": {
          "subtotal": 49.16,
          "discount": 0,
          "couponDiscount": 0,
          "frete": 14,
          "isFreeShipping": false,
          "total": 63.16
        },
        "deliveryType": 2,
        "canBeCancelled": false
      }
    ]
  }
]