Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Guest_purchase_order API

The Guest_purchase_order API from eBay — 1 operation(s) for guest_purchase_order.

eBay Guest_purchase_order 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_purchase_order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 18 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}.

1 operations 1 paths 18 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.9.2
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Guest_purchase_order 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Guest_purchase_order 1
GET
/guest_purchase_order/{purchaseOrderId}
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…
getGuestPurchaseOrder 3 params → 200400403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are OrderLineItemV2 (18 properties), PricingSummary (11 properties), Error (9 properties), GuestPurchaseOrderV2 (8 properties). Each schema is shown below with its type and property counts.

AuthenticityVerificationProgram
object
A type that provides the status and outcome of an order line item going through the Authenticity Guarantee verification process.
4 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
ErrorParameter
object
An array of name/value pairs that provide details regarding the error.
2 properties
PricingSummary
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.
11 properties
Region
object
A type that provides region details for a tax jurisdiction.
2 properties
ShippingDetail
object
A type that defines the fields for the shipping information, such as delivery date estimates and shipping provider.
4 properties
Image
object
A container that returns the URL for an image.
1 property
Promotion
object
A container that returns the details of an item promotion.
3 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
OrderLineItemV2
object
A type that defines the fields for line item information in a purchase order.
18 properties
TaxJurisdiction
object
The type that defines the fields for the tax jurisdiction details.
2 properties
LegacyReference
object
A type that defines the fields to support using the Post Order API for returns and cancellations. Restriction: The Post Order API can be used only with eBay me…
3 properties
Seller
object
A type that identifies the seller.
1 property
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
GuestPurchaseOrderV2
object
A type that defines the fields for a guest purchase order.
8 properties
Error
object
A type that defines the fields for the error messages.
9 properties
Adjustment
object
A type that defines the fields for seller adjustments. An adjustment can be a credit or debit.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-guest-purchase-order-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API