API docs by Redocly

Account API (v1.9.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions.

custom_policy

getCustomPolicies

This method retrieves the list of custom policies specified by the policy_types query parameter for the selected eBay marketplace.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)


For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
policy_types
string

This query parameter specifies the type of custom policies to be returned.

Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.

Note: Omitting this query parameter from a request will also return policies of all policy types.

Two Custom Policy types are supported:

  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

This header parameter specifies the eBay markeplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

Responses

Response samples

Content type
application/json
{
  • "customPolicies": [
    ],
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "total": 0
}

createCustomPolicy

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 (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)
Each Custom Policy targets a policyType and eBay marketplace combination. Multiple policies may be created as follows:
  • Product Compliance: a maximum of 10 policies per eBay marketplace may be created
  • Takeback: a maximum of 3 policies per eBay marketplace may be created
A successful create policy call returns an HTTP status code of 201 Created with the system-generated policy ID included in the Location response header.

Product Compliance Policy

Product Compliance policies disclose product information as required for regulatory compliance.

Note: A maximum of 10 Product Compliance policies per eBay marketplace may be created.

Takeback Policy

Takeback policies describe the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one.

Note: A maximum of 3 Takeback policies per eBay marketplace may be created.

Authorizations:
Authorization_Code
header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

This header parameter specifies the eBay markeplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

Request Body schema: application/json

Request to create a new Custom Policy.

description
string

Details of the seller's specific policy and terms for this policy.

Max length: 15,000

label
string

Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to detailed policy information.

Max length: 65

name
string

The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace.
Note: This field is visible only to the seller.

Max length: 65

policyType
string

Specifies the type of custom policy being created.

Two Custom Policy types are supported:

  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)
For implementation help, refer to eBay API documentation

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "label": "string",
  • "name": "string",
  • "policyType": "string"
}

Response samples

Content type
application/json
{ }

getCustomPolicy

This method retrieves the custom policy specified by the custom_policy_id path parameter for the selected eBay marketplace.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)


For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
path Parameters
custom_policy_id
required
string

This path parameter is the unique custom policy identifier for the policy to be returned.

Note: This value is automatically assigned by the system when the policy is created.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

This header parameter specifies the eBay markeplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

Responses

Response samples

Content type
application/json
{
  • "customPolicyId": "string",
  • "description": "string",
  • "label": "string",
  • "name": "string",
  • "policyType": "string"
}

updateCustomPolicy

This method updates an existing custom policy specified by the custom_policy_id path parameter for the selected marketplace. This method overwrites the policy's Name, Label, and Description fields. Therefore, the complete, current text of all three policy fields must be included in the request payload even when one or two of these fields will not actually be updated.

For example, the value for the Label field is to be updated, but the Name and Description values will remain unchanged. The existing Name and Description values, as they are defined in the current policy, must also be passed in.

A successful policy update call returns an HTTP status code of 204 No Content.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)


For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
path Parameters
custom_policy_id
required
string

This path parameter is the unique custom policy identifier for the policy to be returned.

Note: This value is automatically assigned by the system when the policy is created.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

This header parameter specifies the eBay markeplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

Request Body schema: application/json

Request to update a current custom policy.

description
string

Details of the seller's specific policy and terms for this policy.

Max length: 15,000

label
string

Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to detailed policy information.

Max length: 65

name
string

The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace.
Note: This field is visible only to the seller.

Max length: 65

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "label": "string",
  • "name": "string"
}

fulfillment_policy

createFulfillmentPolicy

This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers.

Each policy targets a specific eBay marketplace and a category group type, and you can create multiple policies for each combination.

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

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

Using the eBay standard envelope service (eSE)

