Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta 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 shoppers pay for items. It also returns payment and shipping status of the order.
guest_checkout_session
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| applyGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/apply_coupon | Applies a coupon to all eligible items in the guest checkout session. | View applyGuestCoupon - /guest_checkout_session/{checkoutSessionId}/apply_coupon |
| getGuestCheckoutSession | GET | /guest_checkout_session/{checkoutSessionId} | Retrieves details on a guest checkout session. | View getGuestCheckoutSession - /guest_checkout_session/{checkoutSessionId} |
| initiateGuestCheckoutSession | POST | /guest_checkout_session/initiate | Initiates a guest checkout session by adding one or more line items to purchase. | View initiateGuestCheckoutSession - /guest_checkout_session/initiate |
| removeGuestCoupon | POST | /guest_checkout_session/{checkoutSessionId}/remove_coupon | Removes a coupon that was previously applied to a guest checkout session. | View removeGuestCoupon - /guest_checkout_session/{checkoutSessionId}/remove_coupon |
| updateGuestQuantity | POST | /guest_checkout_session/{checkoutSessionId}/update_quantity | Updates the quantity of a line item in a guest checkout session. Line item will be removed from checkout session is quantity is set to 0. | View updateGuestQuantity - /guest_checkout_session/{checkoutSessionId}/update_quantity |
| updateGuestShippingAddress | POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_address | Adds or updates the buyer's shipping address that will be used after the buyer purchases the order. | View updateGuestShippingAddress - /guest_checkout_session/{checkoutSessionId}/update_shipping_address |
| updateGuestShippingOption | POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_option | Adds or updates the buyer's preferred shipping service option that will be used for shipping the order. | View updateGuestShippingOption - /guest_checkout_session/{checkoutSessionId}/update_shipping_option |
guest_purchase_order
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getGuestPurchaseOrder | GET | /guest_purchase_order/{purchaseOrderId} | Retrieves details on a guest order. | View getGuestPurchaseOrder - /guest_purchase_order/{purchaseOrderId} |