Skip to main content

order

Retrieve comprehensive information about a specific order by its identifier.

Returns complete order data including all associated entities such as order items, billing and delivery addresses, shipment information, payment details, totals, and revision history. This query provides full order context needed for customer service, order management, and fulfillment operations.

The order can be accessed using either:

  • Numeric ID (legacy identifier for internal systems)
  • UUID (modern identifier for external integrations)

Exactly one identifier must be provided - specifying both will result in a validation error.

Retrieved data includes:

  • Basic order information (status, dates, customer details)
  • Financial data (totals, taxes, payment information, postage costs)
  • Order items with product details and quantities
  • Billing and delivery addresses
  • Shipment tracking and fulfillment status
  • Order revision history and audit trail

Possible errors:

  • ORDER_NOT_FOUND: Order with the specified ID or UUID does not exist
  • ORDER_GET_ERROR: Failed to retrieve order information due to system error
  • FORBIDDEN: Insufficient permissions to access this order
  • VALIDATION_ERROR: Both orderId and orderUUID provided, or neither provided

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')

order(
  orderId: Int
  orderUUID: String
): Order!

Arguments​

order.orderId ● Int scalar​

Unique numeric identifier of the order to retrieve.

Legacy identifier used primarily for internal systems and backward compatibility. This is the primary key from the order table and is guaranteed to be unique within the system.

Either this or orderUUID must be provided, but not both. Providing both will result in a validation error.

order.orderUUID ● String scalar​

Unique UUID identifier of the order to retrieve.

Modern identifier used for external integrations and API consumers. This UUID is globally unique and preferred for new integrations as it provides better security and scalability.

Either this or orderId must be provided, but not both. Providing both will result in a validation error.

Type​

Order object​