GET
/proxy_guest_checkout_session/{checkoutSessionId}
This method returns the details of the specified eBay proxy guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload.
To meet security requirements for payments, the URLs for this method are:
- Production URL:
https://apix.ebay.com/buy/order/v1 - Sandbox URL:
https://apix.sandbox.ebay.com/buy/order/v1
Note: This method is not available in the eBay API Explorer.
Restrictions
- This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments.
- This payment flow is supported only for the EBAY_US marketplace.
- For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
Input
Resource URI (production)
GET https://apix.ebay.com/buy/order/v1/proxy_guest_checkout_session/{checkoutSessionId}
URI parameters
| Parameter | Type | Description |
|---|---|---|
| checkoutSessionId | string | The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID in this method, the X-EBAY-C-MARKETPLACE-ID value must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
OAuth scope
This request requires an access token created with the client grant flow, using one scope from the following list:
https://api.ebay.com/oauth/api_scope/buy.proxy.guest.order
See OAuth access tokens for more information.
Output
{ /* GuestCheckoutSessionResponse */
"acceptedPaymentMethods" : [
{ /* PaymentMethod */ }
],"lineItems" : [
{ /* LineItem */ }
],"pricingSummary" :
{ /* PricingSummary */ },
"providedPaymentInstrument" :
}{ /* ProvidedPaymentInstrument */ },
| Output container/field | Type | Description |
|---|---|---|
| acceptedPaymentMethods | array of PaymentMethod | The container that returns the payment method that can be used to purchase the items. Occurrence: Always |
| acceptedPaymentMethods.label | string | Text indicating the payment type. For example, when paying by credit card, this label will be CC . When paying using PayPal Smart Button guest payment flow the label will be WALLET. Occurrence: Always |
| acceptedPaymentMethods.logoImage | Image | The URL of the image of the payment method logo. Occurrence: Conditional |
| acceptedPaymentMethods.logoImage.height | integer | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.logoImage.imageUrl | string | The URL of the image. Occurrence: Always |
| acceptedPaymentMethods.logoImage.width | integer | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodBrands | array of PaymentMethodBrand | An array of credit card brands that can be used as the payment method. Occurrence: Always |
| acceptedPaymentMethods.paymentMethodBrands.logoImage | Image | The URL of the image of the payment method company (brand). Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodBrands.logoImage.height | integer | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodBrands.logoImage.imageUrl | string | The URL of the image. Occurrence: Always |
| acceptedPaymentMethods.paymentMethodBrands.logoImage.width | integer | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodBrands.paymentMethodBrandType | PaymentMethodBrandEnum | An enumeration value that indicates the payment method company, such as Visa. Occurrence: Always |
| acceptedPaymentMethods.paymentMethodMessages | array of PaymentMethodMessage | The type that defines the fields for legal messages and buyer consent verification. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodMessages.legalMessage | string | Information that eBay is legally obligated to show to the buyer. This field can be null, in which case do nothing. But if this field is not null, the value of this field must appear on the checkout page. Note: This field is not used for US purchases. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodMessages.privacyPolicyWebUrl | string | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodMessages.requiredForUserConfirmation | boolean | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodMessages.userAgreementWebUrl | string | Reserved for future use. Occurrence: Conditional |
| acceptedPaymentMethods.paymentMethodType | PaymentMethodTypeEnum | An enumeration value that indicates the method of payment, such as credit card. Occurrence: Always |
| appliedCoupons | array of Coupon | The container that returns the information for the coupons that were applied in the checkout session. Occurrence: Conditional |
| appliedCoupons.redemptionCode | string | The coupon redemption code. Occurrence: Conditional |
| checkoutSessionId | string | The checkoutSessionId submitted in the request. Occurrence: Always |
| expirationDate | string | The time the checkout session will end. To purchase the items the order must be placed before this time. Occurrence: Always |
| lineItems | array of LineItem | An array of line items associated with the checkout session. Occurrence: Always |
| lineItems.baseUnitPrice | Amount | The cost (Buy It Now price) of a single item in this line item. It is a starting point for computing the price during checkout session. Occurrence: Always |
| lineItems.baseUnitPrice.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.baseUnitPrice.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| lineItems.image | Image | An eBay-assigned URL that points to an image of the item. eBay assigns the URL when the seller uploads the image. Occurrence: Always |
| lineItems.image.height | integer | Reserved for future use. Occurrence: Conditional |
| lineItems.image.imageUrl | string | The URL of the image. Occurrence: Always |
| lineItems.image.width | integer | Reserved for future use. Occurrence: Conditional |
| lineItems.itemId | string | A unique eBay-assigned ID value that identifies the item. Occurrence: Always |
| lineItems.lineItemId | string | A unique eBay-assigned ID value that identifies the line item in a checkout session. Occurrence: Always |
| lineItems.netPrice | Amount | The total cost for the items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1. Note: This also does not include any shipping discounts, shipping costs, fees, or seller adjustments. Occurrence: Always |
| lineItems.netPrice.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.netPrice.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| lineItems.promotions | array of Promotion | An array of promotions associated with the item of this line item. Occurrence: Conditional |
| lineItems.promotions.discount | Amount | The container that returns the monetary value of the promotional discount. Note: eBay Bucks are not supported. Occurrence: Always |
| lineItems.promotions.discount.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.promotions.discount.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| lineItems.promotions.discountPercentage | string | The discount percentage of the applied promotional offer. Occurrence: Conditional |
| lineItems.promotions.message | string | The text for the promotion title which is displayed on the page. For example, Buy 1 Get 1. Occurrence: Always |
| lineItems.promotions.promotionCode | string | An identifier of the promotion that was generated by the system when the promotion was created. Occurrence: Always |
| lineItems.promotions.promotionType | string | The value of the enumeration used when the promotions was created, which indicates the promotion type. For example, SellerDiscountedPromotionalOffer or COUPON. Occurrence: Always |
| lineItems.quantity | integer | The number of individual items ordered for this line item, as specified by the buyer. Occurrence: Always |
| lineItems.seller | Seller | The container that returns the information about the seller, such as their eBay user name. Occurrence: Always |
| lineItems.seller.feedbackPercentage | string | The percentage of the total positive feedback. Occurrence: Always |
| lineItems.seller.feedbackScore | integer | The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. Occurrence: Always |
| lineItems.seller.sellerAccountType | string | Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries. This field is returned only on the following sites. EBAY_AT EBAY_BE EBAY_CH EBAY_DE EBAY_ES EBAY_FR EBAY_GB EBAY_IE EBAY_IT EBAY_PL Valid values:
Occurrence: Conditional |
| lineItems.seller.username | string | The user name created by the seller for use on eBay. Occurrence: Conditional |
| lineItems.shippingOptions | array of ShippingOption | An array of the shipping methods that are available for the line item. By default, the first one will be selected. Occurrence: Always |
| lineItems.shippingOptions.baseDeliveryCost | Amount | The shipping cost using this shipping option for this line item before any shipping discounts. Occurrence: Always |
| lineItems.shippingOptions.baseDeliveryCost.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.shippingOptions.baseDeliveryCost.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| lineItems.shippingOptions.deliveryDiscount | Amount | The monetary value of any delivery discount. Occurrence: Always |
| lineItems.shippingOptions.deliveryDiscount.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.shippingOptions.deliveryDiscount.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| lineItems.shippingOptions.maxEstimatedDeliveryDate | string | The end of the date range in which the purchase order is expected to be delivered to the shipping address. Occurrence: Always |
| lineItems.shippingOptions.minEstimatedDeliveryDate | string | The beginning of the date range in which the purchase order is expected to be delivered to the shipping address. Occurrence: Always |
| lineItems.shippingOptions.selected | boolean | Indicates if the shipping method is selected. Occurrence: Always |
| lineItems.shippingOptions.shippingCarrierCode | string | The shipping provider, such as FedEx, or USPS for the line item. Occurrence: Always |
| lineItems.shippingOptions.shippingOptionId | string | A unique ID for the selected shipping option/method. Occurrence: Always |
| lineItems.shippingOptions.shippingServiceCode | string | A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). Occurrence: Always |
| lineItems.shortDescription | string | This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). Occurrence: Always |
| lineItems.title | string | The seller created title of the item. Occurrence: Always |
| marketingMessages | array of MarketingMessage | The container that returns the marketing consent fields. These fields show the legal marketing consent message to be shown to the buyer when they place the order, and the marketing channels, for example email, and marketing types, for example promotions, the buyer can choose to receive. Occurrence: Conditional |
| marketingMessages.legalMessage | string | This field returns the following marketing consent legal message. This message is to be shown to the buyer when they place the order. I agree to receive marketing offers, promotions, and surveys from eBay through emails. Occurrence: Conditional |
| marketingMessages.marketingChannels | array of MarketingChannelEnum | A list of enumeration values representing the marketing channels, such as email, that the buyer can choose to receive. These are to be shown to the buyer when they place the order. Occurrence: Conditional |
| marketingMessages.marketingTypes | array of MarketingTypeEnum | A list of enumeration values representing the marketing types, such as OFFER, that the buyer can choose to receive. These are to be shown to the buyer when they place the order. Occurrence: Conditional |
| pricingSummary | PricingSummary | The container that returns the grand total, costs, discounts, seller fees, and adjustments of all the line items. Occurrence: Always |
| pricingSummary.additionalSavings | Amount | The total amount of the coupon discounts in the purchase order. Occurrence: Conditional |
| pricingSummary.additionalSavings.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.additionalSavings.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.adjustment | Adjustment | The 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.amount | Amount | The container that returns the amount and currency of an adjustment. Occurrence: Always |
| pricingSummary.adjustment.amount.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.adjustment.amount.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.adjustment.label | string | Text indicating what the adjustment was for. Occurrence: Always |
| pricingSummary.deliveryCost | Amount | The shipping cost for all the line items before any shipping discounts are applied. Let's say there were 4 line items and the shipping cost for each line items is $5. One of the line items qualifies for free shipping and two line items qualify for a Buy 1 Get 1 offer, which would be a $6 and a $15 discount. The deliveryCost value would be 20, which is the total cost for shipping all the line items before discounts. Occurrence: Always |
| pricingSummary.deliveryCost.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.deliveryCost.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.deliveryDiscount | Amount | The total amount of the shipping discounts for the all line items, which include promotional shipping discounts, such as free shipping if you buy two or more. Let's say there were 4 line items and the shipping cost for each line items is $5. One of the line items qualifies for free shipping and two line items qualify for a Buy 1 Get 1 offer, which would be a $6 and a $15 discount. The deliveryDiscounts value would be 5, which is the value of the free shipping discount. Note: This will always be a negative number. Occurrence: Always |
| pricingSummary.deliveryDiscount.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.deliveryDiscount.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.fee | Amount | The total amount of any fees for all the line items, such as a recycling fee. Occurrence: Always |
| pricingSummary.fee.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.fee.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.priceDiscount | Amount | The total amount of all the item specific discounts for all line items, such as Buy 1 Get 1 free. Let's say there were 4 line items and the shipping cost for each line items is $5. One of the line items qualifies for free shipping and two line items qualify for a Buy 1 Get 1 offer, which would be a $6 and a $15 discount. The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. Note: This will always be a negative number. Occurrence: Always |
| pricingSummary.priceDiscount.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.priceDiscount.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.priceSubtotal | Amount | The total amount for all the line items before adding in taxes and shipping costs, or applying discounts, fees, and adjustments. Occurrence: Always |
| pricingSummary.priceSubtotal.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.priceSubtotal.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.tax | Amount | The total amount of the taxes for all the line items. Occurrence: Always |
| pricingSummary.tax.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.tax.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| pricingSummary.total | Amount | The total of the purchase order. total = priceSubtotal + baseDeliveryCost + taxes + deliveryDiscounts + priceDiscount + adjustments Note: deliveryDiscounts and priceDiscount are negative numbers. Occurrence: Always |
| pricingSummary.total.currency | CurrencyCodeEnum | The currency involved in a monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.total.value | string | The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the eBay site offering the item. Occurrence: Always |
| providedPaymentInstrument | ProvidedPaymentInstrument | The container that returns the payment methods that can be used for the checkout. This is returned only if you have used the updatePaymentInfo method to change the payment method. Occurrence: Conditional |
| providedPaymentInstrument.paymentInstrumentReference | PaymentInstrumentReference | The container that returns the payment reference, such as last four digits of a credit card. Occurrence: Conditional |
| providedPaymentInstrument.paymentInstrumentReference.externalReferenceId | string | The identifier of the buyer's PayPal cart, which is returned by the initiateGuestPayment method. This ID is generated by PayPal and required for the PayPal Smart Button guest payment flow. Occurrence: Conditional |
| providedPaymentInstrument.paymentInstrumentReference.lastFourDigitForCreditCard | string | The last four digits of the credit card number being used to pay for the items. Occurrence: Conditional |
| providedPaymentInstrument.paymentMethodBrand | PaymentMethodBrand | The container that returns the name and logo of the payment company (brand), such as Visa. Occurrence: Conditional |
| providedPaymentInstrument.paymentMethodBrand.logoImage | Image | The URL of the image of the payment method company (brand). Occurrence: Conditional |
| providedPaymentInstrument.paymentMethodBrand.logoImage.height | integer | Reserved for future use. Occurrence: Conditional |
| providedPaymentInstrument.paymentMethodBrand.logoImage.imageUrl | string | The URL of the image. Occurrence: Always |
| providedPaymentInstrument.paymentMethodBrand.logoImage.width | integer | Reserved for future use. Occurrence: Conditional |
| providedPaymentInstrument.paymentMethodBrand.paymentMethodBrandType | PaymentMethodBrandEnum | An enumeration value that indicates the payment method company, such as Visa. Occurrence: Always |
| providedPaymentInstrument.paymentMethodType | PaymentMethodTypeEnum | An enumeration value that indicates the method of payment, such as CREDIT_CARD. Occurrence: Conditional |
| shippingAddress | ShippingAddress | The container that returns the address to which the purchase order will be shipped. Note: If the address cannot be validated, a warning message is be returned along with the response. Occurrence: Always |
| shippingAddress.addressLine1 | string | The first line of the street address where the item is being shipped. Occurrence: Always |
| shippingAddress.addressLine2 | string | The 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'. Occurrence: Conditional |
| shippingAddress.city | string | The city of the address where the item is being shipped. Occurrence: Always |
| shippingAddress.country | CountryCodeEnum | The two letter code representing the country of the address. Restrictions: Currently, the only country supported for a shipping address is US. Occurrence: Always |
| shippingAddress.county | string | The county of the address where the item is being shipped. Occurrence: Always |
| shippingAddress.phoneNumber | string | The phone number of the person receiving the package. Occurrence: Always |
| shippingAddress.postalCode | string | The postal code of the address where the item is being shipped. Occurrence: Always |
| shippingAddress.recipient | string | The name of the person receiving the package. Occurrence: Always |
| shippingAddress.stateOrProvince | string | The state or province of the address where the item is being shipped. Occurrence: Always |
| warnings | array of ErrorDetailV3 | An array of any process errors or warnings that were generated during the method processing. Occurrence: Conditional |
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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Access Forbidden |
| 404 | Resource Not Found |
| 409 | Conflict |
| 500 | Internal Error |
Error codes
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 15000 | API_ORDER | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 15003 | API_ORDER | REQUEST | The checkout session requested does not exist. |
| 15019 | API_ORDER | BUSINESS | To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of 4) and create a new checkout session. |
| 15025 | API_ORDER | REQUEST | The App is not authorized to access this resource. |
| 15027 | API_ORDER | BUSINESS | The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}. |
| 15029 | API_ORDER | REQUEST | The 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}. |
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 a Proxy Guest Checkout Session Details
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 initiateProxyGuestCheckoutSession call. There is no payload with this request.
GET
https://apix.ebay.com/buy/order/v1/proxy_guest_checkout_session/v1|5018578757|63iqkv_LQQy
Output
The response contains the checkout session details.