Pular para o conteúdo principal

Detalhes do pedido

Nota: Este endpoint está localizado no serviço principal (monolito), não na API de integração. A autenticação utiliza X-API-KEY ao invés de Basic Auth.

GET /v1/gateway/orders/{id}/details​

  • X-API-KEY: Chave para acessar informações do pedido.
    • Exemplo: X-API-KEY: 9f36a666-acd5-4987-a47f-3de247f65d82

Parâmetros da URL​

  • id (string, obrigatório): ID (GUID) do pedido.

Respostas​

  • 200: Retorna sucesso da operação. A resposta incluirá detalhes sobre o pedido.
  • 400: Retorna erro de requisição inválida. Isso geralmente ocorre devido a dados de entrada mal formatados ou faltando.
  • 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de resposta com os detalhes do pedido​

{
  "id": "124ec63c-eab7-4a03-6947-08dd52a7876d",
  "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5",
  "user": {
    "firstName": "João",
    "lastName": "Silva",
    "email": "joao.silva@email.com",
    "document": "12345678900",
    "phoneDDI": "55",
    "phoneNumber": "21999999999",
    "birthDate": "2000-06-01",
    "active": true
  },
  "deviceId": "6B711182-D583-4A55-A99A-6D93E2120C15",
  "orderAddress": {
    "id": "9d1fb178-1e99-4c86-bf50-08dd573d71c7",
    "country": "Brasil",
    "state": "RJ",
    "city": "Rio de Janeiro",
    "neighborhood": "Copacabana",
    "street": "Avenida Atlântica",
    "number": "320",
    "zipCode": "22021001",
    "addressType": "residence",
    "additionalInfo": "Apt 501",
    "reference": ""
  },
  "status": 300,
  "number": 1000399,
  "createdAt": "2025-02-21T21:08:41.0801499",
  "updatedAt": "2025-02-27T14:51:17.795565",
  "items": [
    {
      "orderedQuantity": 2,
      "id": "cc2e9c88-c41f-4f53-fdc7-08dcf2ebd09b",
      "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5",
      "name": "Azeite Extravirgem Espanhol Coosur 500ml",
      "skuId": "c53657c6-6813-448e-006b-08dcf2ebd0e0",
      "sku": {
        "id": "c53657c6-6813-448e-006b-08dcf2ebd0e0",
        "name": "Azeite Extravirgem Espanhol Coosur 500ml",
        "ean": "8411190101125",
        "reference": "57124",
        "unitOfMeasure": 1,
        "arithmeticFactor": 1
      },
      "brandId": "1a92f232-ba93-4d22-309e-08dd038fea21",
      "categoryId": "aea11d82-ba48-45ef-91b9-85352d790c02",
      "salePrice": 69.9,
      "arithmeticFactorPrice": 69.9,
      "totalPerProduct": 139.8,
      "imageURLs": [
        "https://example.com/images/azeite-coosur.jpg"
      ]
    }
  ],
  "orderStatusRegistry": [
    {
      "orderId": "124ec63c-eab7-4a03-6947-08dd52a7876d",
      "status": 1,
      "createdAt": "2025-02-21T21:08:41.0801504"
    },
    {
      "orderId": "124ec63c-eab7-4a03-6947-08dd52a7876d",
      "status": 100,
      "createdAt": "2025-02-27T14:46:17.7010675"
    },
    {
      "orderId": "124ec63c-eab7-4a03-6947-08dd52a7876d",
      "status": 200,
      "createdAt": "2025-02-27T14:46:19.4146255"
    },
    {
      "orderId": "124ec63c-eab7-4a03-6947-08dd52a7876d",
      "status": 300,
      "createdAt": "2025-02-27T14:51:17.795565"
    }
  ],
  "shippingPolicy": {
    "id": "86f45049-7181-4b97-c89a-08dd0aa392bd",
    "name": "Retirada - Loja 08",
    "pickupPoint": {
      "seller": {
        "id": "bfc331e6-195e-4534-aea3-08dd0572838d",
        "name": "Loja 08 - Ipanema"
      },
      "separationTime": "02:00:00",
      "hoursLimit": "02:00:00",
      "minimumQuantityItems": 0,
      "maximumQuantityItems": 70,
      "minimumPurchaseValue": 100
    }
  },
  "subtotal": {
    "subtotal": 158.7,
    "discount": 0,
    "couponDiscount": 0,
    "frete": 0,
    "isFreeShipping": false,
    "total": 158.7
  },
  "deliveryType": 3,
  "acceptedOrderDetails": {
    "shippingPolicyName": "Retirada - Loja 08",
    "paymentProvider": "MercadoPago",
    "paymentMethod": "Pix",
    "subtotal": 158.7,
    "discount": 0,
    "frete": 0,
    "total": 158.7,
    "additionalInformation": [
      {
        "title": "Quem irá receber as compras?",
        "value": "Eu mesmo",
        "dataType": 1
      },
      {
        "title": "Aceita substituição de item?",
        "value": false,
        "dataType": 2
      }
    ]
  },
  "canBeCancelled": false
}