Skip to main content

GET/purchase_order/{purchaseOrderId}

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)

GET https://api.ebay.com/buy/order/v1/purchase_order/{purchaseOrderId}

URI parameters

ParameterTypeDescription
purchaseOrderIdstringThe 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

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* PurchaseOrder */
"lineItems" : [
{ /* OrderLineItem */
"image" :
{ /* Image */ },
"itemId" : "string",
}
],
}

Response fields

Output container/fieldTypeDescription
appliedCouponsarray of Coupon

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

appliedCoupons.redemptionCodestring

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

Occurrence: Conditional

lineItemsarray of OrderLineItem

An array of line items in the purchase order.

Occurrence: Always

lineItems.addonServicesarray of AddonService

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

Occurrence: Conditional

lineItems.addonServices.serviceFeeAmount

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

Occurrence: Conditional

lineItems.addonServices.serviceFee.currencyCurrencyCodeEnum

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

Occurrence: Always

lineItems.addonServices.serviceFee.valuestring

The monetary amount.

Occurrence: Always

lineItems.addonServices.serviceTaxAmount

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

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

Occurrence: Always

lineItems.addonServices.serviceTax.valuestring

The monetary amount.

Occurrence: Always

lineItems.addonServices.serviceTypeServiceTypeEnum

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

Occurrence: Conditional

lineItems.authenticityVerificationAuthenticityVerificationProgram

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

lineItems.authenticityVerification.descriptionstring

An informational message that applies to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.authenticityVerification.outcomeReasonstring

An informational message regarding the authentication outcome of an authenticity verification inspection.
Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program.

Occurrence: Conditional

lineItems.authenticityVerification.statusAuthenticityVerificationStatusEnum

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

lineItems.authenticityVerification.termsWebUrlstring

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

Occurrence: Conditional

lineItems.baseUnitPriceAmount

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

lineItems.baseUnitPrice.currencyCurrencyCodeEnum

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

Occurrence: Always

lineItems.baseUnitPrice.valuestring

The monetary amount.

Occurrence: Always

lineItems.feesarray of Fee

A breakdown of the fees applicable to the line item.

Occurrence: Conditional

lineItems.fees.amountAmount

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

Occurrence: Conditional

lineItems.fees.amount.currencyCurrencyCodeEnum

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

Occurrence: Always

lineItems.fees.amount.valuestring

The monetary amount.

Occurrence: Always

lineItems.fees.feeTypeFeeEnum

The type of fee associated with the line item.

Occurrence: Conditional

lineItems.imageImage

The URL of the item's image.

Occurrence: Always

lineItems.image.heightinteger

Reserved for future use.

Occurrence: Conditional

lineItems.image.imageUrlstring

The URL of the image.

Occurrence: Conditional

lineItems.image.widthinteger

Reserved for future use.

Occurrence: Conditional

lineItems.itemIdstring

The identifier of the item.

Occurrence: Always

lineItems.legacyReferenceLegacyReference

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

lineItems.legacyReference.legacyItemIdstring

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

lineItems.legacyReference.legacyOrderIdstring

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

lineItems.legacyReference.legacyTransactionIdstring

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

lineItems.lineItemIdstring

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

Occurrence: Conditional

lineItems.lineItemPaymentStatusLineItemPaymentStatusEnum

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

Occurrence: Always

lineItems.lineItemStatusLineItemStatusEnum

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

lineItems.netPriceAmount

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

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

Occurrence: Always

lineItems.netPrice.valuestring

The monetary amount.

Occurrence: Always

lineItems.orderIdstring

The unique order ID for this line item.

Maximum Length: 40 characters

Occurrence: Conditional

lineItems.promotionsarray of Promotion

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

Occurrence: Conditional

lineItems.promotions.discountAmount

The discount amount on the applied promotional offer.

Occurrence: Conditional

lineItems.promotions.discount.currencyCurrencyCodeEnum

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

Occurrence: Always

lineItems.promotions.discount.valuestring

