Skip to main content

The type that defines the fields for a purchase order, including line items, costs and charges, payment method, and the purchase order status.

Types that use PurchaseOrder

Not used by any types.

Call that uses PurchaseOrder

GET
/purchase_order/{purchaseOrderId}

Fields

Field
Type
Description
appliedCoupons
array 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.
lineItems
array of OrderLineItem
An array of line items in the purchase order.
paymentInstrument
PaymentInstrument
The payment method used for the purchase order.
pricingSummary
PricingSummary
The container that returns the monetary details of the order.
purchaseOrderCreationDate
string
The timestamp of when the purchase order was created.
purchaseOrderId
string
The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the placeOrder method.
purchaseOrderPaymentStatus
PurchaseOrderPaymentStatusEnum
An enumeration value that indicates the status of the payment for the purchase order.
purchaseOrderStatus
PurchaseOrderStatusEnum
The container for the current status of the buyer's payment and any refund that applies to the purchase order.
purchaseOrderWebUrl
string
The URL to the Order Details page on eBay.
refundedAmount
Amount
The total amount of any refunds for purchase order.
shippingAddress
ShippingAddress
The shipping address for the purchase order.
shippingFulfillments
array of ShippingFulfillment
An array of the shipping providers and the purchase order delivery details.
taxDetails
array of TaxDetails
Detailed tax information for items included in this order.
warnings
array of ErrorDetailV3
An array of warning messages. These type of errors do not prevent the call from executing but should be checked.