You are here: Buy APIs > Order API overview

Order API overview

The Order API is part of the eBay Buy APIs. It is used to purchase items and track the purchase orders. The Order API supports the complete checkout process. Use the Order API with the Browse API to create a buying application that lets users, eBay members or guests, buy from eBay sellers without visiting the eBay site. The Buy APIs provide a unique opportunity to bring off-eBay purchases to your site.

Topics

Overview

The Order API supports eBay member checkout and guest checkout. With member checkout, signed in eBay members use PayPal to make their purchases. With guest checkout, buyers pay with credit cards, without signing in to eBay. The Order API lets you retrieve the purchase order information.

This API uses the following resources:

CHECKOUT_SESSION – contains all the details of a member checkout, including:

  • Line items, each with item identifier, seller, price, and quantity
  • Shipping information
  • Payment information

PURCHASE_ORDER – contains all the details of a purchase order, including:

  • Line items purchased, each with item identifier, seller, price, and quantity
  • Shipping address used and fulfillment information
  • Payment used
  • Pricing summary
  • Status of the payment and the order

GUEST_CHECKOUT_SESSION – contains all the details of a purchase order for an eBay member checkout, including:

  • Line items, each with item identifier, seller, price, and quantity
  • Shipping information
  • Payment information

GUEST_PURCHASE_ORDER– contains all the details of a purchase order for guest checkout, including:

  • Line items purchased, each with item identifier, seller, price, and quantity
  • Payment used
  • Pricing summary
  • Status of the payment and the order

There are a series of steps for completing a checkout from initiating the checkout session to placing the order. Once the order is placed, you can retrieve order details, including the shipping fulfillment status.

Use cases

When used with the Browse API, the Order API lets you to create shopping/buying opportunities virtually anywhere. For example, your buyers can have a seamless buying experience woven into a social application.

Dependencies, limitations, and restrictions

Please note the following constraints for the Order API.

API dependencies

The Order API is designed to be used together with the Browse API to create cohesive buying applications. The identifiers used in the Order API are only compatible with the Browse API.

Regional/site constraints

The Order API is currently supported for the eBay US site.

eBay policies and rules

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.

See Production eligibility requirements in the Buying Integration Guide for more information.

Coupons and eBay bucks

The Order API does not support seller coupons or eBay Bucks.