getPurchaseOrder

The container that returns the information for the coupons that were applied in the order.

Note: This container is not returned for the getPurchaseOrder and getGuestPurchaseOrder methods.

Occurrence: Conditional

The redemption code of the coupon. Note: There can be only one redemption code per order.

Occurrence: Conditional

An array of line items in the purchase order.

Occurrence: Always

An array of add-on services that apply to the order line item.

Occurrence: Conditional

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

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

An enumerated value that defines the type of add-on service.

Occurrence: Conditional

This container is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program 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.

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The type of fee associated with the line item.

Occurrence: Conditional

The URL of the item's image.

Occurrence: Always

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

The identifier of the item.

Occurrence: Always

When this value is true it indicates that the item has been put on hold due to a violation of eBay Policy.

Occurrence: Conditional

The container that returns fields to support using the Post Order API for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see Using the Post Order API.

Occurrence: Conditional

The legacy ID used to identify an item.

This is used by the Post Order API Create Return Request method. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Create a return request in the Buy Integration Guide.

Occurrence: Conditional

The legacy ID of the order.

This is used by the Post Order API Submit Cancellation Request method. This method initiates the item cancellation process. For more information on how to use this field in the Post Order API, see Using the Post Order API.

Occurrence: Conditional

The legacy ID of the transaction.

This is used by the Post Order API Create Return Request call. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Using the Post Order API in the Buy Integration Guide.

Occurrence: Conditional

The identifier of this line item. This is created by the initiateCheckoutSession for a member and initiateGuestCheckoutSession for a guest calls.

Occurrence: Conditional

An enumeration value that indicates the payment status of this line item.

Occurrence: Always

An enumeration value that indicates the fulfillment state of this line item.

Note: When there is no tracking information, this status will never change from FULFILLMENT_IN_PROGRESS because without tracking information eBay has no way of knowing if the order was delivered.

Occurrence: Conditional

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, or seller adjustments.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The unique order ID for this line item.

Maximum Length: 40 characters

Occurrence: Conditional

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

Occurrence: Conditional

The discount amount on the applied promotional offer.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

Note: This field is not return in the purchase order methods response.

Occurrence: Conditional

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

Occurrence: Conditional

An identifier of the promotion that was generated by the system when the promotion was created.

Note: No data is returned in this field for the getPurchaseOrder and getGuestPurchaseOrder methods.

Occurrence: Conditional

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

Occurrence: Conditional

The number of individual items in this line item.

Occurrence: Always

The container for information about the seller offering this item, such as the seller's user name.

Occurrence: Always

The percentage of the total 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: Conditional

Information about the shipping provider used for this line item.

Occurrence: Conditional

This indicates the shipping cost of the authenticated item, which the buyer paid to eBay.

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

The payment method used for the purchase order.

Occurrence: Always

The name of the credit card company (brand).

Occurrence: Conditional

The URL of the image of the credit card company (brand).

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

The URL of the image.

Occurrence: Conditional

Reserved for future use.

Occurrence: Conditional

An enumeration value that indicates the credit card company (brand).

Occurrence: Conditional

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

Occurrence: Conditional

The container that returns the monetary details of the order.

Occurrence: Always

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

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The total fee for add-on services among all line items.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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 purchase order that are not already captured in one of the other fields.

Occurrence: Conditional

The container for the amount and currency of the adjustment.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

Text that describes the adjustment.

Occurrence: Conditional

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

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

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

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

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

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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 is not included. It is returned in the deliveryDiscount field.

Note: This will always be a negative number.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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: This price does not include the value-added tax (VAT) collected in applicable jurisdictions. For more information on VAT, refer to VAT Obligations in the EU.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

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

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The total of the purchase order.

total = priceSubtotal + baseDeliveryCost + tax + importCharges + deliveryDiscounts + priceDiscount + adjustment.

Note: deliveryDiscounts and priceDiscount are negative numbers.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The timestamp of when the purchase order was created.

Occurrence: Always

The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the placeOrder method.

Occurrence: Always

An enumeration value that indicates the status of the payment for the purchase order.

Occurrence: Always

The container for the current status of the buyer's payment and any refund that applies to the purchase order.

Occurrence: Always

The URL to the Order Details page on eBay.

Occurrence: Conditional

The total amount of any refunds for purchase order.

Occurrence: Conditional

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

The shipping address for the purchase order.

Occurrence: Always

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

Occurrence: Conditional

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

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

Occurrence: Conditional

The two letter code representing the country of the address.

Occurrence: Conditional

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

Occurrence: Conditional

The phone number of the person receiving the package.

Occurrence: Conditional

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

Occurrence: Conditional

Name of the person receiving the package.

Occurrence: Conditional

The state or province of the address where the item is being shipped.

Occurrence: Conditional

An array of the shipping providers and the purchase order delivery details.

Occurrence: Conditional

The date the purchase order was delivered.

Occurrence: Conditional

The container the returns the fields for the line item ID and the quantity.

Occurrence: Conditional

A unique eBay-assigned ID value to identify the line item in a purchase order.

Occurrence: Always

The number of individual items ordered for this line item, as specified by the buyer.

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

The container that returns all the shipment tracking events.

Occurrence: Conditional

A string describing the tracking event.

For example: On FedEx vehicle for delivery

Occurrence: Conditional

The date of the shipment tracking event.

UTC Format: yyyy-MM-ddThh:00:00.000Z

For example: 2019-03-01T12:12:00.000Z

Occurrence: Conditional

A normalized string for shipment tracking event.

For example: OUT_FOR_DELIVERY

Occurrence: Conditional

Where the shipment tracking event occurred.

For example: The city, state, postal code, and country of where the package was delivered.

Occurrence: Conditional

The city where the tracking event occurred.

Occurrence: Conditional

The two letter code representing the country of the address where the tracking event occurred.

Occurrence: Conditional

The county where the tracking event occurred.

Occurrence: Conditional

The postal code where the tracking event occurred.

Occurrence: Conditional

The state where the tracking event occurred.

Occurrence: Conditional

The shipping provider number associated with the purchase order that can be used to track the package.

Occurrence: Conditional

The URL of the shipping provider's shipment tracking page.

Occurrence: Conditional

The date the seller gave the purchase order to the shipping provider.

Occurrence: Conditional

A name of the shipping provider, such as FedEx, or USPS.

Occurrence: Conditional

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

Occurrence: Conditional

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

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

A three letter ISO 4217 code specifying the currency of the monetary amount.

Occurrence: Always

The monetary amount.

Occurrence: Always

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

Occurrence: Conditional

An array of warning messages. These type of errors do not prevent the call from executing but should be checked.

Occurrence: Conditional

Identifies the type of error.

Occurrence: Always

Name for the primary system where the error occurred. This is relevant for application errors.

Occurrence: Always

A unique number to identify the error.

Occurrence: Always

An array of request elements most closely associated to the error.

Occurrence: Conditional

A more detailed explanation of the error.

Occurrence: Conditional

Information on how to correct the problem, in the end user's terms and language where applicable.

Occurrence: Always

An array of request elements most closely associated to the error.

Occurrence: Conditional

An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.

Occurrence: Conditional

The object of the error.

Occurrence: Conditional

The value of the object.

Occurrence: Conditional

Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.

Occurrence: NA