REST Resource: returnaddress

  • ReturnAddress resource allows merchants to manage their return addresses within their Merchant Center account, providing necessary information like address, contact details, and labels for identification.

  • ReturnAddressAddress object defines the structure for specifying the physical location of the return address, including recipient name, street address, city, region, postal code, and country.

  • The 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.

Resource: ReturnAddress

Return address resource.

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

custombatch

 Batches multiple return address related calls in a single request.

delete

 Deletes a return address for the given Merchant Center account.

get

 Gets a return address of the Merchant Center account.

insert

 Inserts a return address for the Merchant Center account.

list

 Lists the return addresses of the Merchant Center account.