This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively).
Type that uses ReturnPolicyDetails
Call that uses ReturnPolicyDetails
Fields
policyDescriptionEnabled
If set to
Note: Depending on the API used to setup your return policy, return instructions are defined differently.
true, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Account API's createReturnPolicy). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces.Note: Depending on the API used to setup your return policy, return instructions are defined differently.
- Account v1 API
When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnInstructions to provide both domestic and international return instructions for the business policy. - Trading API or Sell Feed API
When using the legacy ReturnPolicy fields, use Item.ReturnPolicyDescription to provide both domestic and internation return instructions for the business policy.
refundMethods
array of RefundMethodEnum
A list of refund methods allowed for the associated category.
Note: Depending on the API used to setup your return policy, available refund methods are defined differently.
Note: Depending on the API used to setup your return policy, available refund methods are defined differently.
- Account v1 API
When using the createReturnPolicy and updateReturnPolicy methods to create/manage business policies, use the appropriate refundMethod field to specify the refund method for both domestic and international returns for the business policy. - Trading API or Sell Feed API
When using legacy ReturnPolicy fields, use RefundOption and InternationalRefundOption to specify the domestic and international refund method, respectively, for returns for the business policy.
Note that if MONEY_BACK is returned by getReturnPolicies, use MoneyBack in RefundOption and InternationalRefundOption.
returnMethods
array of ReturnMethodEnum
A list of return methods allowed for the associated category.
Note: Depending on the API used to setup your return policy, available return methods are defined differently.
Note: Depending on the API used to setup your return policy, available return methods are defined differently.
- Account v1 API
When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnMethod and internationalOverride.returnMethod to specify the domestic and international return method, respectively, for the business policy.
returnPeriods
array of TimeDuration
A list of return periods allowed for the associated category.
Note: Depending on the API used to setup your return policy, return periods are defined differently.
Note: Depending on the API used to setup your return policy, return periods are defined differently.
- Account v1 API
When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use the returnPeriod and internationalOverride.returnPeriod containers to set the return period(s) for the business policy. You will use the supported values returned under thereturnPeriodsarray in the getReturnPolicies response. - Trading API or Sell Feed API
When using legacy ReturnPolicy fields, use ReturnsWithinOption and InternationalReturnsWithinOption to pass in one of the supported enum values defined in ReturnsWithinOptionsCodeType.
For example, if a value of 30 is returned in the returnPeriods.value field of getReturnPolicies, use Days_30 in ReturnsWithinOption or InternationalReturnsWithinOption.
returnsAcceptanceEnabled
A value of
Note: Depending on the API used to setup your return policy, whether or not you accept returns is configured as follows:
true in this field indicates that return policies are applicable to the corresponding leaf category.Note: Depending on the API used to setup your return policy, whether or not you accept returns is configured as follows:
- Account v1 API
When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnsAccepted and internationalOverride.returnsAccepted to indicate whether or not you accept returns. - Trading API or Sell Feed API
When using legacy ReturnPolicy fields, use ReturnsAcceptedOption and InternationalReturnsAcceptedOption to indicate whether or not you accept returns.
returnShippingCostPayers
array of ReturnShippingCostPayerEnum
A list of allowed values for who pays for the return shipping cost.
Note that for SNAD returns, the seller is always responsible for the return shipping cost.
Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.
Note that for SNAD returns, the seller is always responsible for the return shipping cost.
Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.
- Account v1 API
When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnShippingCostPayer and internationalOverride.returnShippingCostPayer to specify if the buyer or seller is responsible for paying return shipping charges for the business policy. - Trading API or Sell Feed API
When using legacy ReturnPolicy fields, use ShippingCostPaidByOption and InternationalShippingCostPaidByOption fields to specify if the buyer or seller is responsible for paying return shipping charges for the business policy.