REST Resource: accounts.onlineReturnPolicies

Resource: OnlineReturnPolicy

Online return policy object. This is currently used to represent return policies for ads and free listings programs.

JSON representation 
{
  "name": string,
  "returnPolicyId": string,
  "label": string,
  "countries": [
    string
  ],
  "policy": {
    object (Policy)
  },
  "seasonalOverrides": [
    {
      object (SeasonalOverride)
    }
  ],
  "restockingFee": {
    object (RestockingFee)
  },
  "returnMethods": [
    enum (ReturnMethod)
  ],
  "itemConditions": [
    enum (ItemCondition)
  ],
  "returnShippingFee": {
    object (ReturnShippingFee)
  },
  "returnPolicyUri": string,
  "acceptDefectiveOnly": boolean,
  "processRefundDays": integer,
  "acceptExchange": boolean,
  "returnLabelSource": enum (ReturnLabelSource)
}
Fields
name

string

Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}
returnPolicyId

string

Output only. Return policy ID generated by Google.
label

string

Optional. Immutable. This field represents the unique user-defined label of the return policy for the given country. It is important to note that the same label cannot be used in different return policies for the same country. If not given, policies will be automatically treated as the 'default' for the country. When using label, you are creating an exception policy in that country to assign a custom return policy to certain product groups, follow the instructions provided in the Return policy label. The label can contain up to 50 characters.
countries[]

string

Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
policy

object (Policy)

Optional. The return policy.
seasonalOverrides[]

object (SeasonalOverride)

Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
restockingFee

object (RestockingFee)

Optional. The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
returnMethods[]

enum (ReturnMethod)

Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
itemConditions[]

enum (ItemCondition)

Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
returnShippingFee

object (ReturnShippingFee)

Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
returnPolicyUri

string

Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
acceptDefectiveOnly

boolean

Optional. This field specifies if business only accepts defective products for returns.
processRefundDays

integer

Optional. The field specifies the number of days it takes for business to process refunds.
acceptExchange

boolean

Optional. This field specifies if business allows customers to exchange products.
returnLabelSource

enum (ReturnLabelSource)

Optional. The field specifies the return label source.

Policy

The available policies.

JSON representation 
{
  "type": enum (Type),
  "days": string
}
Fields
type

enum (Type)

Policy type.
days

string (int64 format)

The number of days items can be returned after delivery, where one day is defined as 24 hours after the delivery timestamp. Required for NUMBER_OF_DAYS_AFTER_DELIVERY returns.

Type

Return policy types.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
NUMBER_OF_DAYS_AFTER_DELIVERY The number of days within which a return is valid after delivery.
NO_RETURNS No returns.
LIFETIME_RETURNS Life time returns.

SeasonalOverride

JSON representation 
{
  "label": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },

  // Union field return_window can be only one of the following:
  "returnDays": integer,
  "returnUntilDate": {
    object (Date)
  }
  // End of list of possible types for union field return_window.
}
Fields
label

string

Required. Display name of this seasonal override in Merchant Center.
startDate

object (Date)

Required. Defines the date range when this seasonal override applies. Both startDate and endDate are inclusive. The dates of the seasonal overrides should not overlap.
endDate

object (Date)

Required. seasonal override end date (inclusive).
Union field return_window. ReturnWindow: Specifies either a fixed return date or the number of days (from the delivery date) until which a product can be returned. Merchant Return Days return_window can be only one of the following:
returnDays

integer

Number of days (from the delivery date) that the product can be returned.
returnUntilDate

object (Date)

Fixed end date until which the product can be returned.

RestockingFee

The restocking fee. This can be a flat fee or a micro percent.

JSON representation 
{

  // Union field type can be only one of the following:
  "fixedFee": {
    object (Price)
  },
  "microPercent": integer
  // End of list of possible types for union field type.
}
Fields

Union field type.

type can be only one of the following:
fixedFee

object (Price)

Fixed restocking fee.
microPercent

integer

Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.

ReturnMethod

The available return methods.

Enums
RETURN_METHOD_UNSPECIFIED Default value. This value is unused.
BY_MAIL Return by mail.
IN_STORE Return in store.
AT_A_KIOSK Return at a kiosk.

ItemCondition

The available item conditions.

Enums
ITEM_CONDITION_UNSPECIFIED Default value. This value is unused.
NEW New.
USED Used.

ReturnShippingFee

The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.

JSON representation 
{
  "type": enum (Type),
  "fixedFee": {
    object (Price)
  }
}
Fields
type

enum (Type)

Required. Type of return shipping fee.
fixedFee

object (Price)

Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.

Type

Return shipping fee types.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
FIXED The return shipping fee is a fixed value.
CUSTOMER_PAYING_ACTUAL_FEE Customers will pay the actual return shipping fee.

ReturnLabelSource

The available return label sources.

Enums
RETURN_LABEL_SOURCE_UNSPECIFIED Default value. This value is unused.
DOWNLOAD_AND_PRINT Download and print.
IN_THE_PACKAGE Label include in the package.
CUSTOMER_RESPONSIBILITY Customer to provide.

Methods

create

 Creates a new return policy for a given business.

delete

 Deletes an existing return policy.

get

 Gets an existing return policy for a given business.

list

 Lists all existing return policies for a given business.

patch

 Updates an existing return policy for a given business.