Note: This is the v1_beta version of the Order API which supports member checkout payment flows. If you need to support guest checkout payment flows, please use the v2 version of the Order API.

Just getting started with the Order API? See the following documents for details on using this API:

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

The API release history

The following table lists recent Order API releases. For older releases, see the Order API (v1_beta) Release Notes Archive.

Release Version Release Date Description of Release
v1_beta.31.0 2022-06-14
  • Added support to collect and remit (C&R) Canada sales tax
  • Removed guest checkout payment flows
v1_beta.30.0 2022-02-22 Added types and methods to support the selection of add-on services to items in an order.
v1_beta.29.1 2021-03-10 Removed support for applied coupons and promotion codes from the getPurchaseOrder and getGuestPurchaseOrder methods.
v1_beta.29.0 2020-12-23
  • Added support for line item tax details.
  • Updated response field descriptions to inform of value-added tax (VAT) inclusion in applicable jurisdictions.
v1_beta.28.0 2020-11-05 Added support for the Authenticity Guarantee program to the Order API.
v1_beta.27.0 2020-10-13 Added a new fee enumeration value to support the white goods disposal tax.
v1_beta.26.0 2020-10-01 Added support for the Singapore (SG) marketplace to the Order API.
v1_beta.25.2 2020-09-24
  • Added a new error message to the initiateCheckoutSession method.
  • Updated an existing error message for the initiateCheckoutSession, initiateGuestCheckoutSession, and initiateProxyGuestCheckoutSession methods.
v1_beta.25.1 2020-07-17 Added a new error message to the initiateCheckoutSession method.
v1_beta.25.0 2020-07-14 Added a new purchaseOrderWebUrl container to the getPurchaseOrder method response.

v1_beta.31.0

The following sections describe the changes implemented in this release.

eBay now collects and remits Canadian federal and provincial sales tax

To support the handling and processing of Canadian sales tax, the following changes have been implemented.

Added new taxDetails container at the Order level

A new taxDetails container has been added to the CheckoutSessionResponse and PurchaseOrder types for the checkout and order methods.

This container provides detailed information about the Canadian taxes being collected for an order.

Schema Changes

To support the new taxDetails container, the following types were added:

  • TaxDetails
  • TaxClassificationEnum
  • TaxClassificationDetail

Removed Guest Checkout Flows

Order v1 API no longer supports guest checkout payment flows.

Schema Changes

The following methods (and all related resources) have been removed:

  • guest_checkout_session
  • proxy_guest_checkout_session
  • guest_purchase_order

Note: If you have a use case that requires guest checkout payment flows, please use the v2 version Order API.

v1_beta.30.0

The following sections describe the changes implemented in this release.

Added the method updateAddonServicesStatus to checkout_session

The new method updateAddonServicesStatus defines which add-on services are selected for a checkout session.

Added the types AddonService and AddonServiceInput

AddonService defines the add-on services that apply to a line item in an order. AddonServiceInput defines the add-on services that are selected for a checkout session.

Note: Although this field is still returned in the response payloads, no promotion data will be provided.

v1_beta.29.1

The following sections describe the changes implemented in this release.

Removed support for applied coupons

The appliedCoupons container is no longer returned in the response payload of the getPurchaseOrder and getGuestPurchaseOrder methods.

Removed support for promotion codes

Promotion data is no longer returned for the promotionCode field in the response payload of the getPurchaseOrder and getGuestPurchaseOrder methods.

Note: Although this field is still returned in the response payloads, no promotion data will be provided.

v1_beta.29.0

The following sections describe the changes implemented in this release.

Added a new taxDetails container

A new taxDetails container was added to the LineItem and OrderLineItem types for the checkout and order methods.

This new container provides a breakdown of the tax information for the line item, such as the tax jurisdiction and the tax type.

Updated field descriptions for value-added tax (VAT)

The following response field descriptions where updated to inform users that the value returned includes a value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces:

  • baseDeliveryCost
  • baseUnitPrice
  • deliveryCost
  • priceSubtotal

To see the VAT-inclusive pricing/cost, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB).

Note: Refer to the VAT Obligations in the EU article for more information about VAT.

Schema changes

To support the new taxDetails container, the following new types were added:

  • Region
  • RegionTypeEnum
  • TaxDetail
  • TaxJurisdiction
  • TaxType

v1_beta.28.0

This API release contains the following update.

Support for the new Authenticity Guarantee program added to the Order API

The Authenticity Guarantee program provides the authentication status of an order as it passes through the item authentication process.

An AuthenticityVerificationProgram container is now returned for order line items going through the authenticity verification process. This container gives the outcome of an authentication verification inspection.

Schema Changes

These are the new types added for this release.

  • AuthenticityVerificationProgram: This type is used to provide the outcome of an order line item going through the Authenticity Guarantee service verification process. Unique properties of this type are:
    • description: An informational message that applies to the Authenticity Guarantee program.
    • outcomeReason: An informational message regarding the authentication outcome of an authenticity verification inspection.
    • status: The value in this enumerated field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are:
      • PENDING
      • PASSED
      • FAILED
      • INELIGIBLE
    • termsWebUrl: The terms and conditions that apply to the Authenticity Guarantee program.

v1_beta.27.0

A new WHITE_GOODS_DISPOSABLE_TAX value was added to the FeeEnum type to support the white goods disposal tax. When this enumeration value is returned, it indicates that a disposal tax on white goods was charged to the buyer against the order line item.

Note: White goods includes items like refrigerators, ranges, water heaters, freezers, unit air conditioners, washing machines, clothes dryers, and other similar domestic and commercial large appliances.

v1_beta.26.0

Support for the Singapore (SG) marketplace has been added to the Order API.

v1_beta.25.2

The following sections describe the changes implemented in this release.

Added a new error message

A new error message was added to the initiateCheckoutSession method.

Error ID Description
15051 Additional user details required. Please complete your registration or contact eBay customer support.

Updated an error message

The description for error message 15017 was updated as shown in the table below. This affects the initiateCheckoutSession, initiateGuestCheckoutSession, and initiateProxyGuestCheckoutSession methods.

Error ID Description
15017 The payment for the order line items in your cart could not be processed due to issues with one or more sellers.

v1_beta.25.1

The following section describes the changes implemented in this release.

Added a new error message

A new error message was added to the initiateCheckoutSession method.

Error ID Description
15050 Your transaction cannot be completed with the given information. Contact eBay customer service.

v1_beta.25.0

The following section describes the change implemented in this release.

Added a new purchaseOrderWebUrl container

A new purchaceOrderWebUrl container was added to the response of the getpurchaseOrder method. This new container returns the URL to the Order Details page on eBay.