eBay Guest_checkout_session API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Guest_checkout_session. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
7 operations
across 7 paths,
and defines 27 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
7 operations7 paths27 schemas1 GET6 POST
Metadata
The identity and technical contract details declared by the specification.
eBay Guest_checkout_session API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
applyGuestCoupon4 paramsbody→ 200400403404409500
GET
/guest_checkout_session/{checkoutSessionId}
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1beta version of the Order API. Important! (Limited Rel…
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are LineItem (13 properties), PricingSummaryV2 (10 properties), Error (9 properties), ShippingAddress (9 properties). Each schema is shown below with its type and property counts.
Coupon
object
A type that defines the fields for the coupon information. Note: This container is not returned for the getGuestPurchaseOrder method.
1 property
AuthenticityVerificationProgram
object
A type that provides the status and outcome of an order line item going through the Authenticity Guarantee verification process.
4 properties
LineItemInput
object
A type that defines the fields for a line item.
2 properties
GuestCheckoutSessionResponseV2
object
Guest session response v2
6 properties
ShippingAddressImpl
object
A type that defines the shipping address fields. Note: If the address cannot be validated, a warning message is returned along with the response.
9 properties
PricingSummaryV2
object
A type that returns cost details for all of the line items in the order, such as tax, item price, delivery cost, and discounts.
10 properties
Image
object
A container that returns the URL for an image.
1 property
ShippingOption
object
A type that defines the fields for the shipping options.
9 properties
Amount
object
A container defining the monetary value of an amount, in the currency used on the eBay site that offers the item, and the conversion of that value into another…
2 properties
Recipient
object
A container that defines the full name of the person receiving the purchase order.
2 properties
Error
object
A type that defines the fields for the error messages.
9 properties
ImportTax
object
This container defines the type of import tax applicable to the order, and the total amount of tax for all line items in the order.
2 properties
ShippingAddress
object
A type that defines the fields for a shipping address. For restrictions, see Shipping restrictions . Note: If the address cannot be validated, a warning messag…
9 properties
Promotion
object
A container that returns the details of an item promotion.
3 properties
Seller
object
A type that identifies the seller.
1 property
UpdateQuantity
object
A type that defines the fields used to update the quantity of a line item.
2 properties
TaxJurisdiction
object
The type that defines the fields for the tax jurisdiction details.
2 properties
ImportChargesV2
object
A type that defines the import charges that apply to an order.
2 properties
Fee
object
A breakdown of the fees associated with the line item.
2 properties
TaxDetail
object
A type that defines the tax fields.
3 properties
UpdateShippingOption
object
A type that defines the fields used to update the shipping option of a line item.
2 properties
Adjustment
object
A type that defines the fields for seller adjustments. An adjustment can be a credit or debit.
2 properties
LineItem
object
A type that defines the fields for an individual line item.
13 properties
ErrorParameter
object
An array of name/value pairs that provide details regarding the error.
2 properties
CouponRequest
object
A type that defines the fields for the coupon information used in the request.
1 property
Region
object
A type that provides region details for a tax jurisdiction.
2 properties
CreateGuestCheckoutSessionRequestV2
object
A type that defines the fields used to create an eBay guest checkout session.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
