Sales & CRMQu Query

getOrderBy

Topics: Commerce

Fetch an order by external ID. Requires order:read permission.

Returns

OrderState

Arguments

External system identifier

Examples

Find Commerce Order

query FindCommerceOrder($externalId: String!) {
  getOrderBy(externalId: $externalId) { id orderNumber status paymentStatus customerId }
}

Variables

{
  "externalId": "SALES-2042"
}
Exact field SDL
"""Fetch an order by external ID. Requires order:read permission."""
getOrderBy(
  """External system identifier"""
  externalId: String
): OrderState @topic(names: ["commerce"]) @topic_example(names: ["commerce.find-order"])

Declared on Query. Access is checked by the platform for each operation.