- Resource: ReturnPolicyOnline
- Policy
- Type
- RestockingFee
- ReturnMethod
- ItemCondition
- ReturnReasonCategoryInfo
- ReturnReasonCategory
- ReturnLabelSource
- ReturnShippingFee
- Type
- Methods
Resource: ReturnPolicyOnline
Return policy online object. This is currently used to represent return policies for ads and free listings programs.
JSON representation |
---|
{ "returnPolicyId": string, "label": string, "countries": [ string ], "name": string, "policy": { object ( |
Fields | |
---|---|
return |
Output only. Return policy ID generated by Google. |
label |
The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute. |
countries[] |
The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US". |
name |
The name of the policy as shown in Merchant Center. |
policy |
The return policy. |
restocking |
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 |
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 |
The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns. |
return |
The return reason category information. This required to not be empty unless the type of return policy is noReturns. |
return |
The return policy uri. This can used by Google to do a sanity check for the policy. |
Policy
The available policies.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Policy type. |
days |
The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for |
Type
Return policy types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
NUMBER_OF_DAYS_AFTER_DELIVERY |
Number of days after a return is delivered. |
NO_RETURNS |
No returns. |
LIFETIME_RETURNS |
Life time returns. |
RestockingFee
The restocking fee. This can either be a fixed fee or a micro percent.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
fixed |
Fixed restocking fee. |
micro |
Percent of total price in micros. 15,000,000 means 15% of the total price would be charged. |
ReturnMethod
The available return reason methods.
Enums | |
---|---|
RETURN_METHOD_UNSPECIFIED |
Default value. This value is unused. |
BY_MAIL |
By mail. |
IN_STORE |
In store. |
AT_A_KIOSK |
At a kiosk. |
ItemCondition
The available item conditions.
Enums | |
---|---|
ITEM_CONDITION_UNSPECIFIED |
Default value. This value is unused. |
NEW |
New. |
USED |
Used. |
ReturnReasonCategoryInfo
The return reason category info wrapper.
JSON representation |
---|
{ "returnReasonCategory": enum ( |
Fields | |
---|---|
return |
The return reason category. |
return |
The corresponding return label source. |
return |
The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility. |
ReturnReasonCategory
The available return reason categories.
Enums | |
---|---|
RETURN_REASON_CATEGORY_UNSPECIFIED |
Default value. This value is unused. |
BUYER_REMORSE |
Buyer remorse. |
ITEM_DEFECT |
Item defect. |
ReturnLabelSource
The available return label sources.
Enums | |
---|---|
RETURN_LABEL_SOURCE_UNSPECIFIED |
Default value. This value is unused. |
DOWNLOAD_AND_PRINT |
Download and print the label. |
IN_THE_BOX |
Label in the box. |
CUSTOMER_RESPONSIBILITY |
Customers' responsibility to get the label. |
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 ( |
Fields | |
---|---|
type |
Type of return shipping fee. |
fixed |
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 |
Customer will pay the actual return shipping fee. |
Methods |
|
---|---|
|
Creates a new return policy. |
|
Deletes an existing return policy. |
|
Gets an existing return policy. |
|
Lists all existing return policies. |
|
Updates an existing return policy. |