- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- HolidaysHoliday
- Try it!
Retrieves supported holidays for an account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedHolidays
Path parameters
Parameters | |
---|---|
merchant |
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 ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string " |
holidays[] |
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 |
Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. |
country |
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 |
The holiday type. Always present. Acceptable values are:
|
date |
Date of the holiday, in ISO 8601 format. For example, "2016-12-25" for Christmas 2016. Always present. |
delivery |
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. |
delivery |
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. |