The eBay standard envelope service (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific Trading Cards categories (not all categories are supported), and to Coins & Paper Money, Postcards, and Stamps. See Using the eBay standard envelope (eSE) service.

Authorizations:
Authorization_Code
Request Body schema: application/json

Request to create a seller account fulfillment policy.

Array of objects (CategoryType)

This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

description
string

A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

freightShipping
boolean

This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.

Default: false

globalShipping
boolean

This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.

It is possible for a seller to use a combination of the Global Shipping Program and other international shipping services.

If this value is set to false or if the field is omitted, the seller is responsible for manually specifying individual international shipping services (if the seller ships internationally)., as described in Setting up worldwide shipping.

Sellers can opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.

Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US sellers who are opted in to the Global Shipping Program will be automatically opted in to eBay International Shipping when it becomes available to them. All US sellers will be migrated by March 31, 2023.

eBay International Shipping is an account level setting, and no field needs to be set in a Fulfillment business policy to enable it. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.

Default: false

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

localPickup
boolean

This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.

With local pickup, the buyer and seller make arrangements for pickup time and location.

Default: false

marketplaceId
string

The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

pickupDropOff
boolean

This field should be included and set to true if the seller offers the "Click and Collect" feature for an item.

To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces.

In addition to setting this field to true, the merchant must also do the following to enable the "Click and Collect" option on a listing:

  • Have inventory for the product at one or more physical stores tied to the merchant's account.

    Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations.

  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Set the immediatePay flag in the payment policy to 'true'.
    • Have a valid store location with a complete street address.

When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.

Default: false

Array of objects (ShippingOption)

This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). The optionType field is used to indicate whether the ShippingOption object applies to domestic or international shipping, and the costType field is used to indicate whether flat-rate shipping or calculated shipping will be used. The rateTableId field can be used to associate a defined shipping rate table to the policy, and the packageHandlingCost container can be used to set a handling charge for the policy.

A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option.

object (RegionSet)

This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship.

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    }
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "fulfillmentPolicyId": "string",
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    },
  • "warnings": [
    ]
}

getFulfillmentPolicy

This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
fulfillmentPolicyId
required
string

This path parameter specifies the ID of the fulfillment policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "fulfillmentPolicyId": "string",
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    }
}

updateFulfillmentPolicy

This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_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.

Authorizations:
Authorization_Code
path Parameters
fulfillmentPolicyId
required
string

This path parameter specifies the ID of the fulfillment policy you want to update.

Request Body schema: application/json

Fulfillment policy request

Array of objects (CategoryType)

This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

description
string

A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

freightShipping
boolean

This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.

Default: false

globalShipping
boolean

This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.

It is possible for a seller to use a combination of the Global Shipping Program and other international shipping services.

If this value is set to false or if the field is omitted, the seller is responsible for manually specifying individual international shipping services (if the seller ships internationally)., as described in Setting up worldwide shipping.

Sellers can opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.

Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US sellers who are opted in to the Global Shipping Program will be automatically opted in to eBay International Shipping when it becomes available to them. All US sellers will be migrated by March 31, 2023.

eBay International Shipping is an account level setting, and no field needs to be set in a Fulfillment business policy to enable it. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.

Default: false

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

localPickup
boolean

This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.

With local pickup, the buyer and seller make arrangements for pickup time and location.

Default: false

marketplaceId
string

The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

pickupDropOff
boolean

This field should be included and set to true if the seller offers the "Click and Collect" feature for an item.

To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces.

In addition to setting this field to true, the merchant must also do the following to enable the "Click and Collect" option on a listing:

  • Have inventory for the product at one or more physical stores tied to the merchant's account.

    Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations.

  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Set the immediatePay flag in the payment policy to 'true'.
    • Have a valid store location with a complete street address.

When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.

Default: false

Array of objects (ShippingOption)

This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). The optionType field is used to indicate whether the ShippingOption object applies to domestic or international shipping, and the costType field is used to indicate whether flat-rate shipping or calculated shipping will be used. The rateTableId field can be used to associate a defined shipping rate table to the policy, and the packageHandlingCost container can be used to set a handling charge for the policy.

A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option.

object (RegionSet)

This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship.

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    }
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "fulfillmentPolicyId": "string",
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    },
  • "warnings": [
    ]
}

deleteFulfillmentPolicy

This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
fulfillmentPolicyId
required
string

This path parameter specifies the ID of the fulfillment policy to delete.

Responses

