ebay.com – sell-account

Tools (38)

Extracted live via the executor SDK.

• advertisingEligibility.getAdvertisingEligibility

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

• customPolicy.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.

• customPolicy.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.

• customPolicy.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.

• customPolicy.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.

• fulfillmentPolicy.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.

• fulfillmentPolicy.deleteFulfillmentPolicy

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

• fulfillmentPolicy.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.

• fulfillmentPolicy.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.

• fulfillmentPolicy.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.

• fulfillmentPolicy.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.

• 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.

• 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.

• paymentPolicy.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.

• paymentPolicy.deletePaymentPolicy

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

• paymentPolicy.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.

• paymentPolicy.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.

• paymentPolicy.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.

• paymentPolicy.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.

• paymentsProgram.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.

• 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).

• program.getOptedInPrograms

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

• program.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.

• program.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.

• rateTable.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.

• returnPolicy.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.

• returnPolicy.deleteReturnPolicy

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

• returnPolicy.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.

• returnPolicy.getReturnPolicy

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

• returnPolicy.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.

• returnPolicy.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.

• salesTax.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.

• salesTax.deleteSalesTax

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

• salesTax.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.

• salesTax.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.

• subscription.getSubscription

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

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools