{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Return_policy API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Return_policy", "type": "folder" }, "items": [ { "info": { "name": "getReturnPolicies", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/return_policy", "params": [ { "name": "marketplace_id", "value": "", "type": "query", "description": "This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.

Marketplaces and locales

Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target " }, { "info": { "name": "createReturnPolicy", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/return_policy", "headers": [ { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 marketplace. Return policies are not applicable to motor-vehicle listings.

A successful request returns the getReturnPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip:" }, { "info": { "name": "getReturnPolicy", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/return_policy/:return_policy_id", "params": [ { "name": "return_policy_id", "value": "", "type": "path", "description": "This path parameter specifies the unique identifier of the return policy you want to retrieve.

This ID can be retrieved for a return policy by using the getReturnPolicies method." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter." }, { "info": { "name": "updateReturnPolicy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.ebay.com{basePath}/return_policy/:return_policy_id", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "return_policy_id", "value": "", "type": "path", "description": "This path parameter specifies the ID of the return policy you want to update.

This ID can be retrieved for a return policy by using the getReturnPolicies method." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "deleteReturnPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ebay.com{basePath}/return_policy/:return_policy_id", "params": [ { "name": "return_policy_id", "value": "", "type": "path", "description": "This path parameter specifies the unique identifier of the return policy you want to delete.

This ID can be retrieved for a return policy by using the getReturnPolicies method." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter." }, { "info": { "name": "getReturnPolicyByName", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/return_policy/get_by_policy_name", "params": [ { "name": "marketplace_id", "value": "", "type": "query", "description": "This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum" }, { "name": "name", "value": "", "type": "query", "description": "This query parameter specifies the seller-defined name of the return policy you want to retrieve.

This value can be retrieved for a return policy by using the getReturnPolicies method." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters.

Marketplaces and locales

Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Langua" } ] } ], "bundled": true }