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) 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 Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
applyCoupon | POST | /checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all the eligible items in the order. | 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. | View removeCoupon - /checkout_session/{checkoutSessionId}/remove_coupon |
updateAddonServicesStatus | POST | /checkout_session/{checkoutSessionId}/update_add_on_services_status | Changes the selection of add-on services for a member checkout 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 |
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} |