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.

checkout_session

Method NameHTTP MethodPathSummarySamples
applyCouponPOST/checkout_session/{checkoutSessionId}/apply_couponApplies a coupon to all eligible items in the checkout session.View applyCoupon - /checkout_session/{checkoutSessionId}/apply_coupon
getCheckoutSessionGET/checkout_session/{checkoutSessionId}Retrieves details on a checkout session.View getCheckoutSession - /checkout_session/{checkoutSessionId}
initiateCheckoutSessionPOST/checkout_session/initiateInitiates a checkout session by adding one or more line items to purchase.View initiateCheckoutSession - /checkout_session/initiate
placeOrderPOST/checkout_session/{checkoutSessionId}/place_orderInitiates payment of the order using the credit card specified in the checkout session.View placeOrder - /checkout_session/{checkoutSessionId}/place_order
removeCouponPOST/checkout_session/{checkoutSessionId}/remove_couponRemoves a coupon that was previously applied to a checkout session.View removeCoupon - /checkout_session/{checkoutSessionId}/remove_coupon
updateAddonServicesStatusPOST/checkout_session/{checkoutSessionId}/update_add_on_services_statusAdds or modifies add-on services for a line item in the checkout session.View updateAddonServicesStatus - /checkout_session/{checkoutSessionId}/update_add_on_services_status
updatePaymentInfoPOST/checkout_session/{checkoutSessionId}/update_payment_infoAdds or changes the credit card in the checkout session that will be used for payment.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_addressAdds or updates the buyer's shipping address that will be used after the buyer purchases the order.View updateShippingAddress - /checkout_session/{checkoutSessionId}/update_shipping_address
updateShippingOptionPOST/checkout_session/{checkoutSessionId}/update_shipping_optionAdds or updates the buyer's preferred shipping service option that will be used for shipping the order.View updateShippingOption - /checkout_session/{checkoutSessionId}/update_shipping_option

purchase_order

Method NameHTTP MethodPathSummarySamples
getPurchaseOrderGET/purchase_order/{purchaseOrderId}Retrieves details on an order.View getPurchaseOrder - /purchase_order/{purchaseOrderId}