Method: orders.lines.reserve

Reserves an existing line.

  • Returns the updated line if successful.
  • Returns error code NOT_FOUND if the line does not exist.
  • Returns error code INVALID_ARGUMENT if lineTerms is not set.
  • Returns error code FAILED_PRECONDITION if lineState is not LINE_STATE_PENDING_RESERVATION.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The field will contain name of the line to be reserved, for example: "orders/123/lines/321"

Request body

The request body contains data with the following structure:

JSON representation
  "lineTerms": {
    object (LineTerms)
  "reservationExpirationTime": string

object (LineTerms)

Required. The seller guaranteed terms for this line.


string (Timestamp format)

Required. Expiration timestamp for the reservation. The buyer needs to book before a reservation expires.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Response body

If successful, the response body contains an instance of Line.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the OAuth 2.0 Overview.