getFulfillmentPolicies

This method retrieves all the fulfillment 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 the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum

Responses

Response samples

Content type
application/json
{
  • "fulfillmentPolicies": [
    ],
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "total": 0
}

getFulfillmentPolicyByName

This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as 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-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

This query parameter specifies 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
required
string

This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "freightShipping": true,
  • "fulfillmentPolicyId": "string",
  • "globalShipping": true,
  • "handlingTime": {
    },
  • "localPickup": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "pickupDropOff": true,
  • "shippingOptions": [
    ],
  • "shipToLocations": {
    }
}

payment_policy

getPaymentPolicies

This method retrieves all the payment 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 the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "paymentPolicies": [
    ],
  • "prev": "string",
  • "total": 0
}

createPaymentPolicy

This method creates a new payment policy where the policy encapsulates seller's terms for order payments.

Each policy targets a specific eBay marketplace and category group, and you can create multiple policies for each combination.

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

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

Authorizations:
Authorization_Code
Request Body schema: application/json

Payment policy request

Array of objects (CategoryType)

This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

object (Deposit)

This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing.

description
string

A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

immediatePay
boolean

This field should be included and set to true if the seller wants to require immediate payment from the buyer for:

  • A fixed-price item
  • An auction item where the buyer is using the 'Buy it Now' option
  • A deposit for a motor vehicle listing

Default: False

marketplaceId
string

The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

paymentInstructions
string

Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.

A free-form string field that allows sellers to add detailed payment instructions to their listings.
Array of objects (PaymentMethod)

Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.

This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ],
  • "paymentPolicyId": "string",
  • "warnings": [
    ]
}

getPaymentPolicy

This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
payment_policy_id
required
string

This path parameter specifies the ID of the payment policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ],
  • "paymentPolicyId": "string"
}

updatePaymentPolicy

This method updates an existing payment policy. Specify the policy you want to update using the payment_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.

Authorizations:
Authorization_Code
path Parameters
payment_policy_id
required
string

This path parameter specifies the ID of the payment policy you want to update.

Request Body schema: application/json

Payment policy request

Array of objects (CategoryType)

This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

object (Deposit)

This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing.

description
string

A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

immediatePay
boolean

This field should be included and set to true if the seller wants to require immediate payment from the buyer for:

  • A fixed-price item
  • An auction item where the buyer is using the 'Buy it Now' option
  • A deposit for a motor vehicle listing

Default: False

marketplaceId
string

The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

paymentInstructions
string

Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.

A free-form string field that allows sellers to add detailed payment instructions to their listings.
Array of objects (PaymentMethod)

Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.

This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ],
  • "paymentPolicyId": "string",
  • "warnings": [
    ]
}

deletePaymentPolicy

This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
payment_policy_id
required
string

This path parameter specifies the ID of the payment policy you want to delete.

Responses

getPaymentPolicyByName

This method retrieves the details of a specific payment 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-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

This query parameter specifies 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
required
string

This query parameter specifies the seller-defined name of the payment policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "deposit": {
    },
  • "description": "string",
  • "fullPaymentDueIn": {
    },
  • "immediatePay": true,
  • "marketplaceId": "string",
  • "name": "string",
  • "paymentInstructions": "string",
  • "paymentMethods": [
    ],
  • "paymentPolicyId": "string"
}

payments_program

getPaymentsProgram

Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.

This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.

Authorizations:
Authorization_Code
path Parameters
marketplace_id
required
string

This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.

payments_program_type
required
string

This path parameter specifies the payments program whose status is returned by the call.

Responses

Response samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "paymentsProgramType": "string",
  • "status": "string",
  • "wasPreviouslyOptedIn": true
}

onboarding

getPaymentsProgramOnboarding

Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.

This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.

Authorizations:
Authorization_Code
path Parameters
marketplace_id
required
string

The eBay marketplace ID associated with the onboarding status to retrieve.

payments_program_type
required
string

The type of payments program whose status is returned by the method.

Responses

Response samples

Content type
application/json
{
  • "onboardingStatus": "string",
  • "steps": [
    ]
}

