rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
Method: shippingsettings.getsupportedholidays
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves supported holidays for an account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedHolidays
Path parameters
Parameters |
merchantId |
string
The ID of the account for which to retrieve the supported holidays.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"holidays": [
{
object (HolidaysHoliday )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse ".
|
holidays[] |
object (HolidaysHoliday )
A list of holidays applicable for delivery guarantees. May be empty.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
HolidaysHoliday
JSON representation |
{
"id": string,
"countryCode": string,
"type": string,
"date": string,
"deliveryGuaranteeDate": string,
"deliveryGuaranteeHour": string
} |
Fields |
id |
string
Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
|
countryCode |
string
The CLDR territory code of the country in which the holiday is available. For example, "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
|
type |
string
The holiday type. Always present. Acceptable values are: - "
Christmas " - "
Easter " - "
Father's Day " - "
Halloween " - "
Independence Day (USA) " - "
Mother's Day " - "
Thanksgiving " - "
Valentine's Day "
|
date |
string
Date of the holiday, in ISO 8601 format. For example, "2016-12-25" for Christmas 2016. Always present.
|
deliveryGuaranteeDate |
string
Date on which the order has to arrive at the customer's, in ISO 8601 format. For example, "2016-12-24" for 24th December 2016. Always present.
|
deliveryGuaranteeHour |
string
Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
|
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 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eRetrieves a list of supported holidays for a specified Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes holiday details such as ID, country code, type, and relevant dates for delivery guarantees.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUse the provided holiday IDs to configure holiday cutoffs in your shipping settings.\u003c/p\u003e\n"]]],["This content describes how to retrieve supported holidays for a specific account using a `GET` request. The request URL requires a `merchantId` path parameter. The request body must be empty. The successful response includes a JSON object with a list of `holidays`. Each holiday entry contains its `id`, `countryCode`, `type`, `date`, `deliveryGuaranteeDate`, and `deliveryGuaranteeHour`. Authorization requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: shippingsettings.getsupportedholidays\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ShippingsettingsGetSupportedHolidaysResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [HolidaysHoliday](#HolidaysHoliday)\n - [JSON representation](#HolidaysHoliday.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieves supported holidays for an account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedHolidays`\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------|\n| `merchantId` | `string` The ID of the account for which to retrieve the supported holidays. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"holidays\": [ { object (/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedholidays#HolidaysHoliday) } ] } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedHolidaysResponse`\". |\n| `holidays[]` | `object (`[HolidaysHoliday](/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedholidays#HolidaysHoliday)`)` A list of holidays applicable for delivery guarantees. May be empty. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nHolidaysHoliday\n---------------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"countryCode\": string, \"type\": string, \"date\": string, \"deliveryGuaranteeDate\": string, \"deliveryGuaranteeHour\": string } ``` |\n\n| Fields ||\n|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. |\n| `countryCode` | `string` The CLDR territory code of the country in which the holiday is available. For example, \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present. |\n| `type` | `string` The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" \u003cbr /\u003e |\n| `date` | `string` Date of the holiday, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example, \"2016-12-25\" for Christmas 2016. Always present. |\n| `deliveryGuaranteeDate` | `string` Date on which the order has to arrive at the customer's, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example, \"2016-12-24\" for 24th December 2016. Always present. |\n| `deliveryGuaranteeHour` | `string` Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. |"]]