Logistics API resources | eBay Developers Program

Note: This is a (Limited Release) API available only to select developers approved by business units.

The Logistics API resources offer the following capabilities:

shipping_quote – Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.
shipment – Creates a "shipment" for the selected shipping rate.

Call createShippingQuote to get a list of live shipping rates. The rates returned are all valid for a specific time window and all quoted prices are at eBay-negotiated rates.

Select one of the live rates and using its associated rateId, create a "shipment" for the package by calling createFromShippingQuote. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned totalShippingCost value. This action also generates a shipping label that you can use to ship the package. The total cost of the shipment is incurred when the package is shipped using the supplied shipping label.

Important! Sellers must set up a payment method via their eBay account before they can use the methods in this API to create a shipment and the associated shipping label.

shipment

Method Name	HTTP Method	Path	Summary	Samples
cancelShipment	POST	/shipment/{shipmentId}/cancel	Cancels a shipment and invalidates the associated shipping label.	View cancelShipment - /shipment/{shipmentId}/cancel
createFromShippingQuote	POST	/shipment/create_from_shipping_quote	Creates a shipment from a shipping quote and generates a shipping label.	View createFromShippingQuote - /shipment/create_from_shipping_quote
downloadLabelFile	GET	/shipment/{shipmentId}/download_label_file	Downloads the eBay shipping label for a shipment in PDF format.	View downloadLabelFile - /shipment/{shipmentId}/download_label_file
getShipment	GET	/shipment/{shipmentId}	Retrieves details of a shipment.	View getShipment - /shipment/{shipmentId}

shipping_quote

Method Name	HTTP Method	Path	Summary	Samples
createShippingQuote	POST	/shipping_quote	Creates an eBay shipping label quote for a single package in an order, based on its origin and destination, and package weight and dimensions.	View createShippingQuote - /shipping_quote
getShippingQuote	GET	/shipping_quote/{shippingQuoteId}	Retrieves details on an eBay shipping label quote.	View getShippingQuote - /shipping_quote/{shippingQuoteId}