privilege

getPrivileges

This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimt (the amount and quantity they can sell on a given day).

Authorizations:
Authorization_Code

Responses

Response samples

Content type
application/json
{
  • "sellerRegistrationCompleted": true,
  • "sellingLimit": {
    }
}

program

getOptedInPrograms

This method gets a list of the seller programs that the seller has opted-in to.

Authorizations:
Authorization_Code

Responses

Response samples

Content type
application/json
{
  • "programs": [
    ]
}

optInToProgram

This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs.

Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.

Authorizations:
Authorization_Code
Request Body schema: application/json

Program being opted-in to.

programType
string

A seller program in to which a seller can opt-in. For implementation help, refer to eBay API documentation

Responses

Request samples

Content type
application/json
{
  • "programType": "string"
}

optOutOfProgram

This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the getOptedInPrograms call.

Authorizations:
Authorization_Code
Request Body schema: application/json

Program being opted-out of.

programType
string

A seller program in to which a seller can opt-in. For implementation help, refer to eBay API documentation

Responses

Request samples

Content type
application/json
{
  • "programType": "string"
}

rate_table

getRateTables

This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables.

The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options.

This call currently supports getting rate tables related to the following marketplaces:

  • EBAY_AU
  • EBAY_CA
  • EBAY_DE
  • EBAY_ES
  • EBAY_FR
  • EBAY_GB
  • EBAY_IT
  • EBAY_US
Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables.

Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to Shipping rate tables in My eBay to create and update rate tables.

Authorizations:
Authorization_Code
query Parameters
country_code
string

This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum

Responses

Response samples

Content type
application/json
{
  • "rateTables": [
    ]
}

return_policy

getReturnPolicies

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 the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

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

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "returnPolicies": [
    ],
  • "total": 0
}

createReturnPolicy

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: For details on creating and using the business policies supported by the Account API, see eBay business policies.

Authorizations:
Authorization_Code
Request Body schema: application/json

Return policy request

Array of objects (CategoryType)

This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.

description
string

A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

extendedHolidayReturnsOffered
boolean

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

object (InternationalReturnOverrideType)

This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.

marketplaceId
string

The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

refundMethod
string

This value indicates the refund method that will be used by the seller for buyer returns.

Important! If this field is not included in a return business policy, it will default to MONEY_BACK.

For implementation help, refer to eBay API documentation

restockingFeePercentage
string

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.

returnInstructions
string

This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)

returnMethod
string

This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

returnsAccepted
boolean

If set to true, the seller accepts returns.

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

returnShippingCostPayer
string

This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string"
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnPolicyId": "string",
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string",
  • "warnings": [
    ]
}

getReturnPolicy

This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
return_policy_id
required
string

This path parameter specifies the of the return policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnPolicyId": "string",
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string"
}

updateReturnPolicy

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.

Authorizations:
Authorization_Code
path Parameters
return_policy_id
required
string

This path parameter specifies the ID of the return policy you want to update.

Request Body schema: application/json

Container for a return policy request.

Array of objects (CategoryType)

This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.

description
string

A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

extendedHolidayReturnsOffered
boolean

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

object (InternationalReturnOverrideType)

This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.

marketplaceId
string

The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation

name
string

A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

refundMethod
string

This value indicates the refund method that will be used by the seller for buyer returns.

Important! If this field is not included in a return business policy, it will default to MONEY_BACK.

For implementation help, refer to eBay API documentation

restockingFeePercentage
string

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.

returnInstructions
string

This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)

returnMethod
string

This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation

object (TimeDuration)

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 specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

returnsAccepted
boolean

If set to true, the seller accepts returns.

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

returnShippingCostPayer
string

This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation

Responses

Request samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string"
}

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnPolicyId": "string",
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string",
  • "warnings": [
    ]
}

deleteReturnPolicy

This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.

Authorizations:
Authorization_Code
path Parameters
return_policy_id
required
string

This path parameter specifies the ID of the return policy you want to delete.

Responses

getReturnPolicyByName

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-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Authorizations:
Authorization_Code
query Parameters
marketplace_id
required
string

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
required
string

