# Merchant API . accounts . onlineReturnPolicies

## Instance Methods

Close httplib2 connections.

Gets an existing return policy for a given merchant.

Lists all existing return policies for a given merchant.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(name, x__xgafv=None)`

    Gets an existing return policy for a given merchant.

    Args:
      name: string, Required. The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs.
      "acceptDefectiveOnly": True or False, # This field specifies if merchant only accepts defective products for returns, and this field is required.
      "acceptExchange": True or False, # This field specifies if merchant allows customers to exchange products, this field is required.
      "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
        "A String",
      ],
      "itemConditions": [ # Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
        "A String",
      ],
      "label": "A String", # Required. Immutable. This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
      "name": "A String", # Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
      "policy": { # The available policies. # The return policy.
        "days": "A String", # 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": "A String", # Policy type.
      },
      "processRefundDays": 42, # The field specifies the number of days it takes for merchants to process refunds, field is optional.
      "restockingFee": { # The restocking fee. This can be a flat fee or a micro percent. # 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.
        "fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
        },
        "microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
      },
      "returnMethods": [ # 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.
        "A String",
      ],
      "returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
      "returnPolicyUri": "A 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.
      "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. # Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
        "fixedFee": { # The price represented as a number and currency. # 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.
          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
        },
        "type": "A String", # Required. Type of return shipping fee.
      },
      "seasonalOverrides": [ # Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
        {
          "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. seasonal override end date (inclusive).
            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
          },
          "label": "A String", # Required. Display name of this seasonal override in Merchant Center.
          "returnDays": 42, # Number of days (from the delivery date) that the product can be returned.
          "returnUntilDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Fixed end date until which the product can be returned.
            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
          },
          "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap.
            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
          },
        },
      ],
    }

`list(parent, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists all existing return policies for a given merchant.

    Args:
      parent: string, Required. The merchant account for which to list return policies. Format: `accounts/{account}` (required)
      pageSize: integer, Optional. The maximum number of `OnlineReturnPolicy` resources to return. The service returns fewer than this value if the number of return policies for the given merchant is less that than the `pageSize`. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
      pageToken: string, Optional. A page token, received from a previous `ListOnlineReturnPolicies` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListOnlineReturnPolicies` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for the `ListOnlineReturnPolicies` method.
      "nextPageToken": "A String", # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
      "onlineReturnPolicies": [ # The retrieved return policies.
        { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs.
          "acceptDefectiveOnly": True or False, # This field specifies if merchant only accepts defective products for returns, and this field is required.
          "acceptExchange": True or False, # This field specifies if merchant allows customers to exchange products, this field is required.
          "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
            "A String",
          ],
          "itemConditions": [ # Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
            "A String",
          ],
          "label": "A String", # Required. Immutable. This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
          "name": "A String", # Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
          "policy": { # The available policies. # The return policy.
            "days": "A String", # 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": "A String", # Policy type.
          },
          "processRefundDays": 42, # The field specifies the number of days it takes for merchants to process refunds, field is optional.
          "restockingFee": { # The restocking fee. This can be a flat fee or a micro percent. # 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.
            "fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
            },
            "microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
          },
          "returnMethods": [ # 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.
            "A String",
          ],
          "returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
          "returnPolicyUri": "A 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.
          "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. # Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
            "fixedFee": { # The price represented as a number and currency. # 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.
              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
            },
            "type": "A String", # Required. Type of return shipping fee.
          },
          "seasonalOverrides": [ # Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
            {
              "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. seasonal override end date (inclusive).
                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
              },
              "label": "A String", # Required. Display name of this seasonal override in Merchant Center.
              "returnDays": 42, # Number of days (from the delivery date) that the product can be returned.
              "returnUntilDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Fixed end date until which the product can be returned.
                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
              },
              "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap.
                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
              },
            },
          ],
        },
      ],
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.