Buscar dados de um cliente com os seus pedidos

Endpoint para buscar dados de um cliente específico e seus pedidos de forma síncrona.

GET /v1/clients/{clientId}

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

• clientId (string, obrigatório): Identificador do cliente.
• page (int, opcional): Número da página de pedidos.
• pageSize (int, opcional): Tamanho da página de pedidos.

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": "0376d6b3-61ce-4192-f35c-08dd187dcd26",
      "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5",
      "status": 300,
      "number": 1000295,
      "createdAt": "2024-12-09T20:24:49.6109741",
      "updatedAt": "2024-12-23T20:52:16.251431",
      "items": [
        {
          "orderedQuantity": 1,
          "id": "d34910c2-583e-4214-fda3-08dcf2ebd09b",
          "name": "Azeite de Dendê Tempemar 200mL",
          "skuId": "2c10f21f-cf7f-4e10-0047-08dcf2ebd0e0",
          "sku": {
            "id": "2c10f21f-cf7f-4e10-0047-08dcf2ebd0e0",
            "name": "Azeite de Dendê Tempemar 200mL",
            "ean": "7896975000441",
            "reference": "38370",
            "unitOfMeasure": 1,
            "arithmeticFactor": 1
          },
          "salePrice": 10.98,
          "totalPerProduct": 10.98,
          "imageURLs": [
            "https://example.com/images/azeite-dende.jpg"
          ]
        }
      ],
      "orderStatusRegistry": [
        { "orderId": "0376d6b3-61ce-4192-f35c-08dd187dcd26", "status": 1 },
        { "orderId": "0376d6b3-61ce-4192-f35c-08dd187dcd26", "status": 100 },
        { "orderId": "0376d6b3-61ce-4192-f35c-08dd187dcd26", "status": 200 },
        { "orderId": "0376d6b3-61ce-4192-f35c-08dd187dcd26", "status": 300 }
      ],
      "shippingPolicy": {
        "id": "8ce4a041-240f-46fd-97ee-08dd0579eec2",
        "name": "Agendada - Padrão"
      },
      "subtotal": {
        "subtotal": 230.58,
        "discount": 0,
        "couponDiscount": 0,
        "frete": 17.9,
        "isFreeShipping": false,
        "total": 248.48
      },
      "deliveryType": 1,
      "canBeCancelled": false
    }
  ]
}