Method: notification.partners.orders.patch

  • Updates an existing Order using an HTTP PATCH request to a specific resource URL.

  • Requires order.name as a path parameter and optionally updateMask as a query parameter for specifying fields to update.

  • The request body should contain an Order object with details like client information, payment information, merchant ID, and line items.

  • The response body, on success, includes an updated Order object with the same structure as the request body.

  • Authorization requires the https://www.googleapis.com/auth/mapsbooking OAuth scope.

Updates an existing Order.

HTTP request

PATCH https://mapsbooking.googleapis.com/v1alpha/notification/{order.name=partners/*/orders/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
order.name

string

Resource name of the order: partners/{partner ID}/orders/{order ID}

Query parameters

Parameters
updateMask

string (FieldMask format)

Field mask of all order fields to be updated

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Order.

Response body

An order for service appointments with a merchant.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "clientInformation": {
    object (ClientInformation)
  },
  "paymentInformation": {
    object (PaymentInformation)
  },
  "merchantId": string,
  "item": [
    {
      object (LineItem)
    }
  ]
}
Fields
name

string

Resource name of the order: partners/{partner ID}/orders/{order ID}
clientInformation

object (ClientInformation)

Personal information of the client making the order.
paymentInformation

object (PaymentInformation)

Information about payment transactions that relate to the order.
merchantId

string

ID of the merchant that all services in this order belong to.
item[]

object (LineItem)

Line items in this order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/mapsbooking

LineItem

A single item in an order--the booking of a single service in a single time slot.

JSON representation 
{
  "serviceId": string,
  "startSec": string,
  "durationSec": string,
  "tickets": [
    {
      object (OrderedTickets)
    }
  ],
  "price": {
    object (Price)
  },
  "status": enum (BookingStatus)
}
Fields
serviceId

string

ID of the merchant Service.
startSec

string (int64 format)

Start time of the appointment slot in seconds of UTC time since Unix epoch.
durationSec

string (int64 format)

Duration of the appointment slot in seconds.
tickets[]

object (OrderedTickets)

Number of tickets ordered by Ticket Type.
price

object (Price)

The total price (excluding taxes) of this Line Item.
status

enum (BookingStatus)

Status of the Line Item.

OrderedTickets

Number of ordered tickets by Ticket Type.

JSON representation 
{
  "ticketId": string,
  "count": integer
}
Fields
ticketId

string

ID of a Ticket Type.
count

integer

Number of tickets ordered for this type.