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.
REST Resource: returnaddress
Stay organized with collections
Save and categorize content based on your preferences.
Resource: ReturnAddress
JSON representation |
{
"returnAddressId": string,
"label": string,
"country": string,
"address": {
object (ReturnAddressAddress )
},
"phoneNumber": string,
"kind": string
} |
Fields |
returnAddressId |
string
Return address ID generated by Google.
|
label |
string
Required. The user-defined label of the return address. For the default address, use the label "default".
|
country |
string
Required. The country of sale where the return address is applicable.
|
address |
object (ReturnAddressAddress )
Required. The address.
|
phoneNumber |
string
Required. The merchant's contact phone number regarding the return.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#returnAddress "
|
ReturnAddressAddress
JSON representation |
{
"recipientName": string,
"streetAddress": [
string
],
"locality": string,
"region": string,
"postalCode": string,
"country": string
} |
Fields |
recipientName |
string
Name of the recipient to address returns to.
|
streetAddress[] |
string
Street-level part of the address. May be up to two lines, each line specified as an array element.
|
locality |
string
City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
|
region |
string
Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
|
postalCode |
string
Postal code or ZIP (for example, "94043").
|
country |
string
CLDR country code (for example, "US").
|
Methods |
|
Batches multiple return address related calls in a single request. |
|
Deletes a return address for the given Merchant Center account. |
|
Gets a return address of the Merchant Center account. |
|
Inserts a return address for the Merchant Center account. |
|
Lists the return addresses of the Merchant Center account. |
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\u003e\u003ccode\u003eReturnAddress\u003c/code\u003e resource allows merchants to manage their return addresses within their Merchant Center account, providing necessary information like address, contact details, and labels for identification.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eReturnAddressAddress\u003c/code\u003e object defines the structure for specifying the physical location of the return address, including recipient name, street address, city, region, postal code, and country.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods to create, retrieve, update, and delete return addresses, as well as batch processing for multiple operations, giving merchants control over their return address settings.\u003c/p\u003e\n"]]],["The document details the `ReturnAddress` resource, which includes fields like `returnAddressId`, `label`, `country`, `address`, and `phoneNumber`. The `address` field is an object with details such as `recipientName`, `streetAddress`, `locality`, `region`, `postalCode`, and `country`. Key actions involve using the provided methods, including `custombatch` for batch calls, `delete` to remove, `get` to retrieve, `insert` to add, and `list` to view return addresses associated with a Merchant Center account.\n"],null,["# REST Resource: returnaddress\n\n- [Resource: ReturnAddress](#ReturnAddress)\n - [JSON representation](#ReturnAddress.SCHEMA_REPRESENTATION)\n- [ReturnAddressAddress](#ReturnAddressAddress)\n - [JSON representation](#ReturnAddressAddress.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: ReturnAddress\n-----------------------\n\nReturn address resource.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"returnAddressId\": string, \"label\": string, \"country\": string, \"address\": { object (/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddressAddress) }, \"phoneNumber\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `returnAddressId` | `string` Return address ID generated by Google. |\n| `label` | `string` Required. The user-defined label of the return address. For the default address, use the label \"default\". |\n| `country` | `string` Required. The country of sale where the return address is applicable. |\n| `address` | `object (`[ReturnAddressAddress](/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddressAddress)`)` Required. The address. |\n| `phoneNumber` | `string` Required. The merchant's contact phone number regarding the return. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\" |\n\nReturnAddressAddress\n--------------------\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"recipientName\": string, \"streetAddress\": [ string ], \"locality\": string, \"region\": string, \"postalCode\": string, \"country\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `recipientName` | `string` Name of the recipient to address returns to. |\n| `streetAddress[]` | `string` Street-level part of the address. May be up to two lines, each line specified as an array element. |\n| `locality` | `string` City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs). |\n| `region` | `string` Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\"). |\n| `postalCode` | `string` Postal code or ZIP (for example, \"94043\"). |\n| `country` | `string` [CLDR country code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) (for example, \"US\"). |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------|--------------------------------------------------------------------|\n| ### [custombatch](/shopping-content/reference/rest/v2.1/returnaddress/custombatch) | Batches multiple return address related calls in a single request. |\n| ### [delete](/shopping-content/reference/rest/v2.1/returnaddress/delete) | Deletes a return address for the given Merchant Center account. |\n| ### [get](/shopping-content/reference/rest/v2.1/returnaddress/get) | Gets a return address of the Merchant Center account. |\n| ### [insert](/shopping-content/reference/rest/v2.1/returnaddress/insert) | Inserts a return address for the Merchant Center account. |\n| ### [list](/shopping-content/reference/rest/v2.1/returnaddress/list) | Lists the return addresses of the Merchant Center account. |"]]