The monetary amount.

Occurrence: Always

lineItems.promotions.discountPercentagestring

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

Occurrence: Conditional

lineItems.promotions.messagestring

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

Occurrence: Conditional

lineItems.promotions.promotionCodestring

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

lineItems.promotions.promotionTypestring

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

Occurrence: Conditional

lineItems.quantityinteger

The number of individual items in this line item.

Occurrence: Always

lineItems.sellerSeller

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

Occurrence: Always

lineItems.seller.feedbackPercentagestring

The percentage of the total positive feedback.

Occurrence: Always

lineItems.seller.feedbackScoreinteger

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

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
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

lineItems.seller.usernamestring

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

Occurrence: Conditional

lineItems.shippingDetailShippingDetail

Information about the shipping provider used for this line item.

Occurrence: Conditional

lineItems.shippingDetail.maxEstimatedDeliveryDatestring

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

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

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

Occurrence: Conditional

lineItems.shippingDetail.shippingServiceCodestring

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

Occurrence: Conditional

lineItems.taxDetailsarray of TaxDetail

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

lineItems.taxDetails.includedInPriceboolean

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

Occurrence: Conditional

lineItems.taxDetails.taxJurisdictionTaxJurisdiction

A container that returns the tax jurisdiction information.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.regionRegion

The region of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.region.regionNamestring

A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.region.regionTypeRegionTypeEnum

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

Valid Values:

  • STATE_OR_PROVINCE - 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.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

lineItems.taxDetails.taxJurisdiction.taxJurisdictionIdstring

The identifier of the tax jurisdiction.

Occurrence: Conditional

lineItems.taxDetails.taxTypeTaxType

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

Occurrence: Conditional

lineItems.titlestring

The seller created title of the item.

Occurrence: Conditional

paymentInstrumentPaymentInstrument

The payment method used for the purchase order.

Occurrence: Always

paymentInstrument.brandPaymentMethodBrand

The name of the credit card company (brand).

Occurrence: Conditional

paymentInstrument.brand.logoImageImage

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

Occurrence: Conditional

paymentInstrument.brand.logoImage.heightinteger

Reserved for future use.

Occurrence: Conditional

paymentInstrument.brand.logoImage.imageUrlstring

The URL of the image.

Occurrence: Conditional

paymentInstrument.brand.logoImage.widthinteger

Reserved for future use.

Occurrence: Conditional

paymentInstrument.brand.paymentMethodBrandTypePaymentMethodBrandEnum

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

Occurrence: Conditional

paymentInstrument.paymentMethodTypePaymentMethodTypeEnum

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

Occurrence: Conditional

pricingSummaryPricingSummary

The container that returns the monetary details of the order.

Occurrence: Always

pricingSummary.additionalSavingsAmount

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

Occurrence: Conditional

pricingSummary.additionalSavings.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.additionalSavings.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.addonServiceFeeAmount

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

Occurrence: Conditional

pricingSummary.addonServiceFee.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.addonServiceFee.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.adjustmentAdjustment

The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the purchase order that are not already captured in one of the other fields.

Occurrence: Conditional

pricingSummary.adjustment.amountAmount

The container for the amount and currency of the adjustment.

Occurrence: Conditional

pricingSummary.adjustment.amount.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.adjustment.amount.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.adjustment.labelstring

Text that describes the adjustment.

Occurrence: Conditional

pricingSummary.deliveryCostAmount

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

pricingSummary.deliveryCost.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.deliveryCost.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.deliveryDiscountAmount

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

pricingSummary.deliveryDiscount.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.deliveryDiscount.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.feeAmount

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

Occurrence: Conditional

pricingSummary.fee.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.fee.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.importChargesAmount

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

Occurrence: Conditional

pricingSummary.importCharges.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.importCharges.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.importTaxImportTax

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

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

Occurrence: Conditional

pricingSummary.importTax.amount.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.importTax.amount.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.importTax.importTaxTypeImportTaxTypeEnum

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

pricingSummary.priceDiscountAmount

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

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

Occurrence: Always

pricingSummary.priceDiscount.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.priceSubtotalAmount

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

pricingSummary.priceSubtotal.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.priceSubtotal.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.taxAmount

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

Occurrence: Conditional

pricingSummary.tax.currencyCurrencyCodeEnum

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

Occurrence: Always

pricingSummary.tax.valuestring

The monetary amount.

Occurrence: Always

pricingSummary.totalAmount

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

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

Occurrence: Always

pricingSummary.total.valuestring

The monetary amount.

Occurrence: Always

purchaseOrderCreationDatestring

The timestamp of when the purchase order was created.

Occurrence: Always

purchaseOrderIdstring

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

Occurrence: Always

purchaseOrderPaymentStatusPurchaseOrderPaymentStatusEnum

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

Occurrence: Always

purchaseOrderStatusPurchaseOrderStatusEnum

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

Occurrence: Always

purchaseOrderWebUrlstring

The URL to the Order Details page on eBay.

Occurrence: Conditional

refundedAmountAmount

The total amount of any refunds for purchase order.

Occurrence: Conditional

refundedAmount.currencyCurrencyCodeEnum

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

Occurrence: Always

refundedAmount.valuestring

The monetary amount.

Occurrence: Always

shippingAddressShippingAddress

The shipping address for the purchase order.

Occurrence: Always

shippingAddress.addressLine1string

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

Occurrence: Conditional

shippingAddress.addressLine2string

The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Occurrence: Conditional

shippingAddress.citystring

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

Occurrence: Conditional

shippingAddress.countryCountryCodeEnum

The two letter code representing the country of the address.

Occurrence: Conditional

shippingAddress.countystring

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

Occurrence: Conditional

shippingAddress.phoneNumberstring

The phone number of the person receiving the package.

Occurrence: Conditional

shippingAddress.postalCodestring

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

Occurrence: Conditional

shippingAddress.recipientstring

Name of the person receiving the package.

Occurrence: Conditional

shippingAddress.stateOrProvincestring

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

Occurrence: Conditional

shippingFulfillmentsarray of ShippingFulfillment

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

Occurrence: Conditional

shippingFulfillments.actualDeliveryDatestring

The date the purchase order was delivered.

Occurrence: Conditional

shippingFulfillments.lineItemReferencesarray of LineItemReference

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

Occurrence: Conditional

shippingFulfillments.lineItemReferences.lineItemIdstring

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

Occurrence: Always

shippingFulfillments.lineItemReferences.quantityinteger

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

Occurrence: Always

shippingFulfillments.maxEstimatedDeliveryDatestring

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

Occurrence: Conditional

shippingFulfillments.minEstimatedDeliveryDatestring

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

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEventsarray of ShipmentTrackingEvents

The container that returns all the shipment tracking events.

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.descriptionstring

A string describing the tracking event.

For example: On FedEx vehicle for delivery

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.eventDatestring

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

A normalized string for shipment tracking event.

For example: OUT_FOR_DELIVERY

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.locationEventLocation

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

The city where the tracking event occurred.

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.location.countryCountryCodeEnum

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

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.location.countystring

The county where the tracking event occurred.

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.location.postalCodestring

The postal code where the tracking event occurred.

Occurrence: Conditional

shippingFulfillments.shipmentTrackingEvents.location.stateOrProvincestring

The state where the tracking event occurred.

Occurrence: Conditional

shippingFulfillments.shipmentTrackingNumberstring

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

Occurrence: Conditional

shippingFulfillments.shipmentTrackingUrlstring

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

Occurrence: Conditional

shippingFulfillments.shippedDatestring

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

Occurrence: Conditional

shippingFulfillments.shippingCarrierCodestring

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

Occurrence: Conditional

shippingFulfillments.shippingServiceCodestring

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

Occurrence: Conditional

taxDetailsarray of TaxDetails

Detailed tax information for items included in this order.

Occurrence: Conditional

taxDetails.amountAmount

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

Occurrence: Conditional

taxDetails.amount.currencyCurrencyCodeEnum

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

Occurrence: Always

taxDetails.amount.valuestring

The monetary amount.

Occurrence: Always

taxDetails.taxClassificationTaxClassificationEnum

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

Occurrence: Conditional

taxDetails.taxClassificationDetailsarray of TaxClassificationDetail

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

Occurrence: Conditional

taxDetails.taxClassificationDetails.amountAmount

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

Occurrence: Conditional

taxDetails.taxClassificationDetails.amount.currencyCurrencyCodeEnum

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

Occurrence: Always

taxDetails.taxClassificationDetails.amount.valuestring

The monetary amount.

Occurrence: Always

taxDetails.taxClassificationDetails.taxTypeTaxType

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

Occurrence: Conditional

warningsarray 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.categorystring

Identifies the type of error.

Occurrence: Always

warnings.domainstring

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

Occurrence: Always

warnings.errorIdinteger

A unique number to identify the error.

Occurrence: Always

warnings.inputRefIdsarray of string

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

Occurrence: Conditional

warnings.longMessagestring

A more detailed explanation of the error.

Occurrence: Conditional

warnings.messagestring

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

Occurrence: Always

warnings.outputRefIdsarray of string

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

Occurrence: Conditional

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

The object of the error.

Occurrence: Conditional

warnings.parameters.valuestring

The value of the object.

Occurrence: Conditional

warnings.subdomainstring

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.

StatusMeaning
200OK
403Access Forbidden
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
16001API_ORDERAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
16002API_ORDERREQUESTThe purchase order ID was not found.
16003API_ORDERREQUESTAccess to the purchase order is not authorized.

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: Get the Details of an eBay Member Purchase Order that has Fees

This sample returns the details for the specified eBay Member purchase order including the shipment tracking number and the fulfillment events.

Input

The input is the purchaseOrderId URI parameter, which is returned by the Checkout API placeOrder call. There is no payload with this request.

GEThttps://api.ebay.com/buy/order/v1/purchase_order/1*************1

Output

The output shows that the specified purchase order contained two line items. The total cost of the items was $23.78 (pricingSummary.total) and the purchase order has been paid for (purchaseOrderPaymentStatus = PAID) using a credit card (paymentInstrument.paymentMethodType = CREDIT_CARD).

You can also see that the total fees associated with the order is $16.50 (pricingSummary.fee).

Sample 2: Get the Details of an eBay Member Purchase Order that has Discounts

This sample returns the details for the specified eBay Member purchase order. This purchase order contains two line items; both line items are for a quantity of 2. Both line items are for items that qualify for both a promotion and a coupon.

Input

The input is the purchaseOrderId URI parameter, which is returned by the Checkout API placeOrder call. There is no payload with this request.

GEThttps://api.ebay.com/buy/order/v1/purchase_order/7************1

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.

lineItems fields Item 1 Item 2
 lineItems.baseUnitPrice
 (price of 1 item)
3024.00 226.20
 lineItems.netPrice
 (total for items with discounts applied)
2960.17 410.23
 lineItems.promotions.discount
 (seller promotion discount applied)
-3000.00 -30.00
 lineItems.promotions.discount
 (coupon discount applied)
-87.83 -12.17
   
pricingSummary fields Item 1 Item 2
 pricingSummary.priceSubtotal = 6500.40
 (no discounts applied)
2 x 3024.00 2 x 226.20
 pricingSummary.priceDiscount = -3030.00
 (discount from Promotions)
3000.00 30.00
 pricingSummary.deliveryCost
 (total deliver costs for all line items)
5.99
 pricingSummary.deliveryDiscount
 (total deliver discounts for all line items)
-5.99
 pricingSummary.additionalSavings = -100.00
 (discount from Coupons)
87.83 12.17
 pricingSummary.total = 3370.40
 (same as netPrice)
2960.17 410.23