PUT /return_policy/{return_policy_id}

This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.

Servers

https://api.ebay.com{basePath}

Path parameters

Name	Type	Required	Description
`return_policy_id`	String	Yes	This path parameter specifies the ID of the return policy you want to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`extendedHolidayReturnsOffered`	Boolean	No	Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.
`description`	String	No	A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length: 250
`internationalOverride`	Object	No	This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.
`internationalOverride.returnMethod`	String	No	This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to eBay API documentation
`internationalOverride.returnShippingCostPayer`	String	No	This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either `BUYER` or `SELLER`. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for 'significantly not as described' (SNAD) issues. This field is conditionally required if the internationalOverride.returnsAccepted field is set to `true`. For implementation help, refer to eBay API documentation
`internationalOverride.returnPeriod`	Object	No	A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows. Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.
`internationalOverride.returnPeriod.value`	Integer	No	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.
`internationalOverride.returnPeriod.unit`	String	No	These enum values represent the time measurement unit, such as `DAY`. A span of time is defined when you apply the value specified in the value field to the value specified for unit. See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation
`internationalOverride.returnsAccepted`	Boolean	No	If set to `true`, the seller accepts international returns. If set to `false`, the seller does not accept international returns. This field is conditionally required if the seller chooses to have a separate international return policy.
`returnMethod`	String	No	This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation
`categoryTypes[]`	Array	No	This container indicates which category group that the return policy applies to. Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to `ALL_EXCLUDING_MOTORS_VEHICLES` for return business policies.
`categoryTypes[].name`	String	No	The category type to which the policy applies (motor vehicles or non-motor vehicles). The `MOTORS_VEHICLES` category type is not valid for return policies. eBay flows do not support the return of motor vehicles. For implementation help, refer to eBay API documentation
`categoryTypes[].default`	Boolean	No	Note: This field has been deprecated and is no longer used. Do not include this field in any create or update method. This field may be returned within the payload of a get method, but it can be ignored.
`marketplaceId`	String	No	The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation
`returnsAccepted`	Boolean	No	If set to `true`, the seller accepts returns. Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.
`returnInstructions`	String	No	This text-based field provides more details on seller-specified return instructions. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of `true` for the eBay category. Max length: 5000 (8000 for DE)
`name`	String	No	A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64
`refundMethod`	String	No	This value indicates the refund method that will be used by the seller for buyer returns. Important! If this field is not included in a return business policy, it will default to MONEY_BACK. For implementation help, refer to eBay API documentation
`returnShippingCostPayer`	String	No	This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either `BUYER` or `SELLER`. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. This field is conditionally required if returnsAccepted is set to `true`. For implementation help, refer to eBay API documentation
`returnPeriod`	Object	No	A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows. Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.
`returnPeriod.value`	Integer	No	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.
`returnPeriod.unit`	String	No	These enum values represent the time measurement unit, such as `DAY`. A span of time is defined when you apply the value specified in the value field to the value specified for unit. See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation
`restockingFeePercentage`	String	No	Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.