Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Shipment API

The Shipment API from eBay — 4 operation(s) for shipment.

eBay Shipment 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 Shipment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 13 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}.

4 operations 4 paths 13 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.9.2
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Shipment 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 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Shipment 4
POST
/shipment/{shipmentId}/cancel
This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the totalShippingCost of the canceled shipment is…
cancelShipment 1 param → 200400404409500
POST
/shipment/create_from_shipping_quote
This method creates a shipment based on the shippingQuoteId and rateId values supplied in the request. The rate identified by the rateId value specifies the carrier and service for the package shipme…
createFromShippingQuote 1 param body → 201400409500
GET
/shipment/{shipmentId}/download_label_file
This method returns the shipping label file that was generated for the shipmentId value specified in the request. Call createFromShippingQuote to generate a shipment ID. Note: The Logistics API only…
downloadLabelFile 2 params → 200400404500
GET
/shipment/{shipmentId}
This method retrieves the shipment details for the specified shipment ID. Call createFromShippingQuote to generate a shipment ID.
getShipment 1 param → 200400404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PurchasedRate (15 properties), Shipment (13 properties), ContactAddress (7 properties), CreateShipmentFromQuoteRequest (6 properties). Each schema is shown below with its type and property counts.

ContactAddress
object
This complex type specifies the details of a geographical address.
7 properties
Contact
object
This complex type contains contact information for an individual buyer or seller.
4 properties
Dimensions
object
This complex type defines the dimensions of a package to be shipped.
4 properties
Amount
object
A complex type that describes the value of a monetary amount as represented by a global currency.
2 properties
Order
object
This complex type defines an order from which a seller is including one or more line items in a single package to be shipped.
2 properties
PackageSpecification
object
This complex type specifies the dimensions and weight of a package.
2 properties
PurchasedRate
object
The "rate" that has been selected and purchased for the shipment, as referenced by the rateId value.
15 properties
ShipmentCancellation
object
This type defines a shipment cancellation by the date and time the cancellation request was made and the current status of the request.
2 properties
Shipment
object
This complex type defines a shipment for a specific package (for example, a box or letter). Shipments are always linked to a purchased shipping label.
13 properties
AdditionalOption
object
This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional op…
2 properties
Weight
object
This complex type contains information about the weight of an object such as a shipping package.
2 properties
CreateShipmentFromQuoteRequest
object
This complex type contains the request payload for the createFromShippingQuote method.
6 properties
PhoneNumber
object
This complex type contains a string field representing a telephone number.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-shipment-api-openapi.yml Raw ↑

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