POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address
This method changes the shipping address for the order in an eBay proxy guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item.
Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address.
The URLs for this method are:
- Production URL:
https://apix.ebay.com/buy/order/v1/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address - Sandbox URL:
https://apix.sandbox.ebay.com/buy/order/v1/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address
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.
- The Vault service eBay guest 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)
POST https://apix.ebay.com/buy/order/v1/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address
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, the X-EBAY-C-MARKETPLACE-ID value and developer App ID 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 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.proxy.guest.order
See OAuth access tokens for more information.
| Input container/field | Type | Description |
|---|---|---|
| addressLine1 | string | The first line of the street address. Maximun characters:
Occurrence: Required |
| 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: Optional |
| city | string | The city of the address. Occurrence: Required |
| country | CountryCodeEnum | The two letter code representing the country of the address. Occurrence: Required |
| county | string | The county of the address. Occurrence: Optional |
| phoneNumber | string | The 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: Required |
| postalCode | string | The postal code of the address. Occurrence: Required |
| recipient | string | Full name of the person receiving the purchase order. Occurrence: Required |
| stateOrProvince | string | The state or province of the address. Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. Occurrence: Required |
Output
{ /* GuestCheckoutSessionResponse */
"acceptedPaymentMethods" : [
{ /* PaymentMethod */ }
],"lineItems" : [
{ /* LineItem */
],"shippingOptions" : [],
"taxDetails" : [],
}"pricingSummary" :
{ /* PricingSummary */ },
"providedPaymentInstrument" :
}{ /* ProvidedPaymentInstrument */ },
| Output container/field | Type | Description |
|---|---|---|
| acceptedPaymentMethods | array of PaymentMethod | The container that returns the payment methods 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 value will be CC. When paying using PayPal Smart Button eBay guest payment flow the value 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 payment method company (brand) image. 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: Always |
| 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.authenticityVerification | AuthenticityVerificationProgram | This container is 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.description | string | An informational message that applies to the Authenticity Guarantee program. Occurrence: Conditional |
| lineItems.authenticityVerification.outcomeReason | string | An informational message regarding the authentication outcome of an authenticity verification inspection. Note:This field is conditionally returned when there is information that applies to the Authenticity Guarantee program. Occurrence: Conditional |
| lineItems.authenticityVerification.status | AuthenticityVerificationStatusEnum | The value in this 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, or INELIGIBLE.Note: This field is conditionally returned when purchase is complete. Occurrence: Conditional |
| lineItems.authenticityVerification.termsWebUrl | string | The terms and conditions that apply to the Authenticity Guarantee program. Occurrence: Conditional |
| lineItems.baseUnitPrice | Amount | The cost of a single item in this line item. This is the starting point for computing the price during 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.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.baseUnitPrice.value | string | The amount 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.fees | array of Fee | A breakdown of the fees applicable to the line item. Occurrence: Conditional |
| lineItems.fees.amount | Amount | A container for the currency type and monetary amount of the fees associated with the line item. Occurrence: Conditional |
| lineItems.fees.amount.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.fees.amount.value | string | The amount 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.fees.feeType | FeeEnum | The type of fee associated with the line item. Occurrence: Conditional |
| lineItems.image | Image | An eBay-assigned URL of the item image. 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 | The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID must be in RESTful item ID format. For example: v1|2**********6|5**********4 or v1|1**********9|0. For more information about item ID for RESTful APIs, see the Legacy API compatibility. Each itemId will become a single line item. You can have a maximum of 10 itemId(s) per checkout. Occurrence: Always |
| lineItems.lineItemId | string | A unique eBay-assigned ID value that identifies a 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, and any coupon that applies to this item. Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments. Occurrence: Always |
| lineItems.netPrice.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.netPrice.value | string | The amount 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 applied to 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 used in the 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 amount 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 for the items in this line item. For example, a seller item discount, such as Buy 1 Get 1, or a coupon. Note: The purchase order methods do not support this field. Occurrence: Conditional |
| lineItems.promotions.message | string | The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1. Occurrence: Always |
| lineItems.promotions.promotionCode | string | An identifier of the promotion, which was generated by the system when the promotion was created. Note: No data is returned in this field for the getPurchaseOrder and getGuestPurchaseOrder methods. Occurrence: Always |
| lineItems.promotions.promotionType | string | Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON. Occurrence: Always |
| lineItems.quantity | integer | The number of individual items ordered for this line item. 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 seller's 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: Always |
| 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 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.currency | CurrencyCodeEnum | The currency used in the 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 amount 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 used in the 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 amount 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.importCharges | Amount | The Global Shipping Program import charges for this line item. Occurrence: Conditional |
| lineItems.shippingOptions.importCharges.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| lineItems.shippingOptions.importCharges.value | string | The amount 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: Conditional |
| 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: Conditional |
| 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, item title, and the item aspects (such as size, color, capacity, model, brand, etc.). Occurrence: Always |
| lineItems.taxDetails | array of TaxDetail | A container for the tax information for the line item. Note: The information in this container is only returned when requested from the GB marketplace, when applicable. Occurrence: Conditional |
| lineItems.taxDetails.includedInPrice | boolean | A field that indicates whether tax was applied for the cost of the item and its shipping. Occurrence: Conditional |
| lineItems.taxDetails.taxJurisdiction | TaxJurisdiction | A container that returns the tax jurisdiction information. Occurrence: Conditional |
| lineItems.taxDetails.taxJurisdiction.region | Region | The region of the tax jurisdiction. Occurrence: Conditional |
| lineItems.taxDetails.taxJurisdiction.region.regionName | string | A 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.regionType | RegionTypeEnum | An enumeration value that indicates the type of region for the tax jurisdiction. Valid Values:
Occurrence: Conditional |
| lineItems.taxDetails.taxJurisdiction.taxJurisdictionId | string | The identifier of the tax jurisdiction. Occurrence: Conditional |
| lineItems.taxDetails.taxType | TaxType | A field that indicates the type of tax that may be collected for the item. Occurrence: Conditional |
| 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 that is 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 legal marketing consent 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 information about the costs of the order, such as the total cost, discounts, etc., 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 used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.additionalSavings.value | string | The amount 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 used in the 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 amount 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 of the line items after any shipping discounts are applied. Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryCost value would be $15, which is the total cost for shipping all of the line items after the discount is applied. Occurrence: Always |
| pricingSummary.deliveryCost.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.deliveryCost.value | string | The amount 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 order shipping discounts for all of the line items, such as free shipping. Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. 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 used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.deliveryDiscount.value | string | The amount 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 used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.fee.value | string | The amount 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.importCharges | Amount | The sum of all the Global Shipping Program import charges for all the line items. Occurrence: Conditional |
| pricingSummary.importCharges.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.importCharges.value | string | The amount 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.importTax | ImportTax | This container provides the 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.amount | Amount | The total amount of import tax for all line items of an order. Occurrence: Conditional |
| pricingSummary.importTax.amount.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.importTax.amount.value | string | The amount 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.importTax.importTaxType | ImportTaxTypeEnum | This enumeration value indicates the type of import tax applicable to the order. Currently, the only applicable import tax is 'Goods and Services' tax (indicated with GST). 'Goods and Services' tax is only applicable to orders on the eBay Australia marketplace. Occurrence: Conditional |
| pricingSummary.priceDiscount | Amount | The total amount of all the item discounts for all line items, such as Buy 1 Get 1 free. Let's say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount in not included. It is returned in the deliveryDiscount field. Note: This will always be a negative number. Occurrence: Always |
| pricingSummary.priceDiscount.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.priceDiscount.value | string | The amount 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 taking into account the item quantity but before adding in taxes and shipping 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.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.priceSubtotal.value | string | The amount 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 used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.tax.value | string | The amount 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 + priceDiscount + deliveryCost + deliveryDiscounts + tax + additionalSavings + adjustment + fee + importCharges Note: additionalSavings, deliveryDiscounts, and priceDiscount are negative numbers. Occurrence: Always |
| pricingSummary.total.currency | CurrencyCodeEnum | The currency used in the monetary transaction. Generally, this is the currency used by the country of eBay site offering the item. Occurrence: Always |
| pricingSummary.total.value | string | The amount 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 eBay 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 payment method company (brand) image. 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. Occurrence: Always |
| shippingAddress.addressLine1 | string | The first line of the street address where the item is being shipped. Maximum characters:
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'. Maximum characters:
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. Occurrence: Always |
| shippingAddress.county | string | The county of the address where the item is being shipped. Occurrence: Conditional |
| shippingAddress.phoneNumber | string | The 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.postalCode | string | The postal code of the address where the item is being shipped. Note: This is optional when shipping to EBAY_HK - Hong Kong (ebay.com.hk). 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. Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. Occurrence: Always |
| warnings | array of ErrorDetailV3 | An array of any process errors or warnings that were generated during the method processing. Occurrence: Conditional |
| warnings.category | string | This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. Occurrence: Always |
| warnings.domain | string | The name of the primary system where the error occurred. This is relevant for application errors. Occurrence: Always |
| warnings.errorId | integer | A 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: Always |
| warnings.inputRefIds | array of string | An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. Occurrence: Conditional |
| warnings.longMessage | string | A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. Occurrence: Conditional |
| warnings.message | string | A description of the condition that caused the error or warning. Occurrence: Always |
| warnings.outputRefIds | array of string | An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | An 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.name | string | This is the name of input field that caused an issue with the method request. Occurrence: Conditional |
| warnings.parameters.value | string | This is the actual value that was passed in for the element specified in the name field. Occurrence: Conditional |
| warnings.subdomain | string | The 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Access Forbidden |
| 404 | Resource Not Found |
| 409 | Conflict |
| 500 | Internal Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| 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. |
| 15001 | API_ORDER | REQUEST | Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call. |
| 15002 | API_ORDER | REQUEST | Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call. |
| 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 {maxLineItems}) and create a new checkout session. |
| 15021 | API_ORDER | BUSINESS | This checkout session cannot be updated because the order has already been placed. |
| 15025 | API_ORDER | REQUEST | The App is not authorized to access this resource. |
| 15026 | API_ORDER | BUSINESS | The item is not shippable to the specified shipping address. |
| 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}. |
| 15047 | API_ORDER | BUSINESS | In compliance with applicable economic sanctions and trade restrictions, eBay is unavailable in your location. If you believe you are receiving this notice in error, please contact eBay's Customer Service. |
| 15048 | API_ORDER | REQUEST | The value of {fieldName} is too long. For more information, see the documentation for this call. |
| 17002 | API_ORDER | REQUEST | Invalid character(s) found in the shipping address. Please check name and shipping address fields, remove invalid character(s) and resubmit the call. |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 15007 | API_ORDER | REQUEST | The address provided may be incorrect. You may proceed with this address or provide a correct address. |
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: Update the Shipping Address
This call changes the shipping address. The entire purchase order is shipped to only one address but it can be different than the address of the buyer.
Input
The inputs are checkoutSessionId as a URI parameter and the name of the recipient and their address in the payload.
POST
https://apix.ebay.com/buy/order/v1/proxy_guest_checkout_session/v1|5********7|6********y/update_shipping_address
Output
The output contains the checkout session information. You can verify that the address has been updated by checking the shippingUserAddress container.