Skip to content
OpenParablePublic APIs

Logistics API API

by ebay.com

OAuthHTTPSShopping
Open documentation ↗

Overview

<span class="tablenote"><b>Note:</b> This is a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> API available only to select developers approved by business units.</span><br /><br />The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> &ndash; Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.</li> <li><b>shipment</b> &ndash; Creates a "shipment" for the selected shipping rate.</li></ul> Call <b>createShippingQuote</b> 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. <br><br>Select one of the live rates and using its associated <b>rateId</b>, create a "shipment" for the package by calling <b>createFromShippingQuote</b>. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned <b>totalShippingCost</b> 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. <p class="tablenote"><b>Important!</b> 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.</p>

Logistics API is a shopping API from ebay.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 6 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Shopping
Version
v1_beta.0.0
Endpoints
6
OpenAPI
Specification ↗
Spec updated
2023-03-05

Endpoints

MethodPathWhat it does
POST/shipment/create_from_shipping_quoteThis method creates a "shipment" based on the <b>shippingQuoteId</b> and <b>rateId</b> values supplied in the request. The rate identified by the <b>rateId</b>
GET/shipment/{shipmentId}This method retrieves the shipment details for the specified shipment ID. Call <b>createFromShippingQuote</b> to generate a shipment ID.
POST/shipment/{shipmentId}/cancelThis method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the <b>tota
GET/shipment/{shipmentId}/download_label_fileThis method returns the shipping label file that was generated for the <b>shipmentId</b> value specified in the request. Call <b>createFromShippingQuote</b> to
POST/shipping_quoteThe <b>createShippingQuote</b> method returns a <i>shipping quote </i> that contains a list of live "rates." <br><br>Each rate represents an offer made by a sh
GET/shipping_quote/{shippingQuoteId}This method retrieves the complete details of the shipping quote associated with the specified <b>shippingQuoteId</b> value. <br><br>A "shipping quote" pertain

Questions

Does the Logistics API API need an API key?

Yes. The Logistics API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Logistics API API support HTTPS?

Yes, the Logistics API API is served over HTTPS.

How many endpoints does the Logistics API API have?

Its OpenAPI description lists 6 endpoints in version v1_beta.0.0. All of them are shown on this page.

What are alternatives to the Logistics API API?

Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.

Compare alternatives →

Etsy

Shopping

Manage shop and interact with listings

OAuth

eBay

Shopping

Sell and Buy on eBay

OAuth

Flipkart Marketplace

Shopping

Product listing management, Order Fulfilment in the Flipkart Marketplace

OAuthCORS

Inventory Management

Shopping

Maintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.

No auth7 endpoints

Intel Product Catalogue Service

Shopping

This is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [[email protected]](mailto:[email protected]?subject=PIMServices)

API key4 endpoints

Item API

Shopping

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

No auth6 endpoints

Listed from APIs.guru (CC0).