Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

Note: This is the v1_beta version of the Order API which supports member checkout payment flows. If you need to support guest checkout payment flows, please use the v2 version of the Order API.

Note: This is a Limited Release(Limited Release) API available only to select developers approved by business units.

The Order API provides interfaces that let eBay members pay for items. It also returns payment and shipping status of the order.


Method NameHTTP MethodPathSummarySamples
applyCouponPOST/checkout_session/{checkoutSessionId}/apply_couponApplies a coupon to all the eligible items in the order.   Limited Release(Limited Release) You must be whitelisted to use this method. View applyCoupon - /checkout_session/{checkoutSessionId}/apply_coupon
getCheckoutSessionGET/checkout_session/{checkoutSessionId}Retrieves the specified eBay member checkout session details.View getCheckoutSession - /checkout_session/{checkoutSessionId}
initiateCheckoutSessionPOST/checkout_session/initiateCreates a eBay member checkout session. This is the first step in performing a checkout.View initiateCheckoutSession - /checkout_session/initiate
placeOrderPOST/checkout_session/{checkoutSessionId}/place_orderPays for the items in the specified an eBay member checkout session.View placeOrder - /checkout_session/{checkoutSessionId}/place_order
removeCouponPOST/checkout_session/{checkoutSessionId}/remove_couponRemoves a coupon from the checkout session.   Limited Release(Limited Release) You must be whitelisted to use this method.View removeCoupon - /checkout_session/{checkoutSessionId}/remove_coupon
updateAddonServicesStatusPOST/checkout_session/{checkoutSessionId}/update_add_on_services_statusChanges the selection of add-on services for a member checkout session.View updateAddonServicesStatus - /checkout_session/{checkoutSessionId}/update_add_on_services_status
updatePaymentInfoPOST/checkout_session/{checkoutSessionId}/update_payment_infoUpdates the payment method in an eBay member session.View updatePaymentInfo - /checkout_session/{checkoutSessionId}/update_payment_info
updateQuantityPOST/checkout_session/{checkoutSessionId}/update_quantityUpdates 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_addressUpdates 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_optionUpdates the shipping method in an eBay member checkout session.View updateShippingOption - /checkout_session/{checkoutSessionId}/update_shipping_option


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