applyCoupon

The container that returns the payment methods that can be used to purchase the items.

Occurrence: Always

Text indicating the payment type. Credit card is the only accepted payment method for Order v1. Therefore, this value will always be CC.

Occurrence: Always

The URL of the image of the payment method logo.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

An array of credit card brands that can be used as the payment method.

Occurrence: Always

The URL of the payment method company (brand) image.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

An enumeration value that indicates the payment method company, such as Visa.

Occurrence: Always

The type that defines the fields for legal messages and buyer consent verification.

Occurrence: Conditional

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

Reserved for future use.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

An enumeration value that indicates the method of payment, such as credit card.

Occurrence: Always

The container that returns the information of the coupons that were applied in the checkout session.

Occurrence: Conditional

The coupon redemption code.

Occurrence: Always

The checkoutSessionId submitted in the request.

Occurrence: Always

The time the checkout session will end. To purchase the items the order must be placed before this time.

Occurrence: Always

An array of line items associated with the checkout session.

Occurrence: Always

An array of add-on services for the line item.

Occurrence: Conditional

Indicates whether the service is selected or not.

Occurrence: Conditional

The container that returns the amount and currency of the fee for an add-on service.

Occurrence: Conditional

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

Occurrence: Always

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

The ID of the add-on service.

Occurrence: Conditional

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

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

Occurrence: Always

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

The type of add-on service, such as AUTHENTICITY_GUARANTEE.

Occurrence: Conditional

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

An informational message that applies to the Authenticity Guarantee program.

Occurrence: Conditional

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

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

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

Occurrence: Conditional

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

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

Occurrence: Always

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

A breakdown of the fees applicable to the line item.

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Always

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

The type of fee associated with the line item.

Occurrence: Conditional

An eBay-assigned URL of the item image. eBay assigns the URL when the seller uploads the image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

The total amount of import duties for this line item, which is paid by the buyer when checking out.

Note: This is applicable only for eBay International Shipping (eIS) orders, and eIS is only available to sellers on US marketplace.

For GSP orders, the import charges will be shown in the shippingOptions.importCharges container.

Occurrence: Conditional

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

Occurrence: Always

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

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

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

Occurrence: Always

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

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

Occurrence: Always

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

An array of promotions applied to the item of this line item.

Occurrence: Conditional

The container that returns the monetary value of the promotional discount.

Note: eBay Bucks are not supported.

Occurrence: Always

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

Occurrence: Always

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

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

The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1.

Occurrence: Always

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

Occurrence: Always

Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.

Occurrence: Always

The number of individual items ordered for this line item.

Note: If a winning bidder is purchasing an auction item, the value of the this field will be returned as 1.

Occurrence: Always

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

Occurrence: Always

The percentage of the seller's positive feedback.

Occurrence: Always

The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.

Occurrence: Always

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:

• BUSINESS
• INDIVIDUAL

Occurrence: Conditional

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

Occurrence: Always

An array of the shipping methods that are available for the line item. By default, the first one will be selected.

Occurrence: Always

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

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

Occurrence: Always

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

The monetary value of any delivery discount.

Occurrence: Always

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

Occurrence: Always

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

This indicates the shipping cost of the authenticated item. The cost of the shipping will be paid to eBay.

Occurrence: Conditional

The Global Shipping Program import charges for for this line item.

Note: US sellers are transitioning from GSP to eBay International Shipping (eIS), and for any seller already transitioned to eIS, import charges will be shown in the ImportDuties container instead.

Occurrence: Conditional

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

Occurrence: Always

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

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

Occurrence: Conditional

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

Occurrence: Conditional

Indicates if the shipping method is selected.

Occurrence: Always

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

Occurrence: Always

A unique ID for the selected shipping option/method.

Occurrence: Always

A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx).

Occurrence: Always

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

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

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

Occurrence: Conditional

A container that returns the tax jurisdiction information.

Occurrence: Conditional

The region of the tax jurisdiction.

Occurrence: Conditional

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

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

Valid Values:

• STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
• COUNTRY - Indicates the region is a single country.

Occurrence: Conditional

The identifier of the tax jurisdiction.

Occurrence: Conditional

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

Occurrence: Conditional

The seller created title of the item.

Occurrence: Always

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

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

Occurrence: Conditional

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

Occurrence: Always

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

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

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

Occurrence: Always

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

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

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

Occurrence: Always

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

Occurrence: Always

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

Text indicating what the adjustment was for.

Occurrence: Always

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

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

Occurrence: Always

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

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

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

Occurrence: Always

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

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

Occurrence: Always

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

Occurrence: Always

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

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

Note: US sellers are transitioning from GSP to eBay International Shipping (eIS), and for any seller already transitioned to eIS, import charges will be shown in the ImportDuties container instead.

Occurrence: Conditional

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

Occurrence: Always

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

The total amount of import duties for all line items, which is paid by the buyer when checking out.

Note: This is applicable only for eBay International Shipping (eIS) orders, and eIS is only available to sellers on US marketplace.

For GSP orders, the import charges will be shown in the pricingSummary.importCharges container.

Occurrence: Conditional

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

Occurrence: Always

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

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

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

Occurrence: Conditional

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

Occurrence: Always

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

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 GST) which applies only to Australia and New Zealand where GST is charged to buyers outside of these two countries.

Note: Canada also charges a Goods and Services Tax. However, in this case, GST does not represent an import tax, but rather a Federal Sales Tax that is charged on most items sold. ImportTax will not be returned for Canadian sales transactions.

Occurrence: Conditional

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

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

Occurrence: Always

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

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

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

Occurrence: Always

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

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

Occurrence: Always

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

Occurrence: Always

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

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

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

Occurrence: Always

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

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

The container that returns the payment reference, such as last four digits of a credit card.

Occurrence: Conditional

This field is deprecated.

Occurrence: Conditional

The last four digits of the credit card number being used to pay for the items.

Occurrence: Conditional

The container that returns the name and logo of the payment company (brand), such as Visa.

Occurrence: Conditional

The URL of the payment method company (brand) image.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

An enumeration value that indicates the payment method company, such as Visa.

Occurrence: Always

An enumeration value that indicates the method of payment, such as CREDIT_CARD.

Occurrence: Conditional

The container that returns the address where the purchase order will be shipped.

Occurrence: Always

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

Maximum characters:

• AU, CA, & US: 40
• DE & GB: 35
• All other marketplaces: 50

Occurrence: Always

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:

• AU, CA, & US: 40
• DE & GB: 35
• All other marketplaces: 50

Occurrence: Conditional

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

Occurrence: Always

The two letter code representing the country of the address.

Occurrence: Always

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

Occurrence: Conditional

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

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

The name of the person receiving the package.

Occurrence: Always

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

Detailed tax information for items included in this order.

Occurrence: Conditional

A container for the currency type and monetary amount of the tax item.

Occurrence: Conditional

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

Occurrence: Always

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

Specifies what the tax item pertains to, such as a tangible object (ITEM_TAX), a service (SERVICE_TAX), or shipping fees (SHIPPING_TAX).

Occurrence: Conditional

Provides a detailed accounting, by TaxType, of taxes collected for each item within an order.

Occurrence: Conditional

A container for the currency type and monetary amount of the tax collected for an item.

Occurrence: Conditional

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

Occurrence: Always

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

Indicates the type of tax that has been collected for the item.

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Always

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

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

Occurrence: Conditional

A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

Occurrence: Conditional

The name of the subdomain in which the error or warning occurred.

Occurrence: NA