Home
Note: This version of the Order API (v2) currently only supports the guest payment flow for eBay managed payments. To view the v1_beta version of the Order API, which includes both member and guest checkout payment flows, refer to the Order_v1 API 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. It also returns payment and shipping status of the order.
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
applyGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all eligible items in the order. | 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 |
removeGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/remove_coupon | Removes a coupon from the checkout session. | View removeGuestCoupon - /guest_checkout_session/{checkoutSessionId}/remove_coupon |
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 option in an eBay guest checkout session. | View updateGuestShippingOption - /guest_checkout_session/{checkoutSessionId}/update_shipping_option |
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} |