Method: inventory.partners.merchants.status.list
Stay organized with collections
Save and categorize content based on your preferences.
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-17 UTC.
[null,null,["Last updated 2024-10-17 UTC."],[[["\u003cp\u003eLists all MerchantStatus of a partner that satisfy filter conditions such as booking inventory status, waitlist inventory status, or geo matching status.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the endpoint \u003ccode\u003ehttps://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/merchants}/status\u003c/code\u003e, with required path parameter \u003ccode\u003eparent\u003c/code\u003e and optional query parameters for filtering and pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/mapsbooking\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of MerchantStatus objects and a token for pagination if there are more results.\u003c/p\u003e\n"],["\u003cp\u003eProvides enums for BookingInventoryStatus, WaitlistInventoryStatus, and GeoMatchingStatus for filtering purposes.\u003c/p\u003e\n"]]],[],null,["# Method: inventory.partners.merchants.status.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListMerchantStatusesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [BookingInventoryStatus](#BookingInventoryStatus)\n- [WaitlistInventoryStatus](#WaitlistInventoryStatus)\n- [GeoMatchingStatus](#GeoMatchingStatus)\n\nList all [MerchantStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/MerchantStatus) of a partner that satisfy the filter conditions.\n\n### HTTP request\n\n`GET https://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/merchants}/status`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of merchant status. Format: `partners/{partner_id}/merchants` |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `integer` Required. The maximum number of items to return. Note that the server may reduce the page size. |\n| `page``Token` | `string` Optional. The nextPageToken value returned from a previous ListMerchantStatusResponse, if any. |\n| `booking``Inventory``Status``Restrict` | `enum (`[BookingInventoryStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/inventory.partners.merchants.status/list#BookingInventoryStatus)`)` Optional. Optional restriction to filter results by booking inventory status. |\n| `waitlist``Inventory``Status``Restrict` | `enum (`[WaitlistInventoryStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/inventory.partners.merchants.status/list#WaitlistInventoryStatus)`)` Optional. Optional restriction to filter results by waitlist inventory status. |\n| `geo``Match``Restrict` | `enum (`[GeoMatchingStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/inventory.partners.merchants.status/list#GeoMatchingStatus)`)` Optional. Optional restriction to filter results by Geo matching status. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response to list [MerchantStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/MerchantStatus).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"merchantStatuses\": [ { object (/maps-booking/reference/maps-booking-api/rest/v1alpha/MerchantStatus) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merchant``Statuses[]` | `object (`[MerchantStatus](/maps-booking/reference/maps-booking-api/rest/v1alpha/MerchantStatus)`)` List of merchant statuses that satisfy the filter conditions. |\n| `next``Page``Token` | `string` Token to retrieve the next page of results. There are no more results in the list if empty. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/mapsbooking`\n\nBookingInventoryStatus\n----------------------\n\nEnd-to-end booking inventory status.\n\n| Enums ||\n|----------------------------------------|-------------------------------------------------------------|\n| `BOOKING_INVENTORY_STATUS_UNSPECIFIED` | Not specified. |\n| `NO_VALID_FUTURE_INVENTORY` | Merchant doesn't have booking inventory in the next 30 day. |\n| `HAS_VALID_FUTURE_INVENTORY` | Merchant has booking inventory in the next 30 day. |\n\nWaitlistInventoryStatus\n-----------------------\n\nEnd-to-end waitlist inventory status.\n\n| Enums ||\n|-----------------------------------------|----------------------------------------------------|\n| `WAITLIST_INVENTORY_STATUS_UNSPECIFIED` | Not specified. |\n| `NO_VALID_WAITLIST_SERVICE` | Merchant doesn't have service supporting waitlist. |\n| `HAS_VALID_WAITLIST_SERVICE` | Merchant has service supporting waitlist. |\n\nGeoMatchingStatus\n-----------------\n\nMerchant geo matching status.\n\n| Enums ||\n|-----------------------------------|------------------------------|\n| `GEO_MATCHING_STATUS_UNSPECIFIED` | Not specified. |\n| `GEO_UNMATCHED` | Merchant is not geo matched. |\n| `GEO_MATCHED` | Merchant is geo matched. |"]]