Get eBay Business Policies

Updated 3 weeks ago ​by nussi

Overview

In order to get list of the eBay business policies for a company, you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed to the service call.

Endpoint

Example for such endpoint for TT server is:

​​https://tt.api.sellercloud.com/rest/api/Companies/{id}/Settings/ebay/BusinessPolicies

For your server endpoint will be:

​​https://{your_server_id}.api.sellercloud.com/rest/api/Companies/{id}/Settings/ebay/BusinessPolicies

Request

  • Method Type: HttpGet
  • Authorization: Use Bearer Token (where 'Token' is the token received from the token authentication)
  • Header info: Content-Type: application/json
  • Parameters:

Parameter

Data Type

Description

Is Required

id

integer

ID of existing company

true

siteCode

integer

eBay site code key

Possible values can be obtained from this endpoint

true

pageNumber

integer

Page number. Default is 1.

false

pageSize

integer

Page size. Default is 10.

false

Response

  • If user is authenticated, then response will be Status Code 200 => OK and list of the company eBay business policies in JSON format in the response body
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • In case of error, response will be Status Code 500 => Internal Server Error

Response Body Format

{
"Policies": [
{
"Id": "string",
"Type": "PAYMENT",
"Name": "string",
"Version": "string",
"Description": "string"
}
],
"TotalPolicies": 0
}

Possible values for the Policy 'Type' enumeration: PAYMENT = 0, RETURN_POLICY = 1, SHIPPING = 2


How did we do?