Logistics API
Note: This is a (Limited Release) API available only to select developers approved by business units. The Logistics API resources offer the following…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 6
shipment
- POSTcreateFromShippingQuote
/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… - GETgetShipment
/shipment/:shipmentIdThis method retrieves the shipment details for the specified shipment ID. Call <b>createFromShippingQuote</b> to generate a shipment ID. - POSTcancelShipment
/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… - GETdownloadLabelFile
/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>…
shipping_quote
- POSTcreateShippingQuote
/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… - GETgetShippingQuote
/shipping_quote/:shippingQuoteIdThis method retrieves the complete details of the shipping quote associated with the specified <b>shippingQuoteId</b> value. <br><br>A "shipping quote"…
API details
- Base URL
https://api.ebay.com{basePath}- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
- Operations
- 6 operations on 6 pathsGET 3POST 3
- Main resources
- shipment 4shipping_quote 2
- Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.0.0, API version
v1_beta.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Logistics API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Logistics API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “createFromShippingQuote” (POST /shipment/create_from_shipping_quote), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Logistics API?
Note: This is a (Limited Release) API available only to select developers approved by business units. The Logistics API resources offer the following… It is listed under E-commerce and has 6 endpoints.
Who publishes the Logistics API?
It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Logistics API?
Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.
How do I authenticate with the Logistics API?
With OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Logistics API have?
6 operations on 6 paths (3 GET, 3 POST). The largest groups are shipment, shipping_quote.
Is forking the Logistics API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.