This doc page has moved! You should be automatically redirected to the new location. If you are not redirected automatically, follow this link to the new page.

You are here: Buy APIs > Buying Integration Guide > Buy APIs Requirements

Buy APIs Requirements

Topics

Note: The eBay Buy APIs are available in the sandbox environment for everyone, but production access is restricted. See Production eligibility requirements for more information.

Production eligibility requirements

Although the eBay Buy APIs are available for anyone to use in eBay's sandbox environment, use of the APIs in production is restricted. Users must meet standard eligibility requirements, get approvals from eBay support organizations, and sign contracts with eBay and PayPal to access the Buy APIs in production. Meeting the standard eligibility is not a guarantee that production access will be granted. See Production access process for additional information and instructions for requesting production access.

These requirements are grouped into:

Contractual requirements

Use of the eBay APIs in production requires the following accounts:

In addition to all the contracts and agreements associated with the accounts, such as the eBay User Agreement, API License Agreement, eBay Partner Network Agreement, and the PayPal User Agreement, there are contracts with eBay and PayPal that are specific to the eBay Buy APIs and your business model. If your application uses the guest checkout model, PCI compliance is required and there may be additional PayPal risk provisions and safeguards for your application and the API flow. You may also be required to sign Mutual Non-disclosure Agreements (MNDAs), depending upon your business model.

Optionally, if you want to download the item feed files or get paid for selling eBay items, you need to become an affiliate by joining the eBay Partner Network.

Technical requirements

Depending upon your use case, your application must meet some or all of the following requirements:

  • Application must be fully functional and reviewable on the eBay sandbox
  • Application must implement affiliate tracking details (needed for revenue share capability)
  • If your application supports guest checkout, the following requirements apply:
    • Application must integrate with PayPal's risk management library (details provided upon execution of MNDA)
    • Full credit card data, including CSV or CVV, must be provided for every payment
    • Full billing and shipping address must be provided for every payment

Guest checkout partner requirements

Partners must include the following data elements within the commerce flow and adhere to all other requirements detailed below.

User Experience

Search / Item Feed Calls

Notes (including API Call or Manual Implementation)

Browse API Search Call and Feed API Calls

Fixed Price Items

Required: Filter BuyingOptions for "FIXED PRICE"

filter=buyingOptions:{FIXED_PRICE}

Condition

Required: Filter Conditions for "NEW"

filter=conditions:{NEW}

Sort

Required: Disable sort functionality: Partner and users are not permitted to sort items.

Note: The data provided is already sorted to present the most relevant/best match according to eBay's algorithms; further sorting would produce a sub-optimal experience.

Free Shipping

Strongly Suggested:

filter=maxDeliveryCost:0

Delivery Country

Required: Filter Delivery Country for "US"

filter=deliveryCountry:US

Item Location Country

Required: Filter Item Location Country for "US"

filter=itemLocationCountry:US

 

User Experience
View Item Page

Notes (including API Call or Manual Implementation)
Browse API Item and Item Group Calls

eBay logo

Required:

  • For GXO: at View Item screen.
  • For Universal Checkout: at View Item, Cart, Checkout.

Provided by eBay (ebay-logos.zip).

Seller

Required: Show eBay seller user name

   Response field name = seller.username

 

Strongly Suggested: Show Seller ratings

   Response field name = seller.feedbackPercentage and seller.feedbackScore

Item Title

Required: Show Item Title

   Response field name = title

Item description

Required: Show Item Description

   Response field name = description

Condition

Required: Show Condition (New)

   Response field name = condition

Item Cost

Required: Show Item Cost

   Response field name = price


Strongly Suggested:
Show Strikethrough Price / Discount / Savings

   Response field name = marketingPrice

Payments

Strongly Suggested: Show that transaction will be processed by credit card only

Manually coded by partner.

Shipping Required:
  • Show Shipping Options

       Response field name = shippingOptions

  • Show Shipping Cost

       Response field name = shippingOptions[i].shippingCost

       Note: This requires providing the buyer's US zip code in the X-EBAY-C-ENDUSERCTX contextualLocation request header.

  • Show Ships to U.S. only

    Manually coded by partner.

 

Strongly Suggested:

  • Show Estimated delivery date

    Response field names = shippingOptions[i].minEstimatedDeliveryDate and shippingOptions[i].maxEstimatedDeliveryDate

    Note: This requires providing the buyer's US zip code in the X-EBAY-C-ENDUSERCTX contextualLocation request header.

  • Show Item location

       Response field names = itemLocation.city and itemLocation.country

Returns policy

Required: Show Seller's Return Policy

   Response field name = returnTerms

Report Item

Required: Surface a "Report Item on eBay" hyperlink. This allows users to report any issues to eBay.

   Response field name = itemWebUrl

eBay User Agreement and
eBay Privacy Policy

Required: Included as a footer. Links to agreement (http://pages.ebay.com/help/policies/user-agreement.html) and privacy policy (http://pages.ebay.com/help/policies/privacy-policy.html).

 

User Experience
Cart Feature

Notes (including API Call or Manual Implementation)
Browse API Item and Item Group Calls

eBay Logo

Required: For Universal Checkout

Provided by eBay (ebay-logos.zip).

Seller

Required: Show eBay seller user name

   Response field name = seller.username

Item Title

Required: Show Item Title

   Response field name = title

Quantity Required: Manually coded by partner.
Item Price

Required: Show Item Cost

   Response field name = price

eBay User Agreement and
eBay Privacy Policy

Required: Included as a footer. Links to agreement (http://pages.ebay.com/help/policies/user-agreement.html) and privacy policy (http://pages.ebay.com/help/policies/privacy-policy.html).

 

User Experience
Checkout Feature

Notes (including API Call or Manual Implementation)
Order API Guest Checkout Calls

Seller

Required: Show seller name

   Response field name = lineItems[].seller.username

Item Title

Required: Show item title

   Response field name = lineItems[].title

Quantity

Required: Show quantity

   Response field name = lineItems[].quantity

Four Listing Limit

Required: Disclose that the user can purchase an unlimited quantity of any item (eBay listing), but that there is a four listing limit to checkout at any given time.

Manually coded by partner.

Item Price

Required: Show price of each item in cart

   Response field name = lineItems[].netPrice

Total Shipping

Required: Show shipping cost

   Response field name = pricingSummary.deliveryCost

Tax

Required: Show tax

   Response field name = pricingSummary.tax

Total Cost (Item Prices + Shipping + Tax)

Required: Show total cost

   Response field name = pricingSummary.total

eBay User Agreement and
eBay Privacy Policy

Required: Links to agreement (http://pages.ebay.com/help/policies/user-agreement.html) and privacy policy (http://pages.ebay.com/help/policies/privacy-policy.html) in the following disclosure:

"By clicking Purchase, you agree that you've read and accepted eBay's User Agreement and you consent to eBay's Privacy Notice and receiving marketing communications from eBay."

  • Disclosure must be placed immediately before the "Purchase" call to action.
  • Manually coded by partner.

 

Production access process

To start the application process for production access:

  1. If you haven't already, sign up for an eBay Partner Network (EPN) account:
    1. Please ensure that the information you provide is accurate, and be as thorough as possible when completing your application.
    2. Review the Help topics about becoming an eBay Partner Network member.
    3. Ensure that you read and agree to the following:
      1. Network Agreement
      2. Terms and Conditions
      3. Code of Conduct
  2. Use the Contact Us form on the eBay Partner Network site to request access to the eBay Buy APIs.
    1. You will receive a Downloadable Tools Application and other relevant information to complete your application.
    2. You have 3 days to submit your application.
    3. Within 10 business days, the eBay Partner Network will respond, approving or declining your network application.
  3. If your business model is approved by the eBay Partner Network, please open a support ticket with eBay Developer Support, indicating "Buy API Production Access (<4-digit EPN code>)" in the subject line. In the ticket, include the following:
    1. 4-digit EPN code
    2. EPN registered email address (or eBay user ID, if registered with an eBay account)
    3. Detailed instructions on how to access and test the application in Sandbox

    4. The approval email from EPN as an attachment
  4. The eBay Developer Support team initiates the application reveiw/approval process:
    1. Support team reviews the application for compliance
    2. You must make changes as requested by the eBay Support team
    3. When the Support team is satisfied with your app, you are given eBay and PayPal contracts
    4. Upon return of signed contracts, the eBay Support team enables production access for your application