order APIv1_beta.9.0

API Reference : Resources

The Order API provides interfaces that start a checkout session, which lets shoppers pay for items (for both guest and eBay member buyers). It also lets sellers track the payment and shipping status of the order and enables them to use the Post Order API for returns and cancellations.

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 for 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 for 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 a guest checkout session. This is the first step in performing a checkout.View initiateGuestCheckoutSession - /guest_checkout_session/initiate
placeGuestOrderPOST
/guest_checkout_session/{checkoutSessionId}/place_order
Pays for the items in the specified guest checkout session.View placeGuestOrder - /guest_checkout_session/{checkoutSessionId}/place_order
updateGuestPaymentInfoPOST
/guest_checkout_session/{checkoutSessionId}/update_payment_info
Updates the payment method for a guest 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 for a guest checkout.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 a guest checkout session.View updateGuestShippingAddress - /guest_checkout_session/{checkoutSessionId}/update_shipping_address
updateGuestShippingOptionPOST
/guest_checkout_session/{checkoutSessionId}/update_shipping_option
Updates the shipping method for a guest checkout session.View updateGuestShippingOption - /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}