Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Custom_policy API

The Custom_policy API from eBay — 2 operation(s) for custom_policy.

eBay Custom_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 Custom_policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 4 operations across 2 paths, and defines 5 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}.

4 operations 2 paths 5 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.9.2
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Custom_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 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom_policy 4
GET
/custom_policy/
This method retrieves the list of custom policies specified by the policytypes query parameter. Note: Custom policies are no longer coupled with a specific eBay marketplace, so the EBAY-C-MARKETPLACE…
getCustomPolicies 1 param → 200400500
POST
/custom_policy/
This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations. Two Custom Policy types are supported: Product Compliance (PRODUCTCO…
createCustomPolicy 1 param body → 201400409500
GET
/custom_policy/{custom_policy_id}
This method retrieves the custom policy specified by the custompolicyid path parameter. Note: Custom policies are no longer coupled with a specific eBay marketplace, so the EBAY-C-MARKETPLACE-ID requ…
getCustomPolicy 1 param → 200400404500
PUT
/custom_policy/{custom_policy_id}
This method updates an existing custom policy specified by the custompolicyid path parameter. This method overwrites the policy's Name , Label , and Description fields. Therefore, the complete, curre…
updateCustomPolicy 2 params body → 204400404409500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CustomPolicyResponse (7 properties), CustomPolicy (5 properties), CustomPolicyCreateRequest (4 properties), CompactCustomPolicyResponse (4 properties). Each schema is shown below with its type and property counts.

CompactCustomPolicyResponse
object
The response payload for requests that return a list of custom policies.
4 properties
CustomPolicyCreateRequest
object
This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace.
4 properties
CustomPolicy
object
This container defines a seller's custom policy identified by policy ID for the selected eBay marketplace. A successful call returns the requested policy infor…
5 properties
CustomPolicyRequest
object
3 properties
CustomPolicyResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-custom-policy-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
eBay Event_item API