POST/checkout_session/{checkoutSessionId}/remove_coupon
(Limited Release) You must be whitelisted to use this method.
This method removes a coupon from an eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required.
Restrictions
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the apix.ebay.com root URI with apix.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| checkoutSessionId | string | This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace. This value 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.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
| X-EBAY-C-ENDUSERCTX | string | This header is used to specify the deviceId for the device/user attempting to make the call. It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user. Occurrence: Conditional |
| X-EBAY-C-MARKETPLACE-ID | string | This header identifies the eBay marketplace where the order will occur. Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created. See HTTP request headers for the marketplace ID values. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code 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.order
eBayUser
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| redemptionCode | string | The redemption code of the coupon. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| 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. Credit card is the only accepted payment method for Order v1. Therefore, this value will always be 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. 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 of 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.addonServices | array of CheckoutAddonService | An array of add-on services for the line item. Occurrence: Conditional |
| lineItems.addonServices.selected | boolean | Indicates whether the service is selected or not. Occurrence: Conditional |
| lineItems.addonServices.serviceFee | Amount | The container that returns the amount and currency of the fee for an add-on service. Occurrence: Conditional |
| lineItems.addonServices.serviceFee.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.addonServices.serviceFee.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.addonServices.serviceId | string | The ID of the add-on service. Occurrence: Conditional |
| lineItems.addonServices.serviceTax | Amount | The container that returns the amount and currency of the sales tax applied against the add-on service fee. This tax is based on the state or territory in which the buyer is located. Occurrence: Conditional |
| lineItems.addonServices.serviceTax.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.addonServices.serviceTax.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.addonServices.serviceType | ServiceTypeEnum | The type of add-on service, such as AUTHENTICITY_GUARANTEE. Occurrence: Conditional |
| 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. 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 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. 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.importDuties | Amount | The total amount of import duties for this line item, which is paid by the buyer when checking out. Occurrence: Conditional |
| lineItems.importDuties.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.importDuties.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.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. 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. 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. 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. Occurrence: Always |
| lineItems.promotions.promotionType | string | Indicates the kind of promotion. Some examples are: 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.
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. 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.ebayShipping | boolean | This indicates the shipping cost of the authenticated item. The cost of the shipping will be paid to eBay. Occurrence: Conditional |
| lineItems.shippingOptions.importCharges | Amount | The Global Shipping Program import charges for 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. 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.
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 |
| 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.addonServicesFee | Amount | The total amount of fees for all add-on services among all line items. If the checkout session does not include any add-on services, this value is returned as zero. Occurrence: Conditional |
| pricingSummary.addonServicesFee.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.addonServicesFee.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. 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. 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.importDuties | Amount | The total amount of import duties for all line items, which is paid by the buyer when checking out. Occurrence: Conditional |
| pricingSummary.importDuties.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.importDuties.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 import tax is Goods and Services Tax (indicated by Occurrence: Conditional |
| pricingSummary.priceDiscount | Amount | The total amount of all the item discounts for all line items, such as Buy 1 Get 1 free. 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. 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. 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 | This field is deprecated. 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 where the purchase order will be shipped. 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. 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. 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 |
| taxDetails | array of TaxDetails | Detailed tax information for items included in this order. Occurrence: Conditional |
| taxDetails.amount | Amount | A container for the currency type and monetary amount of the tax item. Occurrence: Conditional |
| taxDetails.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 |
| taxDetails.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 |
| taxDetails.taxClassification | TaxClassificationEnum | Specifies what the tax item pertains to, such as a tangible object ( Occurrence: Conditional |
| taxDetails.taxClassificationDetails | array of TaxClassificationDetail | Provides a detailed accounting, by Occurrence: Conditional |
| taxDetails.taxClassificationDetails.amount | Amount | A container for the currency type and monetary amount of the tax collected for an item. Occurrence: Conditional |
| taxDetails.taxClassificationDetails.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 |
| taxDetails.taxClassificationDetails.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 |
| taxDetails.taxClassificationDetails.taxType | TaxType | Indicates the type of tax that has been collected for the item. Occurrence: Conditional |
| 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue. |
| 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. |
| 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}. |
| 16025 | API_ORDER | REQUEST | The coupon was not applied to this cart. |
Warnings
This call has no warnings.
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: Removes a Coupon from a Purchase Order
This call removes the coupon from a eBay member purchase order.
Input
The input for this call is the checkoutSessionId and the code of the coupon.
POSThttps://apix.ebay.com/buy/order/v1/checkout_session/1*************5/remove_coupon
Output
This call returns the details of the purchase order. This includes the appliedCoupons, promotions, and additionalSavings fields that contain information specific to the coupon.