Acesso Comercial / Docs / Storefront / API
Ctrl K
OBJECT

Order

Pedido do cliente com produtos, pagamento, frete e rastreamento.

Usado em: order query  |  clientorders  |  addNewCheckoutOrder

Campos

CampoTipoDescrição
idID!ID global Relay do pedido.
statusString!Status: pending, paid, shipped, delivered, cancelled.
totalPriceFloat!Valor total em centavos.
products[OrderProduct]Produtos do pedido.
shippingAddressAddressEndereço de entrega.
paymentMethodStringMétodo de pagamento (pix, credit_card, boleto).
trackingCodeStringCódigo de rastreamento dos Correios.
createdAtStringData de criação (ISO 8601).
pixQrCodeStringQR Code PIX (base64, se pagamento PIX pendente).
pixCopyPasteStringCódigo PIX copia-e-cola.
boletoUrlStringURL do boleto (se pagamento via boleto).

OrderProduct

CampoTipoDescrição
titleString!Título do produto.
priceFloat!Preço unitário em centavos.
quantityInt!Quantidade comprada.
images[Image]Imagens do produto.

Query

GraphQL
query GetOrder($hostname: String!, $id: ID!) {
  order(hostname: $hostname, id: $id) {
    id
    status
    totalPrice
    createdAt
    paymentMethod
    trackingCode
    products {
      title
      price
      quantity
    }
    shippingAddress {
      street
      number
      city
      state
      zipCode
    }
  }
}

Resposta

JSON
{
  "data": {
    "order": {
      "id": "T3JkZXI6YWJjMTIz",
      "status": "shipped",
      "totalPrice": 19480,
      "createdAt": "2026-06-08T14:30:00Z",
      "paymentMethod": "credit_card",
      "trackingCode": "BR123456789XX",
      "products": [
        {
          "title": "Camiseta Premium",
          "price": 8990,
          "quantity": 2
        }
      ],
      "shippingAddress": {
        "street": "Rua das Flores",
        "number": "123",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01234567"
      }
    }
  }
}