order APIv1_beta.11.0

API Reference : Resources

The Order API provides interfaces that lets shoppers pay for items (for both eBay guest and eBay member buyers). It also lets them track the payment and shipping status of the order. It enables eBay partners to 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 PayPal Checkout.
  • 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 NameHTTP MethodPathSummarySamples
getCheckoutSessionGET
/checkout_session/{checkoutSessionId}
Retrieves the specified eBay member checkout session details.View getCheckoutSession - /checkout_session/{checkoutSessionId}
initiateCheckoutSessionPOST
/checkout_session/initiate
Creates a eBay member checkout session. This is the first step in performing a checkout.View initiateCheckoutSession - /checkout_session/initiate
placeOrderPOST
/checkout_session/{checkoutSessionId}/place_order
Pays for the items in the specified an eBay member checkout session.View placeOrder - /checkout_session/{checkoutSessionId}/place_order
updatePaymentInfoPOST
/checkout_session/{checkoutSessionId}/update_payment_info
Updates the payment method in an eBay member session.View updatePaymentInfo - /checkout_session/{checkoutSessionId}/update_payment_info
updateQuantityPOST
/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
updateShippingAddressPOST
/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
updateShippingOptionPOST
/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 NameHTTP MethodPathSummarySamples
getGuestCheckoutSessionGET
/guest_checkout_session/{checkoutSessionId}
Retrieves the specified guest checkout session details.View getGuestCheckoutSession - /guest_checkout_session/{checkoutSessionId}
initiateGuestCheckoutSessionPOST
/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
initiateGuestPaymentPOST
/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 call requires integration of PayPal's checkout.js on the client side.
View initiateGuestPayment - /guest_checkout_session/{checkoutSessionId}/initiate_payment
placeGuestOrderPOST
/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
updateGuestPaymentInfoPOST
/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
updateGuestQuantityPOST
/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
updateGuestShippingAddressPOST
/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
updateGuestShippingOptionPOST
/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 NameHTTP MethodPathSummarySamples
getProxyGuestCheckoutSessionGET
/proxy_guest_checkout_session/{checkoutSessionId}
Retrieves the specified eBay proxy guest checkout session details.View getProxyGuestCheckoutSession - /proxy_guest_checkout_session/{checkoutSessionId}
initiateProxyGuestCheckoutSessionPOST
/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
placeProxyGuestOrderPOST
/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
updateProxyGuestPaymentInfoPOST
/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
updateProxyGuestQuantityPOST
/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
updateProxyGuestShippingAddressPOST
/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
updateProxyGuestShippingOptionPOST
/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 NameHTTP MethodPathSummarySamples
getGuestPurchaseOrderGET
/guest_purchase_order/{purchaseOrderId}
Retrieves the details of a specific guest purchase order.View getGuestPurchaseOrder - /guest_purchase_order/{purchaseOrderId}

purchase_order

Method NameHTTP MethodPathSummarySamples
getPurchaseOrderGET
/purchase_order/{purchaseOrderId}
Retrieves the details of a specific eBay member purchase order.View getPurchaseOrder - /purchase_order/{purchaseOrderId}