Method: inventory.partners.merchants.status.list

  • Lists all MerchantStatus of a partner that satisfy filter conditions such as booking inventory status, waitlist inventory status, or geo matching status.

  • Uses a GET request to the endpoint https://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/merchants}/status, with required path parameter parent and optional query parameters for filtering and pagination.

  • Requires authorization with the https://www.googleapis.com/auth/mapsbooking scope.

  • The response body contains a list of MerchantStatus objects and a token for pagination if there are more results.

  • Provides enums for BookingInventoryStatus, WaitlistInventoryStatus, and GeoMatchingStatus for filtering purposes.

List all MerchantStatus of a partner that satisfy the filter conditions.

HTTP request

GET https://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/merchants}/status

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of merchant status. Format: partners/{partner_id}/merchants

Query parameters

Parameters
pageSize

integer

Required. The maximum number of items to return. Note that the server may reduce the page size.
pageToken

string

Optional. The nextPageToken value returned from a previous ListMerchantStatusResponse, if any.
bookingInventoryStatusRestrict

enum (BookingInventoryStatus)

Optional. Optional restriction to filter results by booking inventory status.
waitlistInventoryStatusRestrict

enum (WaitlistInventoryStatus)

Optional. Optional restriction to filter results by waitlist inventory status.
geoMatchRestrict

enum (GeoMatchingStatus)

Optional. Optional restriction to filter results by Geo matching status.

Request body

The request body must be empty.

Response body

The response to list MerchantStatus.

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

JSON representation 
{
  "merchantStatuses": [
    {
      object (MerchantStatus)
    }
  ],
  "nextPageToken": string
}
Fields
merchantStatuses[]

object (MerchantStatus)

List of merchant statuses that satisfy the filter conditions.
nextPageToken

string

Token to retrieve the next page of results. There are no more results in the list if empty.

Authorization scopes

Requires the following OAuth scope:

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

BookingInventoryStatus

End-to-end booking inventory status.

Enums
BOOKING_INVENTORY_STATUS_UNSPECIFIED Not specified.
NO_VALID_FUTURE_INVENTORY Merchant doesn't have booking inventory in the next 30 day.
HAS_VALID_FUTURE_INVENTORY Merchant has booking inventory in the next 30 day.

WaitlistInventoryStatus

End-to-end waitlist inventory status.

Enums
WAITLIST_INVENTORY_STATUS_UNSPECIFIED Not specified.
NO_VALID_WAITLIST_SERVICE Merchant doesn't have service supporting waitlist.
HAS_VALID_WAITLIST_SERVICE Merchant has service supporting waitlist.

GeoMatchingStatus

Merchant geo matching status.

Enums
GEO_MATCHING_STATUS_UNSPECIFIED Not specified.
GEO_UNMATCHED Merchant is not geo matched.
GEO_MATCHED Merchant is geo matched.