This query parameter specifies the seller-defined name of the return policy you want to retrieve.

Responses

Response samples

Content type
application/json
{
  • "categoryTypes": [
    ],
  • "description": "string",
  • "extendedHolidayReturnsOffered": true,
  • "internationalOverride": {
    },
  • "marketplaceId": "string",
  • "name": "string",
  • "refundMethod": "string",
  • "restockingFeePercentage": "string",
  • "returnInstructions": "string",
  • "returnMethod": "string",
  • "returnPeriod": {
    },
  • "returnPolicyId": "string",
  • "returnsAccepted": true,
  • "returnShippingCostPayer": "string"
}

sales_tax

getSalesTax

This call gets the current sales tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters. All four response fields will be returned if a sales tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.

Important! In most US states and territories, eBay now 'collects and remits' sales tax, so sellers can no longer configure sales tax rates for these states/territories.

Authorizations:
Authorization_Code
path Parameters
countryCode
required
string

This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.

jurisdictionId
required
string

This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry you want to retrieve. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.

Responses

Response samples

Content type
application/json
{
  • "countryCode": "string",
  • "salesTaxJurisdictionId": "string",
  • "salesTaxPercentage": "string",
  • "shippingAndHandlingTaxed": true
}

createOrReplaceSalesTax

This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId.

A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.

You can set up tax tables for countries that support different tax jurisdictions. Currently, only Canada, India, and the US support separate tax jurisdictions. If you sell into any of these countries, you can set up tax tables for any of the country's jurisdictions. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.

For details on using this call, see Establishing sales-tax tables.

Important! In the US, eBay now 'collects and remits' sales tax for every US state except for Missouri (and a few US territories), so sellers can no longer configure sales tax rates for any states except Missouri. With eBay 'collect and remit', eBay calculates the sales tax, collects the sales tax from the buyer, and remits the sales tax to the tax authorities at the buyer's location.

Authorizations:
Authorization_Code
path Parameters
countryCode
required
string

This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create a sales tax table entry.

jurisdictionId
required
string

This path parameter specifies the ID of the tax jurisdiction for the table entry you want to create. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.

Request Body schema: application/json

A container that describes the how the sales tax is calculated.

salesTaxPercentage
string

This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is set here, such as 7.75.

shippingAndHandlingTaxed
boolean

This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false.

Responses

Request samples

Content type
application/json
{
  • "salesTaxPercentage": "string",
  • "shippingAndHandlingTaxed": true
}

deleteSalesTax

This call deletes a sales tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.

Authorizations:
Authorization_Code
path Parameters
countryCode
required
string

This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table entry you want to delete.

jurisdictionId
required
string

This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.

Responses

getSalesTaxes

Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria.

Important! In most US states and territories, eBay now 'collects and remits' sales tax, so sellers can no longer configure sales tax rates for these states/territories.

Authorizations:
Authorization_Code
query Parameters
country_code
required
string

This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum

Responses

Response samples

Content type
application/json
{
  • "salesTaxes": [
    ]
}

subscription

getSubscription

This method retrieves a list of subscriptions associated with the seller account.

Authorizations:
Authorization_Code
query Parameters
limit
string

This field is for future use.

continuation_token
string

This field is for future use.

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "subscriptions": [
    ],
  • "total": 0
}

kyc

getKYC

Note:This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just returne an empty payload with a 204 No Content HTTP status code.

Authorizations:
Authorization_Code

Responses

Response samples

Content type
application/json
{
  • "kycChecks": [
    ]
}

advertising_eligibility

getAdvertisingEligibility

This method allows developers to check the seller eligibility status for eBay advertising programs.

Authorizations:
Authorization_Code
query Parameters
program_types
string

A comma-separated list of eBay advertising programs.

Tip: See the AdvertisingProgramEnum type for possible values.

If no programs are specified, the results will be returned for all programs.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked.

Note: This value is case-sensitive.

Responses

Response samples

Content type
application/json
{
  • "advertisingEligibility": [
    ]
}