You are here: Buy APIs > Buying Integration Guide

Buying integration guide

The eBay Buy APIs provide the capabilities you need to create an off-eBay shopping experience that lets your users find and buy items listed on eBay. These are RESTful APIs that use OAuth authentication, JSON payloads, and eBay HTTP headers. These APIs are supported on the US site and will be supported on other eBay sites in the future.

You can use the eBay Buy APIs to build an application that displays eBay items, lets shoppers purchase their items, and lets you obtain details about specific purchase orders. Shoppers can be guests or eBay members. With guest shoppers, the buyer is anonymous and you must provide all their information. With eBay members, the buyer is signed into eBay.

Important! The eBay Buy APIs are available as a public beta release. Accordingly, there may be some limitations and conditions on their use. For more information, refer to API launch stages in the Using eBay RESTful APIs guide.

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.

Topics

Buy API Overview

There are two Buy APIs, Browse and Order, with the following capabilities:

  • Item Feed – Returns the feed file of eBay items as text
  • Search – Lets shoppers search for specific items
  • Item – Retrieves the details of an item
  • Checkout – Lets shoppers pay for items (for both guest and eBay member buyers)
  • Order – Retrieves purchase order details (only for eBay member purchase orders)

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 Applying for production access for additional information and instructions for requesting production access.

Standard eligibility requirements

This section outlines the basic requirements for qualifying to use the eBay Buy APIs in production. As previously noted, meeting the standard eligibility requirements does not guarantee that you and your application will be granted production access.

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 CVV, must be provided for every payment
    • Full billing and shipping address must be provided for every payment

Buyer experience

Your application must present the following data elements to the buyer:

Data element

Notes

Item details display

eBay logo

Required: display when viewing items prior to purchase.

Required: display for viewing items, viewing carts, and viewing checkout details for universal checkout.

Seller name

Required: display when user is buying from an eBay seller

Strongly recommended: present seller ratings, feedback score, and top-rated designation

Optional: include the seller logo

Item title

Required

Item description , including item specifics

Required

Item condition

Strongly recommended: New

Total cost

Required: item cost + additional costs, such as shipping, tax, etc.

Strongly recommended: strike-through pricing, discounts, savings

Payments

Strongly recommended: credit card (guest checkout) only

Shipping

Required: details include:

  • Free shipping (can be rolled into total cost)
  • Ships to U.S. only
  • Estimated ship date

Strongly Suggested: item location and handling time

Returns policy

Required: Must have for public launch (not required for beta)

eBay Money Back Guarantee logo & slogan

Optional

eBay User Agreement

Required: Included as a footer. Link to agreement on ebay.com (http://pages.ebay.com/help/policies/user-agreement.html).

eBay Privacy Policy

Required: Included as a footer. Link to policy on ebay.com (http://pages.ebay.com/help/policies/privacy-policy.html)

Cart Feature

Seller name

Required

Item title

Required

Quantity

Required

Price

Required

Shipping cost

Required: if not already included in Price

Total

Required

eBay User Agreement

Required: Included as a footer. Link to agreement on ebay.com (http://pages.ebay.com/help/policies/user-agreement.html).

eBay Privacy Policy

Required: Included as a footer. Link to privacy policy on ebay.com (http://pages.ebay.com/help/policies/privacy-policy.html)

Checkout feature

Seller name

Required

Item title

Required

Quantity

Required

Price

Required

Shipping cost

Required: if not already included in Price

Total

Required

User Agrees with eBay User Agreement and Privacy Policy

Required: Link to agreement (http://pages.ebay.com/help/policies/user-agreement.html) and privacy policy (http://pages.ebay.com/help/policies/privacy-policy.html) on ebay.com.

Applying for production access

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

Buy API capabilities

The following section contains an overview of each capability.

Item Feed

To use this capability, you must join the eBay Partner Network.

You use the Item Feed capability to retrieve the contents of or download a feed file containing eBay items. This lets you quickly populate your site with eBay’s inventory and allows you to curate the inventory offline.

The feed files are generated daily by eBay with items that were added by top rated sellers to the eBay site in the last 24 hours. You can retrieve files up to 6 days in the past. To download all active listings, you need to download the feed files for 7 days. The items returned are based on the eBay marketplace, category, and file date specified in the call.

The first line of the feed file is the header, which indicates the order of the values on each line. The header is shown below:

ItemID, Title, Description, ImageUrl, AdditionalImageUrls, CategoryId, Category, Color, SizeType, Size, Material, AgeGroup, Gender, SellerUsername, SellerFeedbackScore, SellerFeedbackPercentage, GTIN, Brand, MPN, ConditionId, Condition, Quantity, PriceValue, PriceCurrency, ItemEndDate, ShipsTo

The following table lists and describes the data that is returned in the feed file. For an example of this file, see Item Feed file example.

Header

Type

Description

ItemID

string

The unique identifier of the eBay item.

Title

string

The text used as the title of the item.

Description

string

The text describing the item.

ImageUrl

string

The URL to the primary image of the item. The other images of the item are returned in the AdditionalImageUrls field.

AdditionalImageUrls

string

A list of item image URLs that does not include the primary image for the item.

CategoryId

string

Identifier of the leaf category associated with the item.

Category

string

The eBay category associated with the item.

Color

string

The text describing the color of the item.

SizeType

string

Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity.

Size

string

The size of the item. For example, '7' for a size 7 shoe.

Material

string

The text describing what the item is made of. For example, silk or plastic.

AgeGroup

string

The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc.

Gender

string

The gender for the item. This is used for items that could vary by gender, such as clothing. For example, male, female, or unisex.

SellerUsername

string

The seller’s eBay user name.

SellerFeedbackScore

string

The feedback score of the seller, which is based on buyer ratings.

SellerFeedbackPercentage

string

The percentage of total feedback that is positive.

GTIN

string

The unique Global Trade Item, (UPC, ISBN, EAN) number of the item as defined by http://www.gtin.info.

Brand

string

The name of the brand of the item, such as Nike, Apple, etc.

MPN

string

The manufacturer part number, which is a unique number that identifies a specific product.

ConditionId

string

The identifier of the condition of the item.

Condition

string

The text describing the condition of the item.

Quantity

integer

A number representing how many of this item are available for purchase.

PriceValue

string

The cost of the item.

PriceCurrency

CurrencyCodeEnum

The currency used for this item.

ItemEndDate

datetime

A timestamp indicating when the item's sale period will end.

ShipsTo

string

The 2 letter code for the country to which the item can be shipped.

Item

You use the Item capability to:

  • Retrieve a group of items (such as a shirt that comes in various colors and sizes).
  • Retrieve the details of a specific item (such as a red shirt size L).

Search

You use the Search capability to find items on the eBay site by keywords. This search can return items that were not included in the item feed file, such as items from other categories.

Checkout

you use the Checkout capability to:

  • Change the shipping address and the payment method for a purchase order.
  • Change the quantity and shipping method for specific line items.
  • Create a purchase order and submit it for payment.

Important! For guest checkout, your application must comply with PCI security standards to ensure proper handling of sensitive credit card data.

Order

You use the Order methods to retrieve the details of a purchase order.

Buy API application example

This section shows you how to use the Item Feed, Item, Checkout, and Order capabilities in a shopping flow. This flow is just one of many flows supported by the eBay Buy APIs.

Note: In the following sections, the screen shots are from a hypothetical application that integrates the eBay Buy APIs using the flow shown above.

Offering eBay items

The first step in the flow is to retrieve the eBay items by downloading a feed file.

Get Item Feed request
GET https://api.ebay.com/buy/browse/v1/item_feed?feed_type=DAILY&category_id=15032&date=20160724
Get Item Feed response

The response is a tab separated file of values. Below is a partial feed file that shows only the fields containing data and is formatted for readability. To view the entire feed file, see Item Feed file example.

Header

Value

ItemID

v1|201533667898|0

Title

Samsung Galaxy Note 4 Sm-n910u Gold 5.7" QHD, 32GB, 16MP

Description

New Samsung Galaxy Note 4 Sm-n910u Gold 5.7" QHD, 32GB, 16MP

ImageUrl

http://i.ebayimg.com/xxx.jpg

AdditionalImageUrls

http://i.ebayimg.com/images/i/xxx.jpg

CategoryId

170594

Category

Cell Phones & Accessories:Cell Phones & Smartphones

Color

Gold

Size

32GB

SellerUsername

never_msrp

SellerFeedbackScore

98

SellerFeedbackPercentage

98

Brand

Samsung

MPN

SMN910U

ConditionId

1000

Condition

New

Quantity

1

PriceValue

456.99

PriceCurrency

USD

ItemEndDate

2016-09-01

ShipsTo

US,UK

 

The screen below shows a page with a variety of items. The item in the upper-left was created using the Description, ImageUrl, and PriceValue from the item feed file above.

Getting item details (Item – both guest and eBay member buyers)

When the shopper clicks on an item, use the value of the ItemId field from the feed file as a URI parameter in the Get Item call to retrieve the details of the item.

Tip: When displaying the description of an item in an app, use the contents of the shortDescription field, which will always be in plain text.

Note: If you want the URL to the View Item page with the affiliate tracking ID returned in the itemSummaries.itemAffiliateWebUrl field, you must pass in the X-EBAY-C-ENDUSERCTX header in the request. Refer to the Get Item call reference page for details.

Get Item request
GET https://api.ebay.com/buy/browse/v1/item/v1|201533667898|0
Get Item response
{
   "itemId":"v1|201533667898|0",
   "title":"Samsung Galaxy Note 4 SM-N910U Gold 5.7\" QHD, 32GB, 16MP",
   "shortDescription":"New Samsung Galaxy Note 4 SM-N910U Gold 5.7" QHD, 32GB, 16MP",
   "price":{
      "value":456.99,
      "currency":"USD"
   },
   "categoryPath":"Cell Phones &amp; Accessories|Cell Phones &amp; Smartphones",
   "condition":"New",
   "itemLocation":{
      "city":"San Jose",
      "stateOrProvince": "California",
      "postalCode": "95127",
      "country":"US"
   },
   "image": {  
      "imageUrl":"http://i.ebayimg.com/xxx.JPG"
    },
   "primaryItemGroupHref":"https://api.ebay.com/buy/browse/v1/item_group/201533667898",
   "color":"Gold",
   "brand":"Samsung",
   "itemEndDate": "2016-09-01T19:29:51.000Z",
   "seller":{
      "feedbackPercentage":"95",
      "feedbackScore":"95",
      "username":"never-msrp"
   },
   "gtin":"7311271033684",
   "availabilityStatusForShipToHome":"IN_STOCK",
   "returnTerms":{
      "returnsAccepted":true,
      "refundMethod":"MONEY_BACK",
      "returnShippingCostPayer":"BUYER",
      "returnPeriod":{
         "value":14,
         "unit":"CALENDAR_DAY"
      }
   },
   "description":"<font> ... <font/>",
   "quantitySold":0,
   "shippingOptions":[
      {
         "shippingServiceName":"Standard Shipping",
         "trademarkSymbol":"&reg;",
         "type":"Standard Shipping",
         "shippingCost":{
            "value":0,
            "currency":"USD"
         }
      },
      {
         "shippingServiceName":"FedEx Express Saver",
         "trademarkSymbol":"&reg;",
         "type":"Expedited Shipping",
         "shippingCost":{
            "value":1.99,
            "currency":"USD"
         }
      },
      {
         "shippingServiceName":"FedEx 2Day",
         "trademarkSymbol":"&reg;",
         "type":"Expedited Shipping",
         "shippingCost":{
            "value":2.99,
            "currency":"USD"
         }
      },
      {
         "shippingServiceName":"FedEx Standard Overnight",
         "trademarkSymbol":"&reg;",
         "type":"One-day Shipping",
         "shippingCost":{
            "value":16.99,
            "currency":"USD"
         }
      }
   ],
   "topRatedBuyingExperience": true,  
   "buyingOptions": [
     "FIXED_PRICE"
   ],
   "itemAffiliateWebUrl": "http://rover.qa.ebay.com/rover/1/...?campid=...&customid=..."
}

Screen created using the highlighted data

Completing the transaction (Checkout)

The checkout flow begins when shopper indicate they want to purchase the item. In the example above, the shopper would click on the Buy It Now button to start the transaction. This flow creates a checkout session, captures the shipping address and payment method, and creates and pays for the order.

There are two flows; one for a guest checkout and one for an eBay member checkout.

 

Tip: To test the entire checkout flow, you might need a ‘test’ credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com.

Note: eBay Bucks and coupons are not supported.

Initiate Guest Checkout Session request (guest)

For a guest checkout session, you pass in the items and their quantity, the buyer’s name, and the shipping and payment information:

Initiate Checkout Session request (guest)

POST https://api.ebay.com/buy/order/v1/guest/checkout_session/initiate
			
{
  "contactEmail" : "fsmith1234@gmail.com",
  "contactFirstName":"Frank",
  "contactLastName":"Smith",
  "shippingAddress" : {
    "recipient" : "Frank Smith",
    "phoneNumber" : "617 817 7449 ",
    "addressLine1" : "3737 Casa Verde St",
    "city" : "San Jose",
    "stateOrProvince" : "CA",
    "postalCode" : "95134",
    "country" : "US"
  },
  "lineItemInputs" : [ {
    "quantity" : 1,
    "itemId" : "v1|190006102824|0"
  }
 ]
}
Initiate Checkout Session request (eBay member)

For an eBay member checkout, you pass in the items and their quantity and the shipping information. This call verifies that the eBay member has a linked valid PayPal account. If there is a problem or the eBay member wants to pay by credit card, use the Update Payment Info call to add their payment choice.

Note: By default, eBay member checkout is not supported in the eBay sandbox environment. For developers that apply for and are granted permission to use the eBay Buy APIs in production, the member checkout capability will also be enabled in the sandbox. For more information about applying for access and eligibility requirements, see Production eligibility requirements.


Initiate Checkout Session request (eBay member)
POST https://api.ebay.com/buy/order/v1/checkout_session/initiate

{
  "shippingAddress": {
    "addressLine1": "3737 Casa Verde St",
    "city": "San Jose",
    "stateOrProvince": "CA",
    "postalCode": "95134",
    "country": "US",
    "recipient": "Frank Smith",
    "phoneNumber": "617 817 7449 "
  },
  "lineItemInputs" : [ {
    "quantity" : 1,
    "itemId" : "v1|190006102824|0"
  }
 ]
}

 

The Initiate Checkout Session call creates a checkout session that your application uses to process the shopper’s payment. It returns information about the item, order, shipping, payment methods, and a checkout session ID (highlighted in yellow), which is used by the Place Order call.

Initiate Checkout Session response
{
  "checkoutSessionId": "5016712327",
  "expirationDate": "2036-08-11T23:03:18.501Z",
  "lineItems": [
    {
      "itemId": "v1|201533667898|0",
      "title": "Samsung Galaxy Note 4 SM-N910U Gold 5.7\" QHD, 32GB, 16MP",
      "shortDescription": "New Samsung Galaxy Note 4 SM-N910U Gold",
      "image": {
         "imageUrl": "http://i.ebayimg.qa.ebay.com/00/s/NzY4WDEwMjQ=/z/0ZkAAOSw3dFWHCF8/$_1.JPG?set_id=880000500F"
       },
      "seller": {
        "username": "never-msrp"
      },
      "quantity": 1,
      "lineItemId": "5195728827",
      "baseUnitPrice": {
        "value": 456.99,
        "currency": "USD"
      },
      "shippingOptions": [
        {
          "selected": true,
          "shippingOptionId": "5274330495",
          "shippingServiceName": "USPS Parcel Select Ground",
          "shippingCarrierName": "USPS",
          "minEstimatedDeliveryDate": "2016-08-15T07:00:00.000Z",
          "maxEstimatedDeliveryDate": "2016-08-23T07:00:00.000Z",
          "baseDeliveryCost": {
            "value": 0,
            "currency": "USD"
          }
        },
        {
          "selected": false,
          "shippingOptionId": "5274330507",
          "shippingServiceName": "USPS Retail Ground",
          "shippingCarrierName": "USPS",
          "minEstimatedDeliveryDate": "2016-08-15T07:00:00.000Z",
          "maxEstimatedDeliveryDate": "2016-08-23T07:00:00.000Z",
          "baseDeliveryCost": {
            "value": 1,
            "currency": "USD"
          }
        }
      ],
      "netPrice": {
        "value": 20,
        "currency": "USD"
      }
    }
  ],
  "shippingAddress": {
    "addressLine1": "3737 Casa Verde St",
    "city": "San Jose",
    "stateOrProvince": "CA",
    "postalCode": "95134",
    "country": "US",
    "recipient": "Frank Smith",
    "phoneNumber": "617 817 7449 "
  },
  "pricingSummary": {
    "priceSubtotal": {
      "value": 20,
      "currency": "USD"
    }, 
    "priceDiscount": {
      "value": "0.00",
      "currency": "USD"
    },
    "deliveryCost": {
      "value": 0.00,
      "currency": "USD"
    },  
    "deliveryDiscount": {
      "value": "0.00",
      "currency": "USD"
    },
    "tax": {
      "value": 0.00,
      "currency": "USD"
    },  
    "fee": {
      "value": "0.00",
      "currency": "USD"
    },
    "adjustment": {
      "value": 0.00,
      "currency": "USD"
    },
    "total": {
      "value": 20,
      "currency": "USD"
    }
  },
  "acceptedPaymentMethods": [
    {
      "paymentMethodMessages": [
        {
          "legalMessage": "PayPal processes payments for eBay. A PayPal account isn't required."
        }
      ]
    }
  ]
}

To create the purchase order, which starts the payment process and terminates the checkout session use the Place Order call.

Place Order request (guest)
POST https://api.ebay.com/buy/order/v1/guest_checkout_session/{checkoutSessionId}/place_order
Place Order request (eBay member)
POST https://api.ebay.com/buy/v1/checkout_session/{checkoutSessionId}/place_order

The placeOrder call returns the Id of the purchase order (highlighted in yellow). You should store the purchaseOrderId so, in the future, you can retrieve the details of this purchase.

placeOrder response (guest)
{
  "purchaseOrderId": "5833850019",
  "purchaseOrderHref": "buy/order/v1/purchase_order/5833850019",
  "purchaseOrderPaymentStatus": "PAID"
}
placeOrder response (eBay member)
{
  "purchaseOrderId": "5832216756",
  "purchaseOrderHref": "buy/order/v1/purchase_order/5832216756",
  "purchaseOrderPaymentStatus": "PAID"
}

Getting Order Details (Order API – eBay member)

When you need to get the details of a completed transaction, you can use the value of purchaseOrderId (highlighted in the Place Order response above) as a URI parameter in the Get Purchase Order call.

Get Purchase Order request (eBay member)
GET https://api.ebay.com/buy/order/v1/purchase_order/5832216756

The Get Purchase Order call returns the details of the specified purchase order.

Get Purchase Order response (eBay member)
{
  "purchaseOrderId": "5832216756",
  "purchaseOrderCreationDate": "2016-06-21T23:29:07.000Z",
  "lineItems": [
    {
      "lineItemId": "6444348018",
      "itemId": "350007217675",
      "title": "Old Model Cell Phones Blackberry",
      "image": {
        "imageUrl": "http://...jpg"
      },
      "netPrice": {
        "value": "14.88",
        "currency": "USD"
      },
      "seller": {
        "username": "oldTech"
      },
      "quantity": 1,
      "lineItemPaymentStatus": "PAID",
      "lineItemStatus": "PAID",
      "shippingDetail": {
        "shippingServiceName": "Expedited Shipping",
        "shippingCarrierName": null,
        "minEstimatedDeliveryDate": "2016-06-24T07:00:00.487Z",
        "maxEstimatedDeliveryDate": "2016-06-29T07:00:00.487Z"
      }
    },
    {
      "lineItemId": "6444349018",
      "itemId": "350007217676",
      "title": "Old Model Cell Phones Sprint Flip-Phone",
      "image": {
        "imageUrl": "http://...jpg"
      },
      "netPrice": {
        "value": "24.12",
        "currency": "USD"
      },
      "seller": {
        "username": "oldTech"
      },
      "quantity": 1,
      "lineItemPaymentStatus": "PAID",
      "lineItemStatus": "PAID",
      "shippingDetail": {
        "shippingServiceName": "Expedited Shipping",
        "shippingCarrierName": FedEx,
        "minEstimatedDeliveryDate": "2016-06-24T07:00:00.487Z",
        "maxEstimatedDeliveryDate": "2016-06-29T07:00:00.487Z"
      }
    }
  ],
  "pricingSummary": {
    "priceSubtotal": {
      "value": "39.00",
      "currency": "USD"
    },
    "priceDiscount": {
      "value": "0.00",
      "currency": "USD"
    },
    "deliveryCost": {
      "value": "0.00",
      "currency": "USD"
    },
    "deliveryDiscount": {
      "value": "0.00",
      "currency": "USD"
    },
    "tax": {
      "value": "0.00",
      "currency": "USD"
    },
    "fee": {
      "value": "0.00",
      "currency": "USD"
    },
    "adjustment": {
      "value": "0.00",
      "currency": "USD"
    },
    "total": {
      "value": "39.00",
      "currency": "USD"
    }
  },
  "paymentInstrument": {
    "paymentMethodType": "CREDIT_CARD"
  },
  "purchaseOrderStatus": "PAID",
  "purchaseOrderPaymentStatus": "PAID",
  "shippingFulfillments": [
    {
      "shippingServiceName": "Expedited Shipping",
      "minEstimatedDeliveryDate": "2016-06-24T07:00:00.000Z",
      "maxEstimatedDeliveryDate": "2016-06-29T07:00:00.000Z",
      "lineItemReferences": [
        {
          "lineItemId": "6444348018",
          "quantity": 1
        },
        {
          "lineItemId": "6444349018",
          "quantity": 1
        }
      ]
    }
  ],
  "shippingUserAddress": {
    "addressLine1": "2125 Hamilton Ave.",
    "city": "San Jose",
    "stateOrProvince": "CA",
    "postalCode": "95125",
    "country": "US",
    "recipient": "Ruchi Sethi"
  }
}

Post order tasks

All post order tasks, such contacting the seller, returning the item, or filing a dispute, are performed on the eBay site and handled by the seller. When a buyer purchases item(s) using the Buy APIs, eBay sends the buyer an order confirmation email for each seller. This email contains a View order details link and an access code. The buyer clicks on the link and then signs into eBay as a guest using their email address and access code. From there they can contact the seller, report that they didn't receive the item, or request to return the item.

eBay support for developers

eBay is committed to supporting outside developers by providing the following:

Note: By default, eBay member checkout is not supported in the eBay sandbox environment. For developers that apply for and are granted permission to use the eBay Buy APIs in production, the member checkout capability will also be enabled in the sandbox. For more information about applying for access and eligibility requirements, see Buying integration guide.

  • eBay Sandbox environment (http://sandbox.ebay.com/) that lets you test your application.
  • API Explorer with sample requests that lets you easily run the API calls
  • Complete set of documentation for each API that includes, in addition to this guide, the following:
    • Using eBay RESTful APIs guide that explains the fundamentals of using the APIs, such as:
      • Authenticating
      • Error handling
      • Security
      • Testing
    • API Overview that describes the business use cases and restrictions for the API
    • API Reference (Browse and Order) that includes details for each call in the API, which includes:
      • Description of the call
      • Input section with information about the URI, parameters, and input payload (when applicable) that shows the structure of the payload and links to corresponding descriptions of fields and types
      • Output section with output payload (when applicable) that shows the structure of the payload and links to corresponding descriptions of fields and types
      • Sample section with at least one example of a request and response for the given call
    • API Release Notes (Browse and Order)