We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

REST Resource: returnpolicy

Resource: ReturnPolicy

Return policy resource.

JSON representation
{
  "returnPolicyId": string,
  "label": string,
  "country": string,
  "name": string,
  "policy": {
    object (ReturnPolicyPolicy)
  },
  "seasonalOverrides": [
    {
      object (ReturnPolicySeasonalOverride)
    }
  ],
  "nonFreeReturnReasons": [
    string
  ],
  "kind": string
}
Fields
returnPolicyId

string

Return policy ID generated by Google.

label

string

Required. The user-defined label of the return policy. For the default policy, use the label "default".

country

string

Required. The country of sale where the return policy is applicable.

name

string

Required. The name of the policy as shown in Merchant Center.

policy

object (ReturnPolicyPolicy)

Required. The policy.

seasonalOverrides[]

object (ReturnPolicySeasonalOverride)

An optional list of seasonal overrides.

nonFreeReturnReasons[]

string

Return reasons that will incur return fees.

kind

string

Identifies what kind of resource this is. Value: the fixed string "content#returnPolicy"

ReturnPolicyPolicy

JSON representation
{
  "type": string,
  "numberOfDays": string,
  "lastReturnDate": string
}
Fields
type

string

Policy type. Use "lastReturnDate" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items.

Acceptable values are:

  • "lastReturnDate"
  • "lifetimeReturns"
  • "noReturns"
  • "numberOfDaysAfterDelivery"

numberOfDays

string (int64 format)

The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to "numberOfDaysAfterDelivery". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items.

lastReturnDate

string

Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to "lastReturnDate". Use this for seasonal overrides only.

ReturnPolicySeasonalOverride

JSON representation
{
  "name": string,
  "startDate": string,
  "endDate": string,
  "policy": {
    object (ReturnPolicyPolicy)
  }
}
Fields
name

string

Required. The name of the seasonal override as shown in Merchant Center.

startDate

string

Required. First day on which the override applies. In ISO 8601 format.

endDate

string

Required. Last day on which the override applies. In ISO 8601 format.

policy

object (ReturnPolicyPolicy)

Required. The policy which is in effect during that time.

Methods

custombatch

Batches multiple return policy related calls in a single request.

delete

Deletes a return policy for the given Merchant Center account.

get

Gets a return policy of the Merchant Center account.

insert

Inserts a return policy for the Merchant Center account.

list

Lists the return policies of the Merchant Center account.