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
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createCustomPolicy | POST | /custom_policy/ | Creates a custom Product Compliance or Takeback policy for the associated seller account. | View createCustomPolicy - /custom_policy/ |
| getCustomPolicies | GET | /custom_policy/ | Retrieves all custom policies associated with the specified policy type(s). | View getCustomPolicies - /custom_policy/ |
| getCustomPolicy | GET | /custom_policy/{custom_policy_id} | Retrieves a custom policy identified by policy ID. | View getCustomPolicy - /custom_policy/{custom_policy_id} |
| updateCustomPolicy | PUT | /custom_policy/{custom_policy_id} | Updates details for an existing custom policy. | View updateCustomPolicy - /custom_policy/{custom_policy_id} |
fulfillment_policy
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createFulfillmentPolicy | POST | /fulfillment_policy/ | Creates a fulfillment policy for the associated seller account. | View createFulfillmentPolicy - /fulfillment_policy/ |
| deleteFulfillmentPolicy | DELETE | /fulfillment_policy/{fulfillmentPolicyId} | Deletes a fulfillment policy from the associated seller account. | View deleteFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId} |
| getFulfillmentPolicies | GET | /fulfillment_policy | Retrieves all the fulfillment policies associated with the seller's account for the specified marketplace. | View getFulfillmentPolicies - /fulfillment_policy |
| getFulfillmentPolicy | GET | /fulfillment_policy/{fulfillmentPolicyId} | Retrieves the fulfillment policy associated with the specified fulfillment policy ID. | View getFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId} |
| getFulfillmentPolicyByName | GET | /fulfillment_policy/get_by_policy_name | Retrieves the fulfillment policy associated with the specified fulfillment policy name. | View getFulfillmentPolicyByName - /fulfillment_policy/get_by_policy_name |
| updateFulfillmentPolicy | PUT | /fulfillment_policy/{fulfillmentPolicyId} | Updates the fulfillment policy associated with the specified fulfillment policy ID. | View updateFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId} |
payment_policy
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createPaymentPolicy | POST | /payment_policy | Creates a payment policy for the associated seller account. | View createPaymentPolicy - /payment_policy |
| deletePaymentPolicy | DELETE | /payment_policy/{payment_policy_id} | Deletes a payment policy from the associated seller account. | View deletePaymentPolicy - /payment_policy/{payment_policy_id} |
| getPaymentPolicies | GET | /payment_policy | Retrieves all the payment policies associated with the seller's account for the specified marketplace. | View getPaymentPolicies - /payment_policy |
| getPaymentPolicy | GET | /payment_policy/{payment_policy_id} | Retrieves the payment policy associated with the specified payment policy ID. | View getPaymentPolicy - /payment_policy/{payment_policy_id} |
| getPaymentPolicyByName | GET | /payment_policy/get_by_policy_name | Retrieves the payment policy associated with the specified payment policy name. | View getPaymentPolicyByName - /payment_policy/get_by_policy_name |
| updatePaymentPolicy | PUT | /payment_policy/{payment_policy_id} | Updates the payment policy associated with the specified payment policy ID. | View updatePaymentPolicy - /payment_policy/{payment_policy_id} |
payments_program
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPaymentsProgram | GET | /payments_program/{marketplace_id}/{payments_program_type} | Important! This method has been deprecated. Returns the seller's status relating to the specified payments program. | View getPaymentsProgram - /payments_program/{marketplace_id}/{payments_program_type} |
payments_program:onboarding
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPaymentsProgramOnboarding | GET | /payments_program/{marketplace_id}/{payments_program_type}/onboarding | Important! This method has been deprecated. Retrieves a seller's onboarding status for a payment program in a specified marketplace. | View getPaymentsProgramOnboarding - /payments_program/{marketplace_id}/{payments_program_type}/onboarding |
privilege
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPrivileges | GET | /privilege | Retrieves a seller's account privileges (e.g., selling limits and registration status). | View getPrivileges - /privilege |
program
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getOptedInPrograms | GET | /program/get_opted_in_programs | Retrieves the eBay seller programs for which the seller has "opted-in." | View getOptedInPrograms - /program/get_opted_in_programs |
| optInToProgram | POST | /program/opt_in | Opts the seller in to the specified eBay seller program. | View optInToProgram - /program/opt_in |
| optOutOfProgram | POST | /program/opt_out | Opts the seller out of the specified eBay seller program. | View optOutOfProgram - /program/opt_out |
rate_table
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getRateTables | GET | /rate_table | Returns details about the shipping rate tables defined by the seller. | View getRateTables - /rate_table |
return_policy
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createReturnPolicy | POST | /return_policy | Creates a seller's return policy for the specific marketplace. | View createReturnPolicy - /return_policy |
| deleteReturnPolicy | DELETE | /return_policy/{return_policy_id} | Deletes a return policy from the associated seller account. | View deleteReturnPolicy - /return_policy/{return_policy_id} |
| getReturnPolicies | GET | /return_policy | Retrieves all the return policies associated with the seller's account for the the specified marketplace. | View getReturnPolicies - /return_policy |
| getReturnPolicy | GET | /return_policy/{return_policy_id} | Retrieves the return policy associated with the specified return policy ID. | View getReturnPolicy - /return_policy/{return_policy_id} |
| getReturnPolicyByName | GET | /return_policy/get_by_policy_name | Retrieves the return policy associated with the specified return policy name. | View getReturnPolicyByName - /return_policy/get_by_policy_name |
| updateReturnPolicy | PUT | /return_policy/{return_policy_id} | Updates the return policy associated with the specified return policy ID. | View updateReturnPolicy - /return_policy/{return_policy_id} |
sales_tax
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createOrReplaceSalesTax | PUT | /sales_tax/{countryCode}/{jurisdictionId} | Creates or updates a sales tax table entry for the specified country and jurisdiction. | View createOrReplaceSalesTax - /sales_tax/{countryCode}/{jurisdictionId} |
| deleteSalesTax | DELETE | /sales_tax/{countryCode}/{jurisdictionId} | Deletes the sales tax table entry for the specified country and jurisdiction. | View deleteSalesTax - /sales_tax/{countryCode}/{jurisdictionId} |
| getSalesTax | GET | /sales_tax/{countryCode}/{jurisdictionId} | Retrieves the sales tax table entry for the specified country and jurisdiction. | View getSalesTax - /sales_tax/{countryCode}/{jurisdictionId} |
| getSalesTaxes | GET | /sales_tax | Retrieves the sales tax table for the specified country. The table is comprised of entries for the different jurisdictions in the country. | View getSalesTaxes - /sales_tax |
subscription
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getSubscription | GET | /subscription | Retrieves subscriptions for the seller account. | View getSubscription - /subscription |
kyc
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getKYC | GET | /kyc | Important! This method has been deprecated. Managed payments seller discovers any 'Know Your Customer' (KYC) check action items. | View getKYC - /kyc |
advertising_eligibility
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getAdvertisingEligibility | GET | /advertising_eligibility | Retrieves the seller eligibility status for eBay advertising programs. | View getAdvertisingEligibility - /advertising_eligibility |