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.getsupportedpickupservices
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves supported pickup services for an account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedPickupServices
Path parameters
Parameters |
merchantId |
string
The ID of the account for which to retrieve the supported pickup services.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse ".
|
pickupServices[] |
object (PickupServicesPickupService )
A list of supported pickup services. 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.
PickupServicesPickupService
JSON representation |
{
"country": string,
"carrierName": string,
"serviceName": string
} |
Fields |
country |
string
The CLDR country code of the carrier (for example, "US"). Always present.
|
carrierName |
string
The name of the carrier (for example, "UPS" ). Always present.
|
serviceName |
string
The name of the pickup service (for example, "Access point" ). 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 the pickup services supported by a specific account using the provided merchant ID.\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\u003eResponse includes a list of pickup services, each detailing the country, carrier name, and service name.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response provides details in JSON format.\u003c/p\u003e\n"]]],["This document details how to retrieve supported pickup services for a specific merchant account. A `GET` request is sent to `https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedPickupServices`, with the `merchantId` as a path parameter. The request body must be empty. The successful response contains a JSON object including a list of `pickupServices`. Each `pickupService` specifies the `country`, `carrierName`, and `serviceName`. Authorization requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: shippingsettings.getsupportedpickupservices\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.ShippingsettingsGetSupportedPickupServicesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [PickupServicesPickupService](#PickupServicesPickupService)\n - [JSON representation](#PickupServicesPickupService.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieves supported pickup services for an account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedPickupServices`\n\n### Path parameters\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------|\n| `merchantId` | `string` The ID of the account for which to retrieve the supported pickup services. |\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, \"pickupServices\": [ { object (/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedpickupservices#PickupServicesPickupService) } ] } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedPickupServicesResponse`\". |\n| `pickupServices[]` | `object (`[PickupServicesPickupService](/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedpickupservices#PickupServicesPickupService)`)` A list of supported pickup services. 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\nPickupServicesPickupService\n---------------------------\n\n| JSON representation |\n|-----------------------------------------------------------------------------|\n| ``` { \"country\": string, \"carrierName\": string, \"serviceName\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------|\n| `country` | `string` The CLDR country code of the carrier (for example, \"US\"). Always present. |\n| `carrierName` | `string` The name of the carrier (for example, `\"UPS\"`). Always present. |\n| `serviceName` | `string` The name of the pickup service (for example, `\"Access point\"`). Always present. |"]]