ebay.com – sell-logistics

OpenAPI apis-guru ecommerce

Note: This is a 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.

Homepage: https://api.apis.guru/v2/specs/ebay.com:sell-logistics/v1_beta.0.0.json
Provider: ebay.com:sell-logistics / sell-logistics
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/ebay.com/sell-logistics/v1_beta.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/ebay.com/sell-logistics/v1_beta.0.0/openapi.yaml

Tools (8)

Extracted live via the executor SDK.

shipment.cancelShipment

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 refunded to the account established by the user's billing agreement.

Note that you cannot cancel a shipment if you have used the associated shipping label.
shipment.createFromShippingQuote
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 shipment, and the rate ID must be contained in the shipping quote identified by the shippingQuoteId value. Call createShippingQuote to retrieve a set of live shipping rates.

When you create a shipment, eBay generates a shipping label that you can download and use to ship your package.

In a createFromShippingQuote request, sellers can include a list of shipping options they want to add to the base service quoted in the selected rate. The list of available shipping options is specific to each quoted rate and if available, the options are listed in the rate container of the of the shipping quote.

In addition to a configurable return-to location and other details about the shipment, the response to this method includes:
- The shipping carrier and service to be used for the package shipment
- A list of selected shipping options, if any
- The shipment tracking number
- The total shipping cost (the sum cost of the base shipping service and any added options)
When you create a shipment, your billing agreement account is charged the sum of the baseShippingCost and the total cost of any additional shipping options you might have selected. Use the URL returned in labelDownloadUrl field, or call downloadLabelFile with the shipmentId value from the response, to download a shipping label for your package.
Important! Sellers must set up their payment method with eBay before they can use this method to create a shipment and the associated shipping label.
shipment.downloadLabelFile

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.

Use the Accept HTTP header to specify the format of the returned file. The default file format is a PDF file.
shipment.getShipment

This method retrieves the shipment details for the specified shipment ID. Call createFromShippingQuote to generate a shipment ID.
shippingQuote.createShippingQuote
The createShippingQuote method returns a shipping quote that contains a list of live "rates."

Each rate represents an offer made by a shipping carrier for a specific service and each offer has a live quote for the base service cost. Rates have a time window in which they are "live," and rates expire when their purchase window ends. If offered by the carrier, rates can include shipping options (and their associated prices), and users can add any offered shipping option to the base service should they desire. Also, depending on the services required, rates can also include pickup and delivery windows.

Each rate is for a single package and is based on the following information:
- The shipping origin
- The shipping destination
- The package size (weight and dimensions)
Rates are identified by a unique eBay-assigned rateId and rates are based on price points, pickup and delivery time frames, and other user requirements. Because each rate offered must be compliant with the eBay shipping program, all rates reflect eBay-negotiated prices.

The various rates returned in a shipping quote offer the user a choice from which they can choose a shipping service that best fits their needs. Select the rate for your shipment and using the associated rateId, call createFromShippingQuote to create a shipment and generate a shipping label that you can use to ship the package.
shippingQuote.getShippingQuote

This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value.

A "shipping quote" pertains to a single specific package and contains a set of shipping "rates" that quote the cost to ship the package by different shipping carriers and services. The quotes are based on the package's origin, destination, and size.

Call createShippingQuote to create a shippingQuoteId.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools