Note: This is the v1_beta version of the Order API, which includes both member and guest checkout payment flows. To view the v2 version of the Order API, which currently only supports the guest payment flow for eBay managed payments, refer to the Order API v2 documentation.
Note: This is a 
(Limited Release) API available only to select developers approved by business units.
The Order API provides interfaces that let shoppers pay for items (for both eBay guest and eBay member buyers). It also returns payment and shipping status of the order. It enables eBay partners to use accept payment without being PCI compliant and use the Post Order API for returns and cancellations for eBay member buyers.
The Order API has the following resources:
- checkout_session: Lets eBay members purchase items using PayPal or a credit card.
- guest_checkout_session: Lets eBay guests purchase items using a credit card or the PayPal Smart Button.
- proxy_guest_checkout_session: Lets eBay guests purchase items through a vault service provider (VSP). *Note:* Due to the requirement of having a VSP, this resource is not available in the eBay API Explorer.
- guest_purchase_order and purchase_order: Lets eBay partners track the payment status and show the buyers their purchase order.
checkout_session
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| applyCoupon | POST | /checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all the eligible items in the order. (Limited Release) You must be whitelisted to use this method. | View applyCoupon - /checkout_session/{checkoutSessionId}/apply_coupon |
| getCheckoutSession | GET | /checkout_session/{checkoutSessionId} | Retrieves the specified eBay member checkout session details. | View getCheckoutSession - /checkout_session/{checkoutSessionId} |
| initiateCheckoutSession | POST | /checkout_session/initiate | Creates a eBay member checkout session. This is the first step in performing a checkout. | View initiateCheckoutSession - /checkout_session/initiate |
| placeOrder | POST | /checkout_session/{checkoutSessionId}/place_order | Pays for the items in the specified an eBay member checkout session. | View placeOrder - /checkout_session/{checkoutSessionId}/place_order |
| removeCoupon | POST | /checkout_session/{checkoutSessionId}/remove_coupon | Removes a coupon from the checkout session. (Limited Release) You must be whitelisted to use this method. | View removeCoupon - /checkout_session/{checkoutSessionId}/remove_coupon |
| updateAddonServicesStatus | POST | /checkout_session/{checkoutSessionId}/update_add_on_services_status | Updates the payment method in an eBay member session. | View updateAddonServicesStatus - /checkout_session/{checkoutSessionId}/update_add_on_services_status |
| updatePaymentInfo | POST | /checkout_session/{checkoutSessionId}/update_payment_info | Updates the payment method in an eBay member session. | View updatePaymentInfo - /checkout_session/{checkoutSessionId}/update_payment_info |
| updateQuantity | POST | /checkout_session/{checkoutSessionId}/update_quantity | Updates the quantity of the specified line item for a eBay member checkout. | View updateQuantity - /checkout_session/{checkoutSessionId}/update_quantity |
| updateShippingAddress | POST | /checkout_session/{checkoutSessionId}/update_shipping_address | Updates the shipping address for the specified line item in a eBay member checkout session. | View updateShippingAddress - /checkout_session/{checkoutSessionId}/update_shipping_address |
| updateShippingOption | POST | /checkout_session/{checkoutSessionId}/update_shipping_option | Updates the shipping method in an eBay member checkout session. | View updateShippingOption - /checkout_session/{checkoutSessionId}/update_shipping_option |
guest_checkout_session
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| applyGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all the eligible items in the order. (Limited Release) You must be whitelisted to use this method. | View applyGuestCoupon - /guest_checkout_session/{checkoutSessionId}/apply_coupon |
| getGuestCheckoutSession | GET | /guest_checkout_session/{checkoutSessionId} | Retrieves the specified guest checkout session details. | View getGuestCheckoutSession - /guest_checkout_session/{checkoutSessionId} |
| initiateGuestCheckoutSession | POST | /guest_checkout_session/initiate | Creates an eBay guest checkout session. This is the first step in performing a checkout. | View initiateGuestCheckoutSession - /guest_checkout_session/initiate |
| initiateGuestPayment | POST | /guest_checkout_session/{checkoutSessionId}/initiate_payment | Enables eBay guests to pay for their items, using a variety of financial instruments, using PayPal Checkout. Note: This method requires integration of PayPal's checkout.js on the client side. | View initiateGuestPayment - /guest_checkout_session/{checkoutSessionId}/initiate_payment |
| placeGuestOrder | POST | /guest_checkout_session/{checkoutSessionId}/place_order | Pays for the items in the specified eBay guest checkout session. | View placeGuestOrder - /guest_checkout_session/{checkoutSessionId}/place_order |
| removeGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/remove_coupon | Removes a coupon from the checkout session. (Limited Release) You must be whitelisted to use this method. | View removeGuestCoupon - /guest_checkout_session/{checkoutSessionId}/remove_coupon |
| updateGuestPaymentInfo | POST | /guest_checkout_session/{checkoutSessionId}/update_payment_info | Updates the payment method in an eBay guest checkout session. | View updateGuestPaymentInfo - /guest_checkout_session/{checkoutSessionId}/update_payment_info |
| updateGuestQuantity | POST | /guest_checkout_session/{checkoutSessionId}/update_quantity | Updates the quantity of the specified line item in an eBay guest checkout session. | View updateGuestQuantity - /guest_checkout_session/{checkoutSessionId}/update_quantity |
| updateGuestShippingAddress | POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_address | Updates the shipping address for the specified line item in an eBay guest checkout session. | View updateGuestShippingAddress - /guest_checkout_session/{checkoutSessionId}/update_shipping_address |
| updateGuestShippingOption | POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_option | Updates the shipping method in an eBay proxy guest checkout session. | View updateGuestShippingOption - /guest_checkout_session/{checkoutSessionId}/update_shipping_option |
proxy_guest_checkout_session
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| applyProxyGuestCoupon | POST | /proxy_guest_checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all the eligible items in the order. (Limited Release) You must be whitelisted to use this method. | View applyProxyGuestCoupon - /proxy_guest_checkout_session/{checkoutSessionId}/apply_coupon |
| getProxyGuestCheckoutSession | GET | /proxy_guest_checkout_session/{checkoutSessionId} | Retrieves the specified eBay proxy guest checkout session details. | View getProxyGuestCheckoutSession - /proxy_guest_checkout_session/{checkoutSessionId} |
| initiateProxyGuestCheckoutSession | POST | /proxy_guest_checkout_session/initiate | Creates an eBay proxy guest checkout session that includes the buyers payment information. | View initiateProxyGuestCheckoutSession - /proxy_guest_checkout_session/initiate |
| placeProxyGuestOrder | POST | /proxy_guest_checkout_session/{checkoutSessionId}/place_order | Pays for the items in the specified eBay proxy guest checkout session. | View placeProxyGuestOrder - /proxy_guest_checkout_session/{checkoutSessionId}/place_order |
| removeProxyGuestCoupon | POST | /proxy_guest_checkout_session/{checkoutSessionId}/remove_coupon | Removes a coupon from the checkout session. (Limited Release) You must be whitelisted to use this method. | View removeProxyGuestCoupon - /proxy_guest_checkout_session/{checkoutSessionId}/remove_coupon |
| updateProxyGuestPaymentInfo | POST | /proxy_guest_checkout_session/{checkoutSessionId}/update_payment_info | Adds or updates the payment method in an eBay proxy guest checkout session. Note: This endpoint is invoked by the VSP (vault service provider) on behalf of the eBay partner. | View updateProxyGuestPaymentInfo - /proxy_guest_checkout_session/{checkoutSessionId}/update_payment_info |
| updateProxyGuestQuantity | POST | /proxy_guest_checkout_session/{checkoutSessionId}/update_quantity | Updates the quantity of the specified line item in an eBay proxy guest checkout session. | View updateProxyGuestQuantity - /proxy_guest_checkout_session/{checkoutSessionId}/update_quantity |
| updateProxyGuestShippingAddress | POST | /proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address | Updates the shipping address for the specified line item in an eBay proxy guest checkout session. | View updateProxyGuestShippingAddress - /proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address |
| updateProxyGuestShippingOption | POST | /proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_option | Updates the shipping method in an eBay proxy guest checkout session. | View updateProxyGuestShippingOption - /proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_option |
guest_purchase_order
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getGuestPurchaseOrder | GET | /guest_purchase_order/{purchaseOrderId} | Retrieves the details of a specific guest purchase order. | View getGuestPurchaseOrder - /guest_purchase_order/{purchaseOrderId} |
purchase_order
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPurchaseOrder | GET | /purchase_order/{purchaseOrderId} | Retrieves the details of a specific eBay member purchase order. | View getPurchaseOrder - /purchase_order/{purchaseOrderId} |