eBay Order API
The Order API from eBay — 3 operation(s) for order.
eBay Order API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes 3 operations across 3 paths, and defines 49 schemas. It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
3 operations
3 paths
49 schemas
2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
eBay Order API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth— The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Order 3
GET
/order/{orderId}
Use this call to retrieve the contents of an order based on its unique identifier, orderId . This value was returned in the getOrders call's orders.orderId field when you searched for orders by creat…
GET
/order
Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a l…
POST
/order/{order_id}/issue_refund
eBay Issue Refund
Schemas 49
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are LineItem (25 properties), Order (20 properties), Error (9 properties), PricingSummary (8 properties). Each schema is shown below with its type and property counts.
PaymentSummary
object
This type contains information about the various monetary exchanges that apply to the net balance due for the order.
3 properties
LineItemProperties
object
This type contains information about the eBay programs under which a line item was listed and sold.
3 properties
OrderRefund
object
This type contains information about a refund issued for an order. This does not include line item level refunds.
5 properties
Address
object
This type contains the details of a geographical address.
7 properties
DeliveryCost
object
This type contains a breakdown of all costs associated with the fulfillment of a line item.
5 properties
ExtendedContact
object
This type contains shipping and contact information for a buyer or an eBay shipping partner.
5 properties
Payment
object
This type is used to provide details about the seller payments for an order.
6 properties
PickupStep
object
This type is used to indicate the merchant's store where the buyer will pickup their In-Store Pickup order. The pickupStep container is only returned for In-St…
1 property
NameValuePair
object
This type contains the name-value specifics of a multi-variation listing ( variationAspects ) or the name-value specifics for all item aspects of a linked line…
2 properties
EbayTaxReference
object
This type describes the VAT tax details. The eBay VAT tax type and the eBay VAT identifier number will be returned if a VAT tax is applicable for the order. No…
2 properties
LineItemRefund
object
This type contains refund information for a line item.
4 properties
AppointmentDetails
object
This type contains information used by the installation provider concerning appointment details selected by the buyer
6 properties
PricingSummary
object
This type contains a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery cos…
8 properties
TaxIdentifier
object
This type is used by the taxIdentifier container that is returned in getOrder . The taxIdentifier container consists of taxpayer identification information for…
3 properties
Amount
object
This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the…
4 properties
EbayFulfillmentProgram
object
This type is used to provide details about an order line item being fulfilled by eBay or an eBay fulfillment partner.
1 property
Buyer
object
This type contains information about the order's buyer.
4 properties
LegacyReference
object
Type defining the legacyReference container. This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an…
2 properties
Error
object
This type contains a error or warning related to a call request.
9 properties
PhoneNumber
object
This type contains a string field representing a telephone number.
1 property
AppliedPromotion
object
This type contains information about a sales promotion that is applied to a line item.
3 properties
GiftDetails
object
This type contains information about a digital gift card line item that was purchased as a gift and sent to the recipient by email. Note: GiftDetails will not…
3 properties
Program
object
This type is returned for order line items eligible for the Authenticity Guarantee service and/or for order line items fulfilled by the eBay Fulfillment progra…
5 properties
RefundItem
object
This type is used if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses…
3 properties
EbayInternationalShipping
object
This type is used to provide details about an order line item being managed through eBay International Shipping.
1 property
TrackingInfo
object
This type is used for seller provided shipment tracking information.
2 properties
LinkedOrderLineItem
object
This type contains data on a line item that is related to, but not a part of the order.
8 properties
Refund
object
This is the base type of the issueRefund response payload. As long as the issueRefund method does not trigger an error, a response payload will be returned.
2 properties
EbayVaultProgram
object
1 property
EbayCollectAndRemitTax
object
This type contains information about the type and amount of tax that eBay will collect and remit to the state, province, country, or other taxing authority in…
4 properties
LineItem
object
This type contains the details of each line item in an order.
25 properties
CancelRequest
object
This type contains information about a buyer request to cancel an order.
6 properties
PaymentHold
object
This type contains information about a hold placed on a payment to a seller for an order, including the reason why the buyer's payment for the order is being h…
6 properties
Tax
object
This type contains information about any sales tax applied to a line item.
2 properties
TaxAddress
object
This container consists of address information that can be used by sellers for tax purpose.
4 properties
ShippingStep
object
This type contains shipping information for a fulfillment, including the shipping carrier, the shipping service option, the shipment destination, and the Globa…
4 properties
LineItemFulfillmentInstructions
object
This type contains the specifications for processing the fulfillment of a line item, including the handling window and the delivery window. These fields provid…
4 properties
FulfillmentStartInstruction
object
This type contains a set of specifications for processing a fulfillment of an order, including the type of fulfillment, shipping carrier and service, addressin…
8 properties
Order
object
This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order…
20 properties
EbayShipping
object
This type contains information about the management of the shipping for the order.
1 property
OrderSearchPagedCollection
object
This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into…
8 properties
ErrorParameter
object
This type contains the name and value of an input parameter that contributed to a specific error or warning condition.
2 properties
CancelStatus
object
This type contains information about any requests that have been made to cancel an order.
3 properties
PostSaleAuthenticationProgram
object
This type is used to provide the status and outcome of an order line item going through the Authenticity Guarantee verification process.
2 properties
ItemLocation
object
This type describes the physical location of an order.
3 properties
SellerActionsToRelease
object
This type is used to state possible action(s) that a seller can take to release a payment hold placed against an order.
1 property
EbayCollectedCharges
object
This type contains the breakdown of costs that are collected by eBay from the buyer.
1 property
IssueRefundRequest
object
The base type used by the request payload of the issueRefund method.
4 properties
SimpleAmount
object
This type defines the monetary value of the payment dispute, and the currency used.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from eBay 12
Other APIs eBay publishes across the network.
eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
#Order