List Orders

Required scope: order:read

Lists commercial orders, not operational work orders. Work orders use the separate WorkOrder service and work_order:* scopes. Commercial orders are created only by ConfirmQuote; the public API has no direct order creation endpoint. Each order exposes the quote’s frozen pricingCountry and derived currency.

portfolioId is required. Omit status, or use PUBLIC_ORDER_STATUS_UNSPECIFIED, to return all statuses. The filter also accepts PUBLIC_ORDER_STATUS_CREATED and PUBLIC_ORDER_STATUS_CANCELLED.

Generated Reference

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

Lists commercial orders belonging to one portfolio.

Request ListOrdersRequest

Response ListOrdersResponse

ListOrdersRequest

Field	Type
`portfolio_id`	`string`
`status`	`OrderStatus`

ListOrdersResponse

Field	Type
`orders`	`repeated 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

{
  "portfolioId": "<portfolio-id>",
  "status": "PUBLIC_ORDER_STATUS_CREATED"
}

Response

{
  "orders": [
    {
      "id": "<order-id>",
      "portfolioId": "<portfolio-id>",
      "quoteId": "<quote-id>",
      "status": "PUBLIC_ORDER_STATUS_CREATED",
      "pricingCountry": "US",
      "currency": "USD",
      "referenceNumber": "O-000123",
      "version": 1
    }
  ]
}