order APIv2.0.0

getGuestCheckoutSession

GET
/guest_checkout_session/{checkoutSessionId}
Note: This version of the Order API (v2) currently only supports the guest payment flow for eBay managed payments. To view the v1_beta version of the Order API, which includes both member and guest checkout payment flows, refer to the Order_v1 API documentation.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}

Input

Resource URI (production)

GET https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}

URI parameters

ParameterTypeDescription
checkoutSessionIdstringThe eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringA header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values.

Occurrence: Required

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/buy.guest.order

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* GuestCheckoutSessionResponseV2 */
"lineItems" : [
{ /* LineItem */
"image" :
{ /* Image */ },
"itemId" : "string",
"seller" :
{ /* Seller */ },
}
],
}
Output container/fieldTypeDescription
appliedCouponsarray of CouponA container that returns the information for the coupons that were applied in the guest checkout session.

Occurrence: Conditional

appliedCoupons.redemptionCodestringThe coupon redemption code.

Occurrence: Always

checkoutSessionIdstringThe eBay-assigned guest checkout session ID. This ID is created after a successful initiateGuestCheckoutSession call.

Occurrence: Always

lineItemsarray of LineItemAn array of line items associated with the guest checkout session.

Occurrence: Always

lineItems.authenticityVerificationAuthenticityVerificationProgramA container returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.

Occurrence: Conditional

lineItems.authenticityVerification.descriptionstringAn informational message that applies to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.authenticityVerification.outcomeReasonstringAn informational message regarding the authentication outcome of an Authenticity Guarantee verification inspection.

Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.authenticityVerification.statusAuthenticityVerificationStatusEnumAn enumerated value that indicates whether the order line item has passed or failed the Authenticity Guarantee verification inspection, or whether the inspection and/or results are still pending.

Note: This field is conditionally returned when the purchase is complete.

Valid Values:
  • PENDING
  • PASSED
  • FAILED
  • INELIGIBLE

Occurrence: Conditional

lineItems.authenticityVerification.termsWebUrlstringThe terms and conditions that apply to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.baseUnitPriceAmountThe cost of a single quantity of the line item. This is the starting point for computing the price during the checkout session.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.

Occurrence: Always

lineItems.baseUnitPrice.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.baseUnitPrice.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.feesarray of FeeA breakdown of the fees applicable to the line item.

Occurrence: Conditional

lineItems.fees.amountAmountA container for the currency type and monetary amount of the fee associated with the line item.

Occurrence: Conditional

lineItems.fees.amount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.fees.amount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.fees.feeTypeFeeEnumThe type of fee associated with the line item.

Occurrence: Conditional

lineItems.imageImageAn eBay-assigned URL of the item image.

Occurrence: Always

lineItems.image.imageUrlstringThe URL for the image.

Occurrence: Always

lineItems.itemIdstringThe eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID is in RESTful item ID format.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility.

Occurrence: Always

lineItems.lineItemIdstringA unique eBay-assigned ID value that identifies a line item in a checkout session.

Occurrence: Always

lineItems.netPriceAmountThe total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.

Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments.

Occurrence: Always

lineItems.netPrice.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.netPrice.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.promotionsarray of PromotionAn array of promotions applied to the line item.

Occurrence: Conditional

lineItems.promotions.discountAmountThe details regarding the monetary value of the promotional discount.

Note: eBay Bucks are not supported.

Occurrence: Conditional

lineItems.promotions.discount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.promotions.discount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.promotions.messagestringThe text for the promotion title, which describes the promotion.

Occurrence: Conditional

lineItems.promotions.promotionTypestringThe kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.

Occurrence: Conditional

lineItems.quantityintegerThe quantity ordered for the line item.

Occurrence: Always

lineItems.sellerSellerA container that returns the information about the seller, such as their eBay user name.

Occurrence: Always

lineItems.seller.usernamestringThe user name created by the seller for use on eBay.

Occurrence: Always

lineItems.shippingOptionsarray of ShippingOptionAn array of shipping options that are available for the line item. By default, the first one will be selected.

Note: The updateGuestShippingOption method can be used to change the shipping option.

Occurrence: Always

