Skip to main content
Version: 2.0.0

GuestOrderQuery

Description

Returns order detail for guest users by email + number. The operation name is getGuestOrder.

Use this query when the customer is not authenticated and still needs to see order detail (for example success page reload, guest order tracking, or support flow).

Endpoint

query getGuestOrder($email: String!, $number: String!) {
getGuestOrder(email: $email, number: $number) {
id
number
status
total {
value
currency
}
items {
id
sku
name
quantity
}
orderedAt
}
}

Arguments

ArgumentTypeRequiredDescription
emailStringYesGuest order email address.
numberStringYesOrder increment number.

Return Values

Returns YuiOrderDetail (same shape as getOrder):

FieldTypeDescription
idIntOrder ID.
numberStringIncrement number.
statusStringOrder status code.
totalMoneyGrand total with currency.
billing_addressYuiAddressBilling address.
shipping_addressYuiAddressShipping address.
total_item_countIntNumber of line items.
total_qty_orderedIntSum of ordered quantity.
shipping_methodStringShipping method code/title value.
shipping_amountFloatShipping amount.
payment_methodStringPayment method code/title value.
payment_amountFloatPayment amount.
currency_codeStringCurrency code.
email_sentBooleanWhether order e-mail was sent.
items[OrderItem]Ordered item rows.
orderedAtStringOrder creation timestamp.

Usage Example

query {
getGuestOrder(email: "guest@example.com", number: "000000123") {
number
status
total {
value
currency
}
orderedAt
}
}

Notes

  • Both inputs are required and validated as non-empty.
  • This query is designed for guest-safe order lookup and does not require authenticated customer context.
  • If no order is found, the plugin returns an order error.