Skip to main content

POST/guest_checkout_session/{checkoutSessionId}/update_shipping_address

Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

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

This method changes the shipping address for the order in an eBay 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.

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}/update_shipping_address
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_address

Input

Resource URI (production)

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

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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

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.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
addressLine1string

The 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: Required

addressLine2string

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:

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

Occurrence: Optional

citystring

The city of the address where the item is being shipped.

Occurrence: Required

countryCountryCodeEnum

The two letter code representing the country of the address.

Occurrence: Required

countystring

The county of the address where the item is being shipped.

Occurrence: Optional

phoneNumberstring

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

postalCodestring

The postal code of the address where the item is being shipped.

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

Occurrence: Conditional

recipientRecipient

The name of the person receiving the package.

Occurrence: Required

recipient.firstNamestring

The first name of the person receiving the purchase order.

Occurrence: Required

recipient.lastNamestring

The last name of the person receiving the purchase order.

Occurrence: Required

stateOrProvincestring

The 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

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* GuestCheckoutSessionResponseV2 */
"lineItems" : [
{ /* LineItem */
"image" :
{ /* Image */ },
"itemId" : "string",
"seller" :
{ /* Seller */ },
}
],
}

Response fields

Output container/fieldTypeDescription
appliedCouponsarray of Coupon

A container that returns the information for the coupons that were applied in the guest checkout session.

Occurrence: Conditional

appliedCoupons.redemptionCodestring

The coupon redemption code.

Occurrence: Always

checkoutSessionIdstring

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

Occurrence: Always

lineItemsarray of LineItem

An array of line items associated with the guest checkout session.

Occurrence: Always

lineItems.authenticityVerificationAuthenticityVerificationProgram

A 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.descriptionstring

An informational message that applies to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.authenticityVerification.outcomeReasonstring

An 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.statusAuthenticityVerificationStatusEnum

An 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.termsWebUrlstring

The terms and conditions that apply to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.baseUnitPriceAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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 Fee

A breakdown of the fees applicable to the line item.

Occurrence: Conditional

lineItems.fees.amountAmount

A container for the currency type and monetary amount of the fee associated with the line item.

Occurrence: Conditional

lineItems.fees.amount.currencyCurrencyCodeEnum

The 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.valuestring

The 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.feeTypeFeeEnum

The type of fee associated with the line item.

Occurrence: Conditional

lineItems.imageImage

An eBay-assigned URL of the item image.

Occurrence: Always

lineItems.image.imageUrlstring

The URL for the image.

Occurrence: Always

lineItems.itemIdstring

The 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.lineItemIdstring

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

Occurrence: Always

lineItems.netPriceAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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 Promotion

An array of promotions applied to the line item.

Occurrence: Conditional

lineItems.promotions.discountAmount

The details regarding the monetary value of the promotional discount.

Note: eBay Bucks are not supported.

Occurrence: Conditional

lineItems.promotions.discount.currencyCurrencyCodeEnum

The 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.valuestring

The 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.messagestring

The text for the promotion title, which describes the promotion.

Occurrence: Conditional

lineItems.promotions.promotionTypestring

The kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.

Occurrence: Conditional

lineItems.quantityinteger

The quantity ordered for the line item.

Occurrence: Always

lineItems.sellerSeller

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

Occurrence: Always

lineItems.seller.usernamestring

The user name created by the seller for use on eBay.

Occurrence: Always

lineItems.shippingOptionsarray of ShippingOption

An 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.baseDeliveryCostAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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.deliveryDiscountAmount

The monetary value of any delivery discounts.

Occurrence: Always

lineItems.shippingOptions.deliveryDiscount.currencyCurrencyCodeEnum

The 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.valuestring

The 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.importChargesAmount

The Global Shipping Program import charges for this line item.

Occurrence: Conditional

lineItems.shippingOptions.importCharges.currencyCurrencyCodeEnum

The 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.valuestring

The 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.maxEstimatedDeliveryDatestring

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

Occurrence: Conditional

lineItems.shippingOptions.minEstimatedDeliveryDatestring

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

Occurrence: Conditional

lineItems.shippingOptions.selectedboolean

A field that indicates whether the shipping method is selected.

Occurrence: Always

lineItems.shippingOptions.shippingCarrierCodestring

The shipping provider for the line item, such as FedEx or USPS.

Occurrence: Always

lineItems.shippingOptions.shippingOptionIdstring

A unique ID for the selected shipping option/method.

Occurrence: Always

lineItems.shippingOptions.shippingServiceCodestring

The 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 TaxDetail

A container that returns the tax information for the line item.

Occurrence: Conditional

lineItems.taxDetails.includedInPriceboolean

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

Occurrence: Conditional

lineItems.taxDetails.taxJurisdictionTaxJurisdiction

A container that returns the tax jurisdiction information.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.regionRegion

