account-v1-api

name	account-v1-api
description	Account v1 API skill. Use when working with Account v1 for custom_policy, fulfillment_policy, payment_policy. Covers 37 endpoints.
version	1.0.0
generator	lapsh

Account v1 API

API version: v1.9.3

Auth

OAuth2

Base URL

https://api.ebay.com/sell/account/v1

Setup

1. Configure auth: OAuth2
2. GET /custom_policy/ -- verify access
3. POST /custom_policy/ -- create first custom_policy

Endpoints

37 endpoints across 13 groups. See references/api-spec.lap for full details.

custom_policy

Method	Path	Description
GET	/custom_policy/	This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policy_types query parameter.
POST	/custom_policy/	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: PRODUCT_COMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance. Note: A maximum of 60 Product Compliance policies per seller may be created. TAKE_BACK: 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/{custom_policy_id}	This method retrieves the custom policy specified by the custom_policy_id path parameter.
PUT	/custom_policy/{custom_policy_id}	This method updates an existing custom policy specified by the custom_policy_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.

fulfillment_policy

Method	Path	Description
POST	/fulfillment_policy/	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 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.
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 marketplace_id query parameter.
GET	/fulfillment_policy/get_by_policy_name	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.

payment_policy

Method	Path	Description
GET	/payment_policy	This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace_id query parameter.
POST	/payment_policy	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/{payment_policy_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/{payment_policy_id}	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.
DELETE	/payment_policy/{payment_policy_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/get_by_policy_name	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.

payments_program

Method	Path	Description
GET	/payments_program/{marketplace_id}/{payments_program_type}	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.
GET	/payments_program/{marketplace_id}/{payments_program_type}/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/get_opted_in_programs	This method gets a list of the seller programs that the seller has opted-in to.
POST	/program/opt_in	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.

rate_table

Method	Path	Description
GET	/rate_table	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: 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 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.

return_policy

Method	Path	Description
GET	/return_policy	This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.
POST	/return_policy	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/{return_policy_id}	This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
PUT	/return_policy/{return_policy_id}	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.
DELETE	/return_policy/{return_policy_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/get_by_policy_name	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.

bulk_create_or_replace_sales_tax

Method	Path	Description
POST	/bulk_create_or_replace_sales_tax	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 (EBAY_US) and Canada (EBAY_CA) marketplaces. Each sales-tax table entry comprises the following parameters: countryCode jurisdictionId salesTaxPercentage shippingAndHandlingTaxed Valid jurisdiction IDs are retrieved using getSalesTaxJurisdictions in the Metadata API. For details about using this call, refer to Establishing sales-tax tables. 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.

sales_tax

Method	Path	Description
GET	/sales_tax/{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 (EBAY_US) and Canada (EBAY_CA) marketplaces. 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	/sales_tax/{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 (EBAY_US) 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! 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: For additional information, refer to .

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.

advertising_eligibility

Method	Path	Description
GET	/advertising_eligibility	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 custom_policy?" -> GET /custom_policy/
• "Create a custom_policy?" -> POST /custom_policy/
• "Get custom_policy details?" -> GET /custom_policy/{custom_policy_id}
• "Update a custom_policy?" -> PUT /custom_policy/{custom_policy_id}
• "Create a fulfillment_policy?" -> POST /fulfillment_policy/
• "Get fulfillment_policy details?" -> GET /fulfillment_policy/{fulfillmentPolicyId}
• "Update a fulfillment_policy?" -> PUT /fulfillment_policy/{fulfillmentPolicyId}
• "Delete a fulfillment_policy?" -> DELETE /fulfillment_policy/{fulfillmentPolicyId}
• "List all fulfillment_policy?" -> GET /fulfillment_policy
• "List all get_by_policy_name?" -> GET /fulfillment_policy/get_by_policy_name
• "List all payment_policy?" -> GET /payment_policy
• "Create a payment_policy?" -> POST /payment_policy
• "Get payment_policy details?" -> GET /payment_policy/{payment_policy_id}
• "Update a payment_policy?" -> PUT /payment_policy/{payment_policy_id}
• "Delete a payment_policy?" -> DELETE /payment_policy/{payment_policy_id}
• "List all get_by_policy_name?" -> GET /payment_policy/get_by_policy_name
• "Get payments_program details?" -> GET /payments_program/{marketplace_id}/{payments_program_type}
• "List all onboarding?" -> GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding
• "List all privilege?" -> GET /privilege
• "List all get_opted_in_programs?" -> GET /program/get_opted_in_programs
• "Create a opt_in?" -> POST /program/opt_in
• "Create a opt_out?" -> POST /program/opt_out
• "List all rate_table?" -> GET /rate_table
• "List all return_policy?" -> GET /return_policy
• "Create a return_policy?" -> POST /return_policy
• "Get return_policy details?" -> GET /return_policy/{return_policy_id}
• "Update a return_policy?" -> PUT /return_policy/{return_policy_id}
• "Delete a return_policy?" -> DELETE /return_policy/{return_policy_id}
• "List all get_by_policy_name?" -> GET /return_policy/get_by_policy_name
• "Create a bulk_create_or_replace_sales_tax?" -> POST /bulk_create_or_replace_sales_tax
• "Get sales_tax details?" -> GET /sales_tax/{countryCode}/{jurisdictionId}
• "Update a sales_tax?" -> PUT /sales_tax/{countryCode}/{jurisdictionId}
• "Delete a sales_tax?" -> DELETE /sales_tax/{countryCode}/{jurisdictionId}
• "List all sales_tax?" -> GET /sales_tax
• "List all subscription?" -> GET /subscription
• "List all kyc?" -> GET /kyc
• "List all advertising_eligibility?" -> GET /advertising_eligibility

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

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