This method retrieves the details about a specific eBay member purchase order. It returns the line items, including purchase order status; dates created and modified; item quantity and listing data; payment and shipping information; and prices, taxes, and discounts and credits.
The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload.
The placeOrder method initiates the payment process, which can sometimes take a few minutes. You can use this method to not only get the details of a purchase order but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID.
This method also returns the legacyItemId, legacyTransactionId, and legacyOrderId fields. The values in these fields enable eBay partners to use the Post Order API for eBay member checkouts, to process a return or cancellation. For more information, see Post order tasks in the Buy Integration Guide.
Restrictions
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| purchaseOrderId | string | The unique identifier of a purchase order made by an eBay member, for which details are to be retrieved. This value is returned by the placeOrder method in the purchaseOrderId field. The purchaseOrderId is passed in as a URI parameter and is required. Occurrence: Required |
HTTP request headers
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.readonly
https://api.ebay.com/oauth/api_scope/buy.order
See OAuth access tokens for more information.
Output
| Output container/field | Type | Description |
|---|---|---|
| appliedCoupons | array of Coupon | The container that returns the information for the coupons that were applied in the order. Occurrence: Conditional |
| appliedCoupons.redemptionCode | string | The redemption code of the coupon. Note: There can be only one redemption code per order. Occurrence: Conditional |
| lineItems | array of OrderLineItem | An array of line items in the purchase order. Occurrence: Always |
| lineItems.baseUnitPrice | Amount | The cost of a single item in this line item. Occurrence: Always |
| lineItems.baseUnitPrice.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| lineItems.baseUnitPrice.value | string | The monetary amount. Occurrence: Always |
| lineItems.image | Image | The URL of the item's image. Occurrence: Always |
| lineItems.image.height | integer | Reserved for future use. Occurrence: Conditional |
| lineItems.image.imageUrl | string | The URL of the image. Occurrence: Conditional |
| lineItems.image.width | integer | Reserved for future use. Occurrence: Conditional |
| lineItems.itemId | string | The identifier of the item. Occurrence: Always |
| lineItems.legacyReference | LegacyReference | 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. Note: The Post Order API can be used only with eBay member checkouts. Occurrence: Conditional |
| lineItems.legacyReference.legacyItemId | string | 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. Restriction: The Post Order API can be used only with eBay member checkouts. Occurrence: Conditional |
| lineItems.legacyReference.legacyOrderId | string | 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. Restriction: The Post Order API can be used only with eBay member checkouts. Occurrence: Conditional |
| lineItems.legacyReference.legacyTransactionId | string | 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. Restriction: The Post Order API can be used only with eBay member checkouts. Occurrence: Conditional |
| lineItems.lineItemId | string | The identifier of this line item. This is created by the initiateCheckoutSession for a member and initiateGuestCheckoutSession for a guest calls. Occurrence: Conditional |
| lineItems.lineItemPaymentStatus | LineItemPaymentStatusEnum | An enumeration value that indicates the payment status of this line item. Occurrence: Always |
| lineItems.lineItemStatus | LineItemStatusEnum | An enumeration value that indicates the fulfillment state of this line item. Occurrence: Conditional |
| lineItems.netPrice | Amount | The total cost for the items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1, and any coupon that applies to this item. Note : This does not include any shipping discounts, shipping costs, or seller adjustments. Occurrence: Conditional |
| lineItems.netPrice.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| lineItems.netPrice.value | string | The monetary amount. Occurrence: Always |
| lineItems.orderId | string | For future use. The unique order ID for this line item. This value is the new eBay unique order ID, which is being rolled out starting in Summer 2019. In the future, this will replace the lineItems.legacyReference fields you use in the Post Order API. For details see, Easier order management with updated order numbers. Occurrence: Conditional |
| lineItems.promotions | array of Promotion | An array of promotions applied to the items in this line item. Occurrence: Conditional |
| lineItems.promotions.discount | Amount | The discount amount on the applied promotional offer. Occurrence: Conditional |
| lineItems.promotions.discount.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| lineItems.promotions.discount.value | string | The monetary amount. Occurrence: Always |
| lineItems.promotions.discountPercentage | string | Note: This field is not return in the purchase order methods response. Occurrence: Conditional |
| lineItems.promotions.message | string | The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1. Occurrence: Conditional |
| lineItems.promotions.promotionCode | string | An identifier of the promotion that was generated by the system when the promotion was created. Occurrence: Conditional |
| lineItems.promotions.promotionType | string | Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON. Occurrence: Conditional |
| lineItems.quantity | integer | The number of individual items in this line item. Occurrence: Always |
| lineItems.seller | Seller | The container for information about the seller offering this item, such as the seller's user name. Occurrence: Always |
| lineItems.seller.feedbackPercentage | string | The percentage of the total positive feedback. Occurrence: Always |
| lineItems.seller.feedbackScore | integer | The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. Occurrence: Always |
| lineItems.seller.sellerAccountType | string | Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries. This field is returned only on the following sites. EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL Valid values:
Occurrence: Conditional |
| lineItems.seller.username | string | The user name created by the seller for use on eBay. Occurrence: Conditional |
| lineItems.shippingDetail | ShippingDetail | Information about the shipping provider used for this line item. Occurrence: Conditional |
| lineItems.shippingDetail.maxEstimatedDeliveryDate | string | The end of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). Occurrence: Conditional |
| lineItems.shippingDetail.minEstimatedDeliveryDate | string | The beginning of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). Occurrence: Conditional |
| lineItems.shippingDetail.shippingCarrierCode | string | The shipping provider, such as FedEx, or USPS for the line item. Occurrence: Conditional |
| lineItems.shippingDetail.shippingServiceCode | string | A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). Occurrence: Conditional |
| lineItems.title | string | The seller created title of the item. Occurrence: Conditional |
| paymentInstrument | PaymentInstrument | The payment method used for the purchase order. Occurrence: Always |
| paymentInstrument.brand | PaymentMethodBrand | The name of the credit card company (brand). Occurrence: Conditional |
| paymentInstrument.brand.logoImage | Image | The URL of the image of the credit card company (brand). Occurrence: Conditional |
| paymentInstrument.brand.logoImage.height | integer | Reserved for future use. Occurrence: Conditional |
| paymentInstrument.brand.logoImage.imageUrl | string | The URL of the image. Occurrence: Conditional |
| paymentInstrument.brand.logoImage.width | integer | Reserved for future use. Occurrence: Conditional |
| paymentInstrument.brand.paymentMethodBrandType | PaymentMethodBrandEnum | An enumeration value that indicates the credit card company (brand). Occurrence: Conditional |
| paymentInstrument.paymentMethodType | PaymentMethodTypeEnum | An enumeration value that indicates the method of payment, such as credit card. Occurrence: Conditional |
| pricingSummary | PricingSummary | The container that returns the monetary details of the order. Occurrence: Always |
| pricingSummary.additionalSavings | Amount | The total amount of the coupon discounts in the purchase order. Occurrence: Conditional |
| pricingSummary.additionalSavings.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.additionalSavings.value | string | The monetary amount. 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 purchase order that are not already captured in one of the other fields. Occurrence: Conditional |
| pricingSummary.adjustment.amount | Amount | The container for the amount and currency of the adjustment. Occurrence: Conditional |
| pricingSummary.adjustment.amount.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.adjustment.amount.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.adjustment.label | string | Text that describes the adjustment. Occurrence: Conditional |
| pricingSummary.deliveryCost | Amount | The shipping cost for all the line items before any shipping discounts are applied. Let's say there were 4 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 $20, which is the total cost for shipping all the line items before any discounts were appiled. Occurrence: Conditional |
| pricingSummary.deliveryCost.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.deliveryCost.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.deliveryDiscount | Amount | The total amount of the order shipping discounts for the all line items, such as free shipping. Let's say there were 4 line items and the shipping cost for each line items 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 |
| pricingSummary.deliveryDiscount.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.deliveryDiscount.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.fee | Amount | The total amount of any fees for all the line items, such as a recycling fee. Occurrence: Conditional |
| pricingSummary.fee.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.fee.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.importCharges | Amount | The sum of the Global Shipping Program import charges for all line items. Occurrence: Conditional |
| pricingSummary.importCharges.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.importCharges.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.priceDiscount | Amount | The total amount of all the item discounts for all line items, such as Buy 1 Get 1 free. Let's say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount is not included. It is returned in the deliveryDiscount field. Note: This will always be a negative number. Occurrence: Conditional |
| pricingSummary.priceDiscount.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.priceDiscount.value | string | The monetary amount. 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: Conditional |
| pricingSummary.priceSubtotal.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.priceSubtotal.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.tax | Amount | The total amount of the taxes for all the line items. Occurrence: Conditional |
| pricingSummary.tax.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.tax.value | string | The monetary amount. Occurrence: Always |
| pricingSummary.total | Amount | The total of the purchase order. total = priceSubtotal + baseDeliveryCost + tax + importCharges + deliveryDiscounts + priceDiscount + adjustment. Note: deliveryDiscounts and priceDiscount are negative numbers. Occurrence: Conditional |
| pricingSummary.total.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| pricingSummary.total.value | string | The monetary amount. Occurrence: Always |
| purchaseOrderCreationDate | string | The timestamp of when the purchase order was created. Occurrence: Always |
| purchaseOrderId | string | The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the place order guest methods. Occurrence: Always |
| purchaseOrderPaymentStatus | PurchaseOrderPaymentStatusEnum | An enumeration value that indicates the status of the payment for the purchase order. Occurrence: Always |
| purchaseOrderStatus | PurchaseOrderStatusEnum | The container for the current status of the buyer's payment and any refund that applies to the purchase order. Occurrence: Always |
| refundedAmount | Amount | The total amount of any refunds for purchase order. Occurrence: Conditional |
| refundedAmount.currency | CurrencyCodeEnum | A three letter ISO 4217 code specifying the currency of the monetary amount. Occurrence: Always |
| refundedAmount.value | string | The monetary amount. Occurrence: Always |
| shippingAddress | ShippingAddress | The shipping address for the purchase order. Occurrence: Always |
| shippingAddress.addressLine1 | string | The first line of the street address where the item is being shipped. Occurrence: Conditional |
| 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: Conditional |
| shippingAddress.country | CountryCodeEnum | The two letter code representing the country of the address. Occurrence: Conditional |
| 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: Conditional |
| shippingAddress.postalCode | string | The postal code of the address where the item is being shipped. Occurrence: Conditional |
| shippingAddress.recipient | string | Name of the person receiving the package. Occurrence: Conditional |
| shippingAddress.stateOrProvince | string | The state or province of the address where the item is being shipped. Occurrence: Conditional |
| shippingFulfillments | array of ShippingFulfillment | An array of the shipping providers and the purchase order delivery details. Occurrence: Conditional |
| shippingFulfillments.actualDeliveryDate | string | The date the purchase order was delivered. Occurrence: Conditional |
| shippingFulfillments.lineItemReferences | array of LineItemReference | The container the returns the fields for the line item ID and the quantity. Occurrence: Conditional |
| shippingFulfillments.lineItemReferences.lineItemId | string | A unique eBay-assigned ID value to identify the line item in a purchase order. Occurrence: Always |
| shippingFulfillments.lineItemReferences.quantity | integer | The number of individual items ordered for this line item, as specified by the buyer. Occurrence: Always |
| shippingFulfillments.maxEstimatedDeliveryDate | string | The end of the date range in which the purchase order is expected to be delivered to the shipping address. Occurrence: Conditional |
| shippingFulfillments.minEstimatedDeliveryDate | string | The beginning of the date range in which the purchase order is expected to be delivered to the shipping address. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents | array of ShipmentTrackingEvents | The container that returns all the shipment tracking events. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.description | string | A string describing the tracking event. For example: On FedEx vehicle for delivery Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.eventDate | string | 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 |
| shippingFulfillments.shipmentTrackingEvents.eventType | string | A normalized string for shipment tracking event. For example: OUT_FOR_DELIVERY Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location | EventLocation | Where the shipment tracking event occurred. For example: The city, state, postal code, and country of where the package was delivered. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location.city | string | The city where the tracking event occurred. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location.country | CountryCodeEnum | The two letter code representing the country of the address where the tracking event occurred. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location.county | string | The county where the tracking event occurred. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location.postalCode | string | The postal code where the tracking event occurred. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingEvents.location.stateOrProvince | string | The state where the tracking event occurred. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingNumber | string | The shipping provider number associated with the purchase order that can be used to track the package. Occurrence: Conditional |
| shippingFulfillments.shipmentTrackingUrl | string | The URL of the shipping provider's shipment tracking page. Occurrence: Conditional |
| shippingFulfillments.shippedDate | string | The date the seller gave the purchase order to the shipping provider. Occurrence: Conditional |
| shippingFulfillments.shippingCarrierCode | string | A name of the shipping provider, such as FedEx, or USPS. Occurrence: Conditional |
| shippingFulfillments.shippingServiceCode | string | A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). Occurrence: Conditional |
| warnings | array of ErrorDetailV3 | An array of warning messages. These type of errors do not prevent the call from executing but should be checked. Occurrence: Conditional |
| warnings.category | string | Identifies the type of error. Occurrence: Always |
| warnings.domain | string | Name for the primary system where the error occurred. This is relevant for application errors. Occurrence: Always |
| warnings.errorId | integer | A unique number to identify the error. Occurrence: Always |
| warnings.inputRefIds | array of string | An array of request elements most closely associated to the error. Occurrence: Conditional |
| warnings.longMessage | string | A more detailed explanation of the error. Occurrence: Conditional |
| warnings.message | string | Information on how to correct the problem, in the end user's terms and language where applicable. Occurrence: Always |
| warnings.outputRefIds | array of string | An array of request elements most closely associated to the error. Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. Occurrence: Conditional |
| warnings.parameters.name | string | The object of the error. Occurrence: Conditional |
| warnings.parameters.value | string | The value of the object. Occurrence: Conditional |
| warnings.subdomain | string | Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. 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 |
| 403 | Access Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 16001 | API_ORDER | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 16002 | API_ORDER | REQUEST | The purchase order ID was not found. |
| 16003 | API_ORDER | REQUEST | Access to the purchase order is not authorized. |
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: Get the Details of an eBay Member Purchase Order
Input
Output
PAID)
using a credit card (paymentInstrument.paymentMethodType = CREDIT_CARD).
You can also see that the item has been delivered to the buyer
(purchaseOrderStatus = DELIVERED) and view all the stages of the fulfillment in the
shippingFulfillments.shipmentTrackingEvents container.
Sample 2: Get the Details of an eBay Member Purchase Order that has Discounts
Input
Output
The output shows that the specified purchase order contained two line items and a seller discount and a coupon was applied to each line item. The following tables explain the details of the costs and discounts for these line items.
| Â Â Â |
| ||||||||||||||||||||||||||||||||||||