Skip to main content

Important: Due to EU & UK Payments Regulatory Requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK seller. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

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 NameHTTP MethodPathSummarySamples
createCustomPolicyPOST/custom_policy/Creates a custom Product Compliance or Takeback policy for the associated seller account.View createCustomPolicy - /custom_policy/
getCustomPoliciesGET/custom_policy/Retrieves all custom policies associated with the specified eBay marketplace and policy type(s).View getCustomPolicies - /custom_policy/
getCustomPolicyGET/custom_policy/{custom_policy_id}Retrieves a custom policy identified by policy ID for the selected eBay marketplace.View getCustomPolicy - /custom_policy/{custom_policy_id}
updateCustomPolicyPUT/custom_policy/{custom_policy_id}Updates details for an existing custom policy.View updateCustomPolicy - /custom_policy/{custom_policy_id}

fulfillment_policy

Method NameHTTP MethodPathSummarySamples
createFulfillmentPolicyPOST/fulfillment_policy/Creates a fulfillment policy for the associated seller account.View createFulfillmentPolicy - /fulfillment_policy/
deleteFulfillmentPolicyDELETE/fulfillment_policy/{fulfillmentPolicyId}Deletes a fulfillment policy from the associated seller account.View deleteFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}
getFulfillmentPoliciesGET/fulfillment_policyRetrieves all the fulfillment policies associated with the specified marketplace.View getFulfillmentPolicies - /fulfillment_policy
getFulfillmentPolicyGET/fulfillment_policy/{fulfillmentPolicyId}Retrieves the fulfillment policy associated with the specified fulfillment policy ID.View getFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}
getFulfillmentPolicyByNameGET/fulfillment_policy/get_by_policy_nameRetrieves the fulfillment policy associated with the specified fulfillment policy name.View getFulfillmentPolicyByName - /fulfillment_policy/get_by_policy_name
updateFulfillmentPolicyPUT/fulfillment_policy/{fulfillmentPolicyId}Updates the fulfillment policy associated with the specified fulfillment policy ID.View updateFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}

payment_policy

Method NameHTTP MethodPathSummarySamples
createPaymentPolicyPOST/payment_policyCreates a payment policy for the associated seller account.View createPaymentPolicy - /payment_policy
deletePaymentPolicyDELETE/payment_policy/{payment_policy_id}Deletes a payment policy from the associated seller account.View deletePaymentPolicy - /payment_policy/{payment_policy_id}
getPaymentPoliciesGET/payment_policyRetrieves all the payment policies associated with the specified marketplace.View getPaymentPolicies - /payment_policy
getPaymentPolicyGET/payment_policy/{payment_policy_id}Retrieves the payment policy associated with the specified payment policy ID.View getPaymentPolicy - /payment_policy/{payment_policy_id}
getPaymentPolicyByNameGET/payment_policy/get_by_policy_nameRetrieves the payment policy associated with the specified payment policy name.View getPaymentPolicyByName - /payment_policy/get_by_policy_name
updatePaymentPolicyPUT/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 NameHTTP MethodPathSummarySamples
getPaymentsProgramGET/payments_program/{marketplace_id}/{payments_program_type}Returns the seller's status relating to the specified payments program.View getPaymentsProgram - /payments_program/{marketplace_id}/{payments_program_type}

payments_program:onboarding

Method NameHTTP MethodPathSummarySamples
getPaymentsProgramOnboardingGET/payments_program/{marketplace_id}/{payments_program_type}/onboardingView getPaymentsProgramOnboarding - /payments_program/{marketplace_id}/{payments_program_type}/onboarding

privilege

Method NameHTTP MethodPathSummarySamples
getPrivilegesGET/privilegeRetrieves a seller's account privileges (e.g., selling limits and registration status).View getPrivileges - /privilege

program

Method NameHTTP MethodPathSummarySamples
getOptedInProgramsGET/program/get_opted_in_programsRetrieves the eBay seller programs for which the seller has "opted-in."View getOptedInPrograms - /program/get_opted_in_programs
optInToProgramPOST/program/opt_inOpts the seller in to the specified eBay seller program.View optInToProgram - /program/opt_in
optOutOfProgramPOST/program/opt_outOpts the seller out of the specified eBay seller program.View optOutOfProgram - /program/opt_out

rate_table

Method NameHTTP MethodPathSummarySamples
getRateTablesGET/rate_tableReturns details about the shipping rate tables defined by the seller.View getRateTables - /rate_table

return_policy

Method NameHTTP MethodPathSummarySamples
createReturnPolicyPOST/return_policyCreates a seller's return policy for the specific marketplace.View createReturnPolicy - /return_policy
deleteReturnPolicyDELETE/return_policy/{return_policy_id}Deletes a return policy from the associated seller account.View deleteReturnPolicy - /return_policy/{return_policy_id}
getReturnPoliciesGET/return_policyRetrieves all the return policies associated with the specified marketplace.View getReturnPolicies - /return_policy
getReturnPolicyGET/return_policy/{return_policy_id}Retrieves the return policy associated with the specified return policy ID.View getReturnPolicy - /return_policy/{return_policy_id}
getReturnPolicyByNameGET/return_policy/get_by_policy_nameRetrieves the return policy associated with the specified return policy name.View getReturnPolicyByName - /return_policy/get_by_policy_name
updateReturnPolicyPUT/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 NameHTTP MethodPathSummarySamples
createOrReplaceSalesTaxPUT/sales_tax/{countryCode}/{jurisdictionId}This method creates or updates a sales tax table entry for the specified country and jurisdiction.View createOrReplaceSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
deleteSalesTaxDELETE/sales_tax/{countryCode}/{jurisdictionId}This method deletes the sales tax table entry for the specified country and jurisdiction.View deleteSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
getSalesTaxGET/sales_tax/{countryCode}/{jurisdictionId}This method retrieves the sales tax table entry for the specified country and jurisdiction.View getSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
getSalesTaxesGET/sales_taxThis method 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 NameHTTP MethodPathSummarySamples
getSubscriptionGET/subscriptionRetrieves subscriptions for the account.View getSubscription - /subscription

kyc

Method NameHTTP MethodPathSummarySamples
getKYCGET/kycManaged payments seller discovers any 'Know Your Customer' (KYC) check action items.View getKYC - /kyc

advertising_eligibility

Method NameHTTP MethodPathSummarySamples
getAdvertisingEligibilityGET/advertising_eligibilityRetrieves the seller eligibility status for eBay advertising programs.View getAdvertisingEligibility - /advertising_eligibility