Get Order

Required scope: order:read

This endpoint returns a commercial order created by confirming a quote. It does not return an operational work order. Work orders are separate records under the WorkOrder service and use work_order:* scopes.

Commercial orders cannot be created directly through the public API. Use ConfirmQuote, which is the only order creation path. The order-level pricingCountry and currency come from the quote’s frozen commercial snapshot and match its item pricing.

Generated Reference

POST /public-api/publicapi.v1.Order/GetOrder

Returns a commercial order by ID.

Request GetOrderRequest

Response GetOrderResponse

GetOrderRequest

Field	Type
`id`	`string`

GetOrderResponse

Field	Type
`order`	`Order`

Related Types

Order

Field	Type
`id`	`string`
`portfolio_id`	`string`
`quote_id`	`optional string`
`status`	`OrderStatus`
`reference_number`	`string`
`version`	`int32`
`items`	`repeated OrderItem`
`finalized_at`	`int64`
`created_at`	`int64`
`updated_at`	`int64`
`cancelled_at`	`int64`
`cancel_reason`	`string`
`pricing_country`	`string`
`currency`	`string`

OrderItem

Field	Type
`product_id`	`string`
`quantity`	`int32`
`line_id`	`string`
`display_name`	`string`
`price_once`	`optional int32`
`price_monthly`	`optional int32`
`price_yearly`	`optional int32`
`currency`	`string`

Request

{
  "id": "<order-id>"
}

Response

{
  "order": {
    "id": "<order-id>",
    "portfolioId": "<portfolio-id>",
    "quoteId": "<quote-id>",
    "status": "PUBLIC_ORDER_STATUS_CREATED",
    "pricingCountry": "US",
    "currency": "USD",
    "referenceNumber": "O-000123",
    "version": 1,
    "items": [
      {
        "productId": "<product-id>",
        "quantity": 8,
        "lineId": "<line-id>",
        "displayName": "Solar panel",
        "priceOnce": 18900,
        "currency": "USD"
      }
    ]
  }
}