The region of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.region.regionNamestring

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.regionTypeRegionTypeEnum

An enumeration value that indicates the type of region for the tax jurisdiction.

Valid Values:

  • STATE_OR_PROVINCE
  • COUNTRY

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.taxJurisdictionIdstring

The identifier of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxTypeTaxType

A field that indicates the type of tax that may be collected for the item.

Occurrence: Conditional

lineItems.titlestring

The seller-created title of the item.

Occurrence: Always

pricingSummaryPricingSummaryV2

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

Occurrence: Always

pricingSummary.additionalSavingsAmount

The total amount of the coupon discounts in the purchase order.

Occurrence: Conditional

pricingSummary.additionalSavings.currencyCurrencyCodeEnum

The 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.valuestring

The 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.adjustmentAdjustment

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.amountAmount

The container that returns the amount and currency of an adjustment.

Occurrence: Always

pricingSummary.adjustment.amount.currencyCurrencyCodeEnum

The 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.valuestring

The 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.labelstring

The text indicating what the adjustment was for.

Occurrence: Always

pricingSummary.deliveryCostAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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.feeAmount

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

Occurrence: Always

pricingSummary.fee.currencyCurrencyCodeEnum

The 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.valuestring

The 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.importChargesImportChargesV2

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

Occurrence: Conditional

pricingSummary.importCharges.amountAmount

The amount of the import charge.

Occurrence: Conditional

pricingSummary.importCharges.amount.currencyCurrencyCodeEnum

The 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.amount.valuestring

The 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.importCharges.applicableChargeTypeApplicableChargeTypeEnum

The type of charge to apply to the order, such as import duties.

Occurrence: Conditional

pricingSummary.importTaxImportTax

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.amountAmount

The total amount of import tax for all line items of an order.

Occurrence: Conditional

pricingSummary.importTax.amount.currencyCurrencyCodeEnum

The 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.valuestring

The 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.importTaxTypeImportTaxTypeEnum

An 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.priceDiscountAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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.priceSubtotalAmount

The 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.currencyCurrencyCodeEnum

The 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.valuestring

The 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.taxAmount

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

Occurrence: Always

pricingSummary.tax.currencyCurrencyCodeEnum

The 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.valuestring

The 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.totalAmount

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

Occurrence: Always

pricingSummary.total.currencyCurrencyCodeEnum

The 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.valuestring

The 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

shippingAddressShippingAddress

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

Occurrence: Always

shippingAddress.addressLine1string

The 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.addressLine2string

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:

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

Occurrence: Conditional

shippingAddress.citystring

The city of the address where the item is being shipped.

Occurrence: Always

shippingAddress.countryCountryCodeEnum

The two letter code representing the country of the address.

Occurrence: Always

shippingAddress.countystring

The county of the address where the item is being shipped.

Occurrence: Conditional

shippingAddress.phoneNumberstring

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.postalCodestring

The 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.recipientRecipient

The name of the person receiving the package.

Occurrence: Always

shippingAddress.recipient.firstNamestring

The first name of the person receiving the purchase order.

Occurrence: Conditional

shippingAddress.recipient.lastNamestring

The last name of the person receiving the purchase order.

Occurrence: Conditional

shippingAddress.stateOrProvincestring

The 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 ErrorDetailV3

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

Occurrence: Conditional

warnings.categorystring

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

Occurrence: Conditional

warnings.domainstring

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

Occurrence: Conditional

warnings.errorIdinteger

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: Conditional

warnings.inputRefIdsarray 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.longMessagestring

A 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.messagestring

A description of the condition that caused the error or warning.

Occurrence: Conditional

warnings.outputRefIdsarray 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.parametersarray 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.namestring

The name of the input field that caused an issue with the method request.

Occurrence: Conditional

warnings.parameters.valuestring

The actual value that was passed in for the element specified in the name field.

Occurrence: Conditional

warnings.subdomainstring

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.

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.
15001API_ORDERREQUESTMissing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.
15002API_ORDERREQUESTInvalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.
15003API_ORDERREQUESTThe checkout session requested does not exist.
15019API_ORDERBUSINESSTo 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.
15021API_ORDERBUSINESSThis checkout session cannot be updated because the order has already been placed.
15025API_ORDERREQUESTThe App is not authorized to access this resource.
15026API_ORDERBUSINESSThe item is not shippable to the specified shipping address.
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}.
15032API_ORDERREQUESTAfter using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call.
15047API_ORDERBUSINESSIn 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.
15048API_ORDERREQUESTThe value of {fieldName} is too long. For more information, see the documentation for this call.
17002API_ORDERREQUESTInvalid 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.

CodeDomainCategoryMeaning
15007API_ORDERREQUESTThe 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, along with the name of the recipient and their address in the payload.

POSThttps://apix.ebay.com/buy/order/v2/guest_checkout_session/1********1/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.