lineItems.shippingOptions.baseDeliveryCostAmountThe delivery cost using this shipping option, for this line item, before any delivery discounts are applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.

Occurrence: Always

lineItems.shippingOptions.baseDeliveryCost.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.baseDeliveryCost.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.deliveryDiscountAmountThe monetary value of any delivery discounts.

Occurrence: Always

lineItems.shippingOptions.deliveryDiscount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.deliveryDiscount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.importChargesAmountThe Global Shipping Program import charges for this line item.

Occurrence: Conditional

lineItems.shippingOptions.importCharges.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.importCharges.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

lineItems.shippingOptions.maxEstimatedDeliveryDatestringThe end of the date range in which the purchase order is expected to be delivered to the shipping address.

Occurrence: Conditional

lineItems.shippingOptions.minEstimatedDeliveryDatestringThe beginning of the date range in which the purchase order is expected to be delivered to the shipping address.

Occurrence: Conditional

lineItems.shippingOptions.selectedbooleanA field that indicates whether the shipping method is selected.

Occurrence: Always

lineItems.shippingOptions.shippingCarrierCodestringThe shipping provider for the line item, such as FedEx or USPS.

Occurrence: Always

lineItems.shippingOptions.shippingOptionIdstringA unique ID for the selected shipping option/method.

Occurrence: Always

lineItems.shippingOptions.shippingServiceCodestringThe name of the shipping service code. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx).

Occurrence: Always

lineItems.taxDetailsarray of TaxDetailA container that returns the tax information for the line item.

Occurrence: Conditional

lineItems.taxDetails.includedInPricebooleanA field that indicates whether tax was applied for the cost of the item and its shipping.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdictionTaxJurisdictionA container that returns the tax jurisdiction information.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.regionRegionThe region of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.region.regionNamestringA localized text string that indicates the name of the region. Taxes are generally charged at the state/province level, or at the country level in the case of VAT tax.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.region.regionTypeRegionTypeEnumAn enumeration value that indicates the type of region for the tax jurisdiction.

Valid Values:
  • STATE_OR_PROVINCE
  • COUNTRY

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.taxJurisdictionIdstringThe identifier of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxTypeTaxTypeA field that indicates the type of tax that may be collected for the item.

Occurrence: Conditional

lineItems.titlestringThe seller-created title of the item.

Occurrence: Always

pricingSummaryPricingSummaryV2A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts.

Occurrence: Always

pricingSummary.additionalSavingsAmountThe total amount of the coupon discounts in the purchase order.

Occurrence: Conditional

pricingSummary.additionalSavings.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.additionalSavings.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.adjustmentAdjustmentThe total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields.

Occurrence: Always

pricingSummary.adjustment.amountAmountThe container that returns the amount and currency of an adjustment.

Occurrence: Always

pricingSummary.adjustment.amount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.adjustment.amount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.adjustment.labelstringThe text indicating what the adjustment was for.

Occurrence: Always

pricingSummary.deliveryCostAmountThe delivery cost for all of the line items, after any delivery discounts are applied.

For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.

Occurrence: Always

pricingSummary.deliveryCost.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.deliveryCost.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.feeAmountThe total amount of any fees for all the line items in the order, such as a recycling fee.

Occurrence: Always

pricingSummary.fee.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.fee.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.importChargesAmountThe sum of all Global Shipping Program import charges, for all the line items in the order.

Occurrence: Conditional

pricingSummary.importCharges.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.importCharges.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.importTaxImportTaxThe type of import tax applicable to the order, and the total amount of tax for all line items in the order.

Occurrence: Conditional

pricingSummary.importTax.amountAmountThe total amount of import tax for all line items of an order.

Occurrence: Conditional

pricingSummary.importTax.amount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.importTax.amount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.importTax.importTaxTypeImportTaxTypeEnumAn enumeration value that indicates the type of import tax applicable to the order. Currently, the only applicable import tax is the Goods and Services tax (indicated with GST). The Goods and Services tax is only applicable to orders for the eBay Australia marketplace.

Occurrence: Conditional

pricingSummary.priceDiscountAmountThe total discount amount for all line items in the order.

For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field.

Occurrence: Always

pricingSummary.priceDiscount.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.priceDiscount.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.priceSubtotalAmountThe total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.

Occurrence: Always

pricingSummary.priceSubtotal.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.priceSubtotal.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.taxAmountThe total amount of taxes for all line items in the order.

Occurrence: Always

pricingSummary.tax.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.tax.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.totalAmountThe total cost of the order, which includes: (priceSubtotal - priceDiscount) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings.

Occurrence: Always

pricingSummary.total.currencyCurrencyCodeEnumThe currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.

Occurrence: Conditional

pricingSummary.total.valuestringThe amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.

Occurrence: Conditional

shippingAddressShippingAddressA container that returns the address to which the purchase order will be shipped.

Occurrence: Always

shippingAddress.addressLine1stringThe first line of the street address where the item is being shipped.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces

Occurrence: Always

shippingAddress.addressLine2stringThe second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces

Occurrence: Conditional

shippingAddress.citystringThe city of the address where the item is being shipped.

Occurrence: Always

shippingAddress.countryCountryCodeEnumThe two letter code representing the country of the address.

Occurrence: Always

shippingAddress.countystringThe county of the address where the item is being shipped.

Occurrence: Conditional

shippingAddress.phoneNumberstringThe phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 4********4, you would enter +14********4. If you do not include this code, the service will use the country specified in the country field.

You can find the country code at https://countrycode.org.

Occurrence: Always

shippingAddress.postalCodestringThe postal code of the address where the item is being shipped.

Note: This is optional when shipping to EBAY_HK (Hong Kong).

Occurrence: Conditional

shippingAddress.recipientRecipientThe name of the person receiving the package.

Occurrence: Always

shippingAddress.recipient.firstNamestringThe first name of the person receiving the purchase order.

Occurrence: Conditional

shippingAddress.recipient.lastNamestringThe last name of the person receiving the purchase order.

Occurrence: Conditional

shippingAddress.stateOrProvincestringThe state or province of the address.

Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes.

Occurrence: Conditional

warningsarray of ErrorDetailV3An array of errors or warnings that were generated during the method processing.

Occurrence: Conditional

warnings.categorystringThis string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.

Occurrence: Conditional

warnings.domainstringThe name of the primary system where the error occurred. This is relevant for application errors.

Occurrence: Conditional

warnings.errorIdintegerA unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Conditional

warnings.inputRefIdsarray of stringAn array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.

Occurrence: Conditional

warnings.longMessagestringA detailed description of the condition that caused the error or warning, and information on what what must be done to correct the problem.

Occurrence: Conditional

warnings.messagestringA description of the condition that caused the error or warning.

Occurrence: Conditional

warnings.outputRefIdsarray of stringAn array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.

Occurrence: Conditional

warnings.parametersarray of ErrorParameterV3An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.

Occurrence: Conditional

warnings.parameters.namestringThe name of the input field that caused an issue with the method request.

Occurrence: Conditional

warnings.parameters.valuestringThe actual value that was passed in for the element specified in the name field.

Occurrence: Conditional

warnings.subdomainstringThe name of the subdomain in which the error or warning occurred.

Occurrence: NA

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
400Bad Request
403Access Forbidden
404Resource Not Found
409Conflict
500Internal Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
15000API_ORDERAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
15003API_ORDERREQUESTThe checkout session requested does not exist.
15025API_ORDERREQUESTThe App is not authorized to access this resource.
15027API_ORDERBUSINESSThe value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.
15029API_ORDERREQUESTThe X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}.

Warnings

For more on warnings, plus the codes of other common warnings, see Handling errors.

CodeDomainCategoryMeaning
20000API_ORDERBUSINESSThis order contains the item {itemId} that may be subject to certain importation permitting/licensing requirements. Please check applicable regulations for specific import restrictions in your country.
20001API_ORDERBUSINESSThis item {itemId} ships via a freight carrier. For information regarding shipping, tracking, delivery, etc. check with the seller.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get the Checkout Session Details for a Guest Checkout

This call retrieves the line items, shipping, cost, and payment details of the checkout session.

Input

The input is the checkoutSessionId URI parameter. This value was returned by the initiateGuestCheckoutSession call. There is no payload with this request.
GET
https://apix.ebay.com/buy/order/v2/guest_checkout_session/1********1

Output

The response contains the checkout session details.