API docs by Redocly

Logistics API (v1_beta.0.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

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

shipping_quote

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.

Authorizations:
Authorization_Code
header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

This header parameter specifies the eBay marketplace for the shipping quote that is being created. For a list of valid values, refer to the section Marketplace ID Values in the Using eBay RESTful APIs guide.

Request Body schema: application/json

The request object for createShippingQuote.

Array of objects (Order)

A seller-defined list that contains information about the orders in the package. This allows sellers to include information about the line items in the package with the shipment information.

A package can contain any number of line items from one or more orders, providing they all ship in the same package.

Maximum list size: 10

object (PackageSpecification)

This complex type specifies the dimensions and weight of a package.

object (Contact)

This complex type contains contact information for an individual buyer or seller.

object (Contact)

This complex type contains contact information for an individual buyer or seller.

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    }
}

Response samples

Content type
application/json
{
  • "creationDate": "string",
  • "expirationDate": "string",
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "rates": [
    ],
  • "shipFrom": {
    },
  • "shippingQuoteId": "string",
  • "shipTo": {
    },
  • "warnings": [
    ]
}

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.

Authorizations:
Authorization_Code
path Parameters
shippingQuoteId
required
string

This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve. The shippingQuoteId value is generated and returned by a call to createShippingQuote.

Responses

Response samples

Content type
application/json
{
  • "creationDate": "string",
  • "expirationDate": "string",
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "rates": [
    ],
  • "shipFrom": {
    },
  • "shippingQuoteId": "string",
  • "shipTo": {
    },
  • "warnings": [
    ]
}

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.

Authorizations:
Authorization_Code
Request Body schema: application/json

The create shipment from quote request.

Array of objects (AdditionalOption)

Supply a list of one or more shipping options that the seller wants to purchase for this shipment.

The baseShippingCost field that's associated with the selected shipping rate is the cost of the base service offered in the rate. In addition to the base service, sellers can add additional shipping services to the base service. Shipping options include things such as shipping insurance or a recipient's signature upon delivery. The cost of any added services is summed with the base shipping cost to determine the final cost for the shipment. All options added to the shipment must be chosen from the set of shipping options offered with the selected rate.

labelCustomMessage
string

Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels.

labelSize
string

The seller's desired label size. Any supplied value is applied only if the shipping carrier supports multiple label sizes, otherwise the carrier's default label size is used.
<brCurrently, the only valid value is: 4"x6"

rateId
string

The eBay-assigned ID of the shipping rate that the seller selected for the shipment. This value is generated by a call to createShippingQuote and is returned in the rates.rateId field.

object (Contact)

This complex type contains contact information for an individual buyer or seller.

shippingQuoteId
string

The unique eBay-assigned ID of the shipping quote that was generated by a call to createShippingQuote.

Responses

Request samples

Content type
application/json
{
  • "additionalOptions": [
    ],
  • "labelCustomMessage": "string",
  • "labelSize": "string",
  • "rateId": "string",
  • "returnTo": {
    },
  • "shippingQuoteId": "string"
}

Response samples

Content type
application/json
{
  • "cancellation": {
    },
  • "creationDate": "string",
  • "labelCustomMessage": "string",
  • "labelDownloadUrl": "string",
  • "labelSize": "string",
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "rate": {
    },
  • "returnTo": {
    },
  • "shipFrom": {
    },
  • "shipmentId": "string",
  • "shipmentTrackingNumber": "string",
  • "shipTo": {
    }
}

getShipment

This method retrieves the shipment details for the specified shipment ID. Call createFromShippingQuote to generate a shipment ID.

Authorizations:
Authorization_Code
path Parameters
shipmentId
required
string

This path parameter specifies the unique eBay-assigned ID of the shipment you want to retrieve. The shipmentId value is generated and returned by a call to createFromShippingQuote.

Responses

Response samples

Content type
application/json
{
  • "cancellation": {
    },
  • "creationDate": "string",
  • "labelCustomMessage": "string",
  • "labelDownloadUrl": "string",
  • "labelSize": "string",
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "rate": {
    },
  • "returnTo": {
    },
  • "shipFrom": {
    },
  • "shipmentId": "string",
  • "shipmentTrackingNumber": "string",
  • "shipTo": {
    }
}

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.

Authorizations:
Authorization_Code
path Parameters
shipmentId
required
string

This path parameter specifies the unique eBay-assigned ID of the shipment associated with the shipping label you want to download. The shipmentId value is generated and returned by a call to createFromShippingQuote.

Responses

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.

Authorizations:
Authorization_Code
path Parameters
shipmentId
required
string

This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled. The shipmentId value is generated and returned by a call to createFromShippingQuote.

Responses

Response samples

Content type
application/json
{
  • "cancellation": {
    },
  • "creationDate": "string",
  • "labelCustomMessage": "string",
  • "labelDownloadUrl": "string",
  • "labelSize": "string",
  • "orders": [
    ],
  • "packageSpecification": {
    },
  • "rate": {
    },
  • "returnTo": {
    },
  • "shipFrom": {
    },
  • "shipmentId": "string",
  • "shipmentTrackingNumber": "string",
  • "shipTo": {
    }
}