Shippingsettings: getsupportedholidays

Retrieves supported holidays for an account. Try it now.


HTTP request



Parameter name Value Description
Path parameters
merchantId unsigned long The ID of the account for which to retrieve the supported holidays.


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "content#shippingsettingsGetSupportedHolidaysResponse",
  "holidays": [
      "id": string,
      "countryCode": string,
      "type": string,
      "date": string,
      "deliveryGuaranteeDate": string,
      "deliveryGuaranteeHour": unsigned long
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".
holidays[] list A list of holidays applicable for delivery guarantees. May be empty.
holidays[].id string Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
holidays[].countryCode string The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
holidays[].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"
holidays[].date string Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
holidays[].deliveryGuaranteeDate string Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
holidays[].deliveryGuaranteeHour unsigned long 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.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.