GET/marketplace/{marketplace_id}/get_site_visibility_policies
This method returns eBay international site visibility policy metadata for all leaf categories on the specified marketplace.
By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | string | This path parameter specifies the eBay marketplace for which policy information is retrieved. See HTTP Request Headers for a list of supported eBay marketplace ID values. Occurrence: Required |
| filter | string | This query parameter limits the response by only returning metadata for the specified�leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.Example: filter=categoryIds:{3767|171784} Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| siteVisibilityPolicies | array of SiteVisibilityPolicy | This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter. Occurrence: Always |
| siteVisibilityPolicies.categoryId | string | The unique identifier of the eBay leaf category for which metadata is being returned. Occurrence: Always |
| siteVisibilityPolicies.categoryTreeId | string | The unique identifier of the category tree. Occurrence: Always |
| siteVisibilityPolicies.crossBorderTradeAustraliaEnabled | boolean | If Occurrence: Conditional |
| siteVisibilityPolicies.crossBorderTradeGBEnabled | boolean | If Occurrence: Conditional |
| siteVisibilityPolicies.crossBorderTradeNorthAmericaEnabled | boolean | If Occurrence: Conditional |
| warnings | array of ErrorDetailV3 | An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. Occurrence: Conditional |
| warnings.category | string | The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:
Occurrence: Conditional |
| warnings.domain | string | Name of the domain containing the service or application. Occurrence: Conditional |
| warnings.errorId | integer | A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Occurrence: Conditional |
| warnings.inputRefIds | array of string | Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. Occurrence: Conditional |
| warnings.longMessage | string | An expanded version of message that should be around 100-200 characters long, but is not required to be such. Occurrence: Conditional |
| warnings.message | string | An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. Occurrence: Conditional |
| warnings.outputRefIds | array of string | Identifies specific response elements associated with the error, if any. Path format is the same as Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | This optional complex field type contains a list of one or more context-specific Occurrence: Conditional |
| warnings.parameters.name | string | Name of the entity that threw the error. Occurrence: Conditional |
| warnings.parameters.value | string | A description of the error. Occurrence: Conditional |
| warnings.subdomain | string | Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 204 | No content |
| 400 | Bad Request |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46000 | API_METADATA | APPLICATION | There was a problem with an eBay internal system or process.Contact eBay developer support for assistance. |
| 46001 | API_METADATA | REQUEST | The specified marketplace ID was not found. |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46002 | API_METADATA | REQUEST | The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}. |
| 46003 | API_METADATA | REQUEST | The specified categoryId was not found for the marketplace. |
| 46004 | API_METADATA | REQUEST | Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter. |
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get the eBay international site visibility policy metadata for a specified marketplace
This example retrieves the eBay international site visibility policy metadata for the three specified leaf categories, 9355 and 4959, and 63855.
This method returns an array of leaf categories from the category tree of the specified marketplace. Each node in the response contains metadata for the eBay international site visibility policies in each returned category.
Input
This method does not use a request payload.
This sample limits the response to only two category IDs using the filter query parameter.
This example uses the parameter: filter=categoryIds:{9355|4959|63855}
GEThttps://api.ebay.com/sell/metadata/v1/marketplace/EBAY_US/get_site_visibility_policies?filter=categoryIds:{9355|4959|63855}
Output
If the call is successful, the response body contains the eBay international site visibility policy metadata of the marketplace for the categories specified in the request.