Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class OnlineReturnPolicy.
Online return policy object. This is currently used to represent return policies for ads and free listings programs.
Generated from protobuf message google.shopping.merchant.accounts.v1.OnlineReturnPolicy
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The name of the OnlineReturnPolicy
resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}
↳ return_policy_id
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
array
Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
↳ policy
↳ seasonal_overrides
array< OnlineReturnPolicy\SeasonalOverride
>
Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
↳ restocking_fee
OnlineReturnPolicy\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.
↳ return_methods
array
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.
↳ item_conditions
array
Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
↳ return_shipping_fee
OnlineReturnPolicy\ReturnShippingFee
Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
↳ return_policy_uri
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.
↳ accept_defective_only
bool
Optional. This field specifies if business only accepts defective products for returns.
↳ process_refund_days
int
Optional. The field specifies the number of days it takes for business to process refunds.
↳ accept_exchange
bool
Optional. This field specifies if business allows customers to exchange products.
↳ return_label_source
int
Optional. The field specifies the return label source.
getName
Identifier. The name of the OnlineReturnPolicy
resource.
Format: accounts/{account}/onlineReturnPolicies/{return_policy}
string
setName
Identifier. The name of the OnlineReturnPolicy
resource.
Format: accounts/{account}/onlineReturnPolicies/{return_policy}
var
string
$this
getReturnPolicyId
Output only. Return policy ID generated by Google.
string
setReturnPolicyId
Output only. Return policy ID generated by Google.
var
string
$this
getLabel
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.
string
setLabel
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.
var
string
$this
getCountries
Required. Immutable. The countries of sale where the return policy applies.
The values must be a valid 2 letter ISO 3166 code.
setCountries
Required. Immutable. The countries of sale where the return policy applies.
The values must be a valid 2 letter ISO 3166 code.
var
string[]
$this
getPolicy
Optional. The return policy.
hasPolicy
clearPolicy
setPolicy
Optional. The return policy.
$this
getSeasonalOverrides
Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
setSeasonalOverrides
Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
$this
getRestockingFee
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.
hasRestockingFee
clearRestockingFee
setRestockingFee
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.
$this
getReturnMethods
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.
setReturnMethods
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.
var
int[]
$this
getItemConditions
Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
setItemConditions
Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
var
int[]
$this
getReturnShippingFee
Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
hasReturnShippingFee
clearReturnShippingFee
setReturnShippingFee
Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
$this
getReturnPolicyUri
Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
string
setReturnPolicyUri
Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
var
string
$this
getAcceptDefectiveOnly
Optional. This field specifies if business only accepts defective products for returns.
bool
hasAcceptDefectiveOnly
clearAcceptDefectiveOnly
setAcceptDefectiveOnly
Optional. This field specifies if business only accepts defective products for returns.
var
bool
$this
getProcessRefundDays
Optional. The field specifies the number of days it takes for business to process refunds.
int
hasProcessRefundDays
clearProcessRefundDays
setProcessRefundDays
Optional. The field specifies the number of days it takes for business to process refunds.
var
int
$this
getAcceptExchange
Optional. This field specifies if business allows customers to exchange products.
bool
hasAcceptExchange
clearAcceptExchange
setAcceptExchange
Optional. This field specifies if business allows customers to exchange products.
var
bool
$this
getReturnLabelSource
Optional. The field specifies the return label source.
int
hasReturnLabelSource
clearReturnLabelSource
setReturnLabelSource
Optional. The field specifies the return label source.
var
int
$this
