Acesso Comercial / Docs / Storefront / API
Ctrl K
QUERY

order

Retorna detalhes de um pedido. Requer autenticação (login do cliente).

Requer autenticação: O cliente precisa estar logado via clientLogin para acessar seus pedidos.

Argumentos

ArgumentoTipoDescrição
hostnameString!Hostname da loja.
idID!ID global Relay do pedido.

Retorno

Retorna um Order.

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

Query

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

Resposta

JSON
{
  "data": {
    "order": {
      "id": "T3JkZXI6YWJjMTIz",
      "status": "paid",
      "totalPrice": 19480,
      "createdAt": "2026-06-10T14:30:00Z",
      "products": [
        {
          "title": "Camiseta Premium",
          "quantity": 2,
          "price": 8990
        }
      ],
      "shippingAddress": {
        "street": "Rua das Flores, 123",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01234-567"
      },
      "paymentMethod": "pix",
      "trackingCode": null
    }
  }
}

Fetch

JavaScript
const response = await fetch(
  '/graphql',
  {
    method: 'POST',
    credentials: 'include',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      query: `query($id: ID!, $hostname: String!) {
        order(id: $id, hostname: $hostname) {
          id status totalPrice paymentMethod
        }
      }`,
      variables: {
        id: "T3JkZXI6YWJjMTIz",
        hostname: "minha-loja"
      }
    })
  }
);
const data = await response.json();

cURL

Bash
curl -X POST https://minha-loja.com/graphql \
  -H "Content-Type: application/json" \
  -b "authJwtClient=YOUR_SESSION_COOKIE" \
  -d '{"query":"query { order(id: \"T3JkZXI6YWJjMTIz\", hostname: \"minha-loja\") { id status totalPrice } }"}'