Account v1 API
API version: v1.9.3
Auth
OAuth2
Base URL
https://api.ebay.com/sell/account/v1
Setup
- 1. Configure auth: OAuth2
- GET /custompolicy/ -- verify access
- POST /custompolicy/ -- create first custom_policy
Endpoints
37 endpoints across 13 groups. See references/api-spec.lap for full details.
custompolicy| Method | Path | Description |
|---|
| GET | /custompolicy/ | This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policytypes query parameter. |
| POST |
/custompolicy/ | This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a policyType. Multiple policies may be created as using the following custom policy types:PRODUCTCOMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance. Note: A maximum of 60 Product Compliance policies per seller may be created.TAKEBACK: 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 18 Takeback policies per seller 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. |
| GET | /custom
policy/{custompolicy
id} | This method retrieves the custom policy specified by the custompolicy_id path parameter. |
| PUT | /custom
policy/{custompolicy
id} | This method updates an existing custom policy specified by the custompolicy_id path parameter. Since this method overwrites the policy's name, label, and description fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being 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. |
fulfillmentpolicy| Method | Path | Description |
|---|
| POST | /fulfillmentpolicy/ | This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. 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. |
| GET |
/fulfillment_policy/{fulfillmentPolicyId} | 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. |
| PUT | /fulfillment
policy/{fulfillmentPolicyId} | This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillmentpolicy_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. |
| DELETE | /fulfillment_policy/{fulfillmentPolicyId} | This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter. |
| GET | /fulfillment
policy | This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplaceid query parameter. |
| GET | /fulfillment
policy/getby
policyname | 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. |
paymentpolicy| Method | Path | Description |
|---|
| GET | /paymentpolicy | This method retrieves all the payment business policies configured for the marketplace you specify using the marketplaceid query parameter. |
| POST |
/paymentpolicy | This method creates a new payment policy where the policy encapsulates seller's terms for order payments. 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. |
| GET | /payment
policy/{paymentpolicy_id} | 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. |
| PUT | /payment
policy/{paymentpolicy
id} | This method updates an existing payment policy. Specify the policy you want to update using the paymentpolicy_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. |
| DELETE | /payment
policy/{paymentpolicy_id} | This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. |
| GET | /payment
policy/getby
policyname | 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. |
paymentsprogram| Method | Path | Description |
|---|
| GET | /paymentsprogram/{marketplaceid}/{paymentsprogramtype} | 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 marketplaceid path parameter to specify the marketplace of the status flag you want returned. |
| GET |
/paymentsprogram/{marketplaceid}/{paymentsprogramtype}/onboarding | 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. |
privilege
| Method | Path | Description |
|---|
| GET | /privilege | 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 sellingLimit (the amount and quantity they can sell on a given day). |
program
| Method | Path | Description |
|---|
| GET | /program/getoptedinprograms | This method gets a list of the seller programs that the seller has opted-in to. |
| POST |
/program/optin | 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. |
| POST | /program/opt_out | This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the getOptedInPrograms method. |
ratetable| Method | Path | Description |
|---|
| GET | /ratetable | This method retrieves a seller's shipping rate tables for the country specified in the countrycode 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: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. 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 countrycode 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| Method | Path | Description |
|---|
| GET | /returnpolicy | This method retrieves all the return policies configured for the marketplace you specify using the marketplaceid query parameter. |
| POST |
/returnpolicy | 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. |
| GET | /return
policy/{returnpolicy_id} | This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter. |
| PUT | /return
policy/{returnpolicy
id} | This method updates an existing return policy. Specify the policy you want to update using the returnpolicy_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. |
| DELETE | /return
policy/{returnpolicy_id} | This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter. |
| GET | /return
policy/getby
policyname | 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. |
bulkcreateorreplacesalestax| Method | Path | Description |
|---|
| POST | /bulkcreateorreplacesalestax | This method creates or updates multiple sales-tax table entries.Sales-tax tables can be set up for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAYUS) and Canada (EBAYCA) marketplaces.Each sales-tax table entry comprises the following parameters:countryCodejurisdictionIdsalesTaxPercentageshippingAndHandlingTaxedValid jurisdiction IDs are retrieved using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
salestax| Method | Path | Description |
|---|
| GET | /salestax/{countryCode}/{jurisdictionId} | This call retrieves 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.Note: Sales-tax tables are only available for the US (EBAYUS) and Canada (EBAYCA) marketplaces.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
| PUT |
/salestax/{countryCode}/{jurisdictionId} | 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 sales-tax tables for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAYUS) and Canada (EBAY_CA) marketplaces.Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
| DELETE | /sales
tax/{countryCode}/{jurisdictionId} | This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.Note: Sales-tax tables are only available for the US (EBAYUS) and Canada (EBAY_CA) marketplaces. |
| GET | /sales
tax | 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. If no sales tax rates are defined for the specified, a 204 No Content status code is returned with no response payload.Note: Sales-tax tables are only available for the US (EBAYUS) and Canada (EBAY_CA) marketplaces.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
subscription
| Method | Path | Description |
|---|
| GET | /subscription | This method retrieves a list of subscriptions associated with the seller account. |
kyc
| Method | Path | Description |
|---|
| GET | /kyc | 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 return an empty payload with a 204 No Content HTTP status code. |
advertisingeligibility| Method | Path | Description |
|---|
| GET | /advertisingeligibility | This method allows developers to check the seller eligibility status for eBay advertising programs. |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- - "List all custompolicy?" -> GET /custompolicy/
- "Create a custompolicy?" -> POST /custompolicy/
- "Get custompolicy details?" -> GET /custompolicy/{custompolicyid}
- "Update a custompolicy?" -> PUT /custompolicy/{custompolicyid}
- "Create a fulfillmentpolicy?" -> POST /fulfillmentpolicy/
- "Get fulfillmentpolicy details?" -> GET /fulfillmentpolicy/{fulfillmentPolicyId}
- "Update a fulfillmentpolicy?" -> PUT /fulfillmentpolicy/{fulfillmentPolicyId}
- "Delete a fulfillmentpolicy?" -> DELETE /fulfillmentpolicy/{fulfillmentPolicyId}
- "List all fulfillmentpolicy?" -> GET /fulfillmentpolicy
- "List all getbypolicyname?" -> GET /fulfillmentpolicy/getbypolicyname
- "List all paymentpolicy?" -> GET /paymentpolicy
- "Create a paymentpolicy?" -> POST /paymentpolicy
- "Get paymentpolicy details?" -> GET /paymentpolicy/{paymentpolicyid}
- "Update a paymentpolicy?" -> PUT /paymentpolicy/{paymentpolicyid}
- "Delete a paymentpolicy?" -> DELETE /paymentpolicy/{paymentpolicyid}
- "List all getbypolicyname?" -> GET /paymentpolicy/getbypolicyname
- "Get paymentsprogram details?" -> GET /paymentsprogram/{marketplaceid}/{paymentsprogramtype}
- "List all onboarding?" -> GET /paymentsprogram/{marketplaceid}/{paymentsprogramtype}/onboarding
- "List all privilege?" -> GET /privilege
- "List all getoptedinprograms?" -> GET /program/getoptedinprograms
- "Create a optin?" -> POST /program/optin
- "Create a optout?" -> POST /program/optout
- "List all ratetable?" -> GET /ratetable
- "List all returnpolicy?" -> GET /returnpolicy
- "Create a returnpolicy?" -> POST /returnpolicy
- "Get returnpolicy details?" -> GET /returnpolicy/{returnpolicyid}
- "Update a returnpolicy?" -> PUT /returnpolicy/{returnpolicyid}
- "Delete a returnpolicy?" -> DELETE /returnpolicy/{returnpolicyid}
- "List all getbypolicyname?" -> GET /returnpolicy/getbypolicyname
- "Create a bulkcreateorreplacesalestax?" -> POST /bulkcreateorreplacesalestax
- "Get salestax details?" -> GET /salestax/{countryCode}/{jurisdictionId}
- "Update a salestax?" -> PUT /salestax/{countryCode}/{jurisdictionId}
- "Delete a salestax?" -> DELETE /salestax/{countryCode}/{jurisdictionId}
- "List all salestax?" -> GET /salestax
- "List all subscription?" -> GET /subscription
- "List all kyc?" -> GET /kyc
- "List all advertisingeligibility?" -> GET /advertisingeligibility
- "How to authenticate?" -> See Auth section
Response Tips
- - Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
CLI
CODEBLOCK0
References
- - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
Generated from the official API spec by LAP
Account v1 API
API版本: v1.9.3
认证
OAuth2
基础URL
https://api.ebay.com/sell/account/v1
设置
- 1. 配置认证：OAuth2
- GET /custompolicy/ -- 验证访问权限
- POST /custompolicy/ -- 创建第一个自定义策略
端点
13个分组共37个端点。完整详情请参见 references/api-spec.lap。
custompolicy| 方法 | 路径 | 描述 |
|---|
| GET | /custompolicy/ | 此方法检索卖家账户定义的自定义策略列表。要限制返回的自定义策略，请指定 policytypes 查询参数。 |
| POST |
/custompolicy/ | 此方法创建新的自定义策略，指定卖家遵守当地政府法规的条款。每个自定义策略针对一个 policyType。可使用以下自定义策略类型创建多个策略：PRODUCTCOMPLIANCE：产品合规策略披露符合监管要求所需的产品信息。注意：每个卖家最多可创建60个产品合规策略。TAKEBACK：回收策略描述卖家在买家购买新产品时回收之前购买物品的法律义务。注意：每个卖家最多可创建18个回收策略。成功创建策略调用返回HTTP状态码201 Created，并在Location响应头中包含系统生成的策略ID。 |
| GET | /custom
policy/{custompolicy
id} | 此方法检索由 custompolicy_id 路径参数指定的自定义策略。 |
| PUT | /custom
policy/{custompolicy
id} | 此方法更新由 custompolicy_id 路径参数指定的现有自定义策略。由于此方法会覆盖策略的 name、label 和 description 字段，因此即使这些字段未更新，也必须在请求负载中包含所有三个策略字段的完整和当前文本。例如，label 字段的值需要更新，但 name 和 description 值保持不变。必须同时传入当前策略中定义的现有 name 和 description 值。成功更新策略调用返回HTTP状态码204 No Content。 |
fulfillmentpolicy| 方法 | 路径 | 描述 |
|---|
| POST | /fulfillmentpolicy/ | 此方法为eBay市场创建新的履行策略，该策略封装卖家履行物品购买的条款。履行策略包括卖家向买家提供的运输选项。成功请求在Location响应头中返回新策略的getFulfillmentPolicy URI，并在响应负载中返回新策略的ID。提示：有关创建和使用Account API支持的业务策略的详细信息，请参阅eBay业务策略。 |
| GET |
/fulfillment_policy/{fulfillmentPolicyId} | 此方法检索履行策略的完整详细信息。使用 fulfillmentPolicyId 路径参数提供要检索的策略ID。 |
| PUT | /fulfillment
policy/{fulfillmentPolicyId} | 此方法更新现有的履行策略。使用 fulfillmentpolicy_id 路径参数指定要更新的策略。提供包含所需更新的完整策略负载；此调用将使用负载中指定的新详细信息覆盖现有策略。 |
| DELETE | /fulfillment_policy/{fulfillmentPolicyId} | 此方法删除履行策略。在 fulfillmentPolicyId 路径参数中提供要删除的策略ID。 |
| GET | /fulfillment
policy | 此方法检索使用 marketplaceid 查询参数指定的市场配置的所有履行策略。 |
| GET | /fulfillment
policy/getby
policyname | 此方法检索特定履行策略的详细信息。在请求中，将策略名称及其关联的 marketplace_id 作为查询参数提供。 |
paymentpolicy| 方法 | 路径 | 描述 |
|---|
| GET | /paymentpolicy | 此方法检索使用 marketplaceid 查询参数指定的市场配置的所有支付业务策略。 |
| POST |
/paymentpolicy | 此方法创建新的支付策略，该策略封装卖家订单支付的条款。成功请求在Location响应头中返回新策略的getPaymentPolicy URI，并在响应负载中返回新策略的ID。提示：有关创建和使用Account API支持的业务策略的详细信息，请参阅eBay业务策略。 |
| GET | /payment
policy/{paymentpolicy_id} | 此方法检索支付策略的完整详细信息。使用 paymentPolicyId 路径参数提供要检索的策略ID。 |
| PUT | /payment
policy/{paymentpolicy
id} | 此方法更新现有的支付策略。使用 paymentpolicy_id 路径参数指定要更新的策略。提供包含所需更新的完整策略负载；此调用将使用负载中指定的新详细信息覆盖现有策略。 |
| DELETE | /payment
policy/{paymentpolicy_id} | 此方法删除支付策略。在 paymentPolicyId 路径参数中提供要删除的策略ID。 |
| GET | /payment
policy/getby
policyname | 此方法检索特定支付策略的详细信息。在请求查询参数中提供策略名称及其关联的 marketplace_id。 |
paymentsprogram| 方法 | 路径 | 描述 |
|---|
| GET | /paymentsprogram/{marketplaceid}/{paymentsprogramtype} | 注意：此方法不再适用，因为全球所有卖家账户已启用新的eBay支付和结账流程。此方法返回用户是否已选择加入指定的支付计划。卖家按市场选择加入支付计划，您使用 marketplaceid 路径参数指定要返回状态标志的市场。 |
| GET |
/paymentsprogram/{marketplaceid}/{paymentsprogramtype}/onboarding | 注意：此方法不再适用，因为全球所有卖家账户已启用新的eBay支付和结账流程。此方法检索卖家在指定市场的支付计划入驻状态。返回卖家的整体入驻状态以及每个入驻步骤的状态。 |
privilege
| 方法 | 路径 | 描述 |
|---|
| GET | /privilege | 此方法检索卖家当前的权限集，包括卖家的eBay注册是否已完成，以及其全站 sellingLimit（每日可销售的数量和金额）的详细信息。 |
program
| 方法 | 路径 | 描述 |
|---|
| GET | /program/getoptedinprograms | 此方法获取卖家已选择加入的卖家程序列表。 |
| POST |
/program/optin | 此方法使卖家选择加入eBay卖家程序。有关可用eBay卖家程序的信息，请参阅Account API概述。注意：eBay处理您的卖家程序选择加入请求可能需要最多24小时。处理期过后，使用 getOptedInPrograms 调用检查请求状态。 |
| POST | /program/opt_out | 此方法使卖家退出当前已选择加入的卖家程序。卖家可以使用 getOptedInPrograms 方法检索已选择加入的卖家程序列表。 |
ratetable| 方法 | 路径 | 描述 |
|---|
| GET | /ratetable | 此方法检索卖家在 countrycode 查询参数指定的国家/地区的运费费率表。如果调用此方法时未指定国家代码，则调用返回卖家的所有运费费率表。该方法的响应为卖家定义的每个表包含一个 rateTableId。此 rateTableId 值用于添加/修改物品调用或创建/更新履行业务策略调用，以指定用于该策略国内或国际运输选项的运费费率表。此调用当前支持获取与以下市场相关的费率表：美国、加拿大、英国、德国、澳大利亚、法国、意大利和西班牙。注意：使用Trading API创建的费率表在创建时可能未分配 rateTableId。如果使用卖家已定义费率表的 countrycode 发出请求，此方法可以为缺少ID的费率表分配并返回 rateTableId 值。卖家最多可以为其账户定义40个运费费率表，从而为每个销售市场设置不同的费率表。前往“我的eBay”中的“运费费率表”创建和更新费率表。 |
returnpolicy| 方法 | 路径 | 描述 |
|---|
| GET | /returnpolicy | 此方法检索使用 marketplaceid 查询参数指定的市场配置的所有退货策略。 |
| POST |
/returnpolicy | 此方法创建新的退货策略，该策略封装卖家退货物品的条款。每个策略针对特定市场，您可以为每个市场创建多个策略。退货策略不适用于机动车列表。成功请求在Location响应头中返回新策略的getReturnPolicy URI，并在响应负载中返回新策略的ID。提示：有关创建和使用Account API支持的业务策略的详细信息，请参阅eBay业务策略。 |
| GET | /return
policy/{returnpolicy_id} | 此方法检索由 returnPolicyId 路径参数指定的退货策略的完整详细信息。 |
| PUT | /return
policy/{returnpolicy
id} | 此方法更新现有的退货策略。使用 returnpolicy_id 路径参数指定要更新的策略。提供包含所需更新的完整策略负载；此调用将使用负载中指定的新详细信息覆盖现有策略。 |
| DELETE | /return
policy/{returnpolicy_id} | 此方法删除退货策略。在 returnPolicyId 路径参数中提供要删除的策略ID。 |
| GET | /return
policy/getby
policyname | 此方法检索特定退货策略的详细信息。在请求查询参数中提供策略名称及其关联的 marketplace_id。 |
bulkcreateorreplacesales_tax
