eBay Return_policy API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Return_policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
6 operations
across 3 paths,
and defines 9 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
6 operations3 paths9 schemas1 DELETE3 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
eBay Return_policy API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Return_policy 6
GET
/return_policy
This method retrieves all the return policies configured for the marketplace you specify using the marketplaceid query parameter. Marketplaces and locales Get the correct policies for a marketplace t…
getReturnPolicies1 param→ 200400500
POST
/return_policy
This method creates a new return policy where the policy encapsulates seller's terms for returning items. Each policy targets a specific marketplace, and you can create multiple policies for each mar…
createReturnPolicy1 parambody→ 201400500
GET
/return_policy/{return_policy_id}
This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
getReturnPolicy1 param→ 200400404500
PUT
/return_policy/{return_policy_id}
This method updates an existing return policy. Specify the policy you want to update using the returnpolicyid path parameter. Supply a complete policy payload with the updates you want to make; this…
updateReturnPolicy2 paramsbody→ 200400404500
DELETE
/return_policy/{return_policy_id}
This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.
deleteReturnPolicy1 param→ 204400404409500
GET
/return_policy/get_by_policy_name
This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplaceid in the request query parameters. Marketplaces and locales Get the correct p…
getReturnPolicyByName2 params→ 200400500
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SetReturnPolicyResponse (15 properties), ReturnPolicy (14 properties), ReturnPolicyRequest (13 properties), Error (9 properties). Each schema is shown below with its type and property counts.
ReturnPolicyResponse
object
The response payload for the getReturnPolicies method. Note : Pagination has not yet been enabled for getReturnPolicies , so all of the pagination-related fiel…
7 properties
ReturnPolicy
object
This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace.
14 properties
ErrorParameter
object
A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error.
2 properties
SetReturnPolicyResponse
object
A complex type that is populated with a response containing a return policies.
15 properties
ReturnPolicyRequest
object
This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a retu…
13 properties
Error
object
A container that defines the elements of error and warning messages.
9 properties
TimeDuration
object
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 specif…
2 properties
CategoryType
object
The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings. Each business policy can…
2 properties
InternationalReturnOverrideType
object
This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, b…
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
