eBay Logistics API
The eBay Logistics API provides shipping rate quotes and label purchasing for sellers fulfilling orders inside or outside the eBay platform.
OpenAPI Specification
openapi: 3.0.0
info:
title: eBay Logistics API
description: '<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> – 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> – 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>'
contact:
name: eBay Inc,
license:
name: eBay API License Agreement
url: https://go.developer.ebay.com/api-license-agreement
version: v1_beta.0.0
servers:
- url: https://api.ebay.com{basePath}
description: Production
variables:
basePath:
default: /sell/logistics/v1_beta
paths:
/shipment/{shipmentId}/cancel:
post:
tags:
- Shipment
description: This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the <b>totalShippingCost</b> of the canceled shipment is refunded to the account established by the user's billing agreement. <br><br>Note that you cannot cancel a shipment if you have used the associated shipping label.
operationId: cancelShipment
parameters:
- name: shipmentId
in: path
description: This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.<br><br>The <b>shipmentId</b> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
'400':
description: Bad Request
'404':
description: Not Found
x-response-codes:
errors:
'90005':
domain: API_LOGISTICS
category: REQUEST
description: The resource could not be found.
'409':
description: Conflict
x-response-codes:
errors:
'90260':
domain: API_LOGISTICS
category: REQUEST
description: Cannot cancel shipment {shipmentId}
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
/shipment/create_from_shipping_quote:
post:
tags:
- Shipment
description: 'This 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> value specifies the carrier and service for the package shipment, and the rate ID must be contained in the shipping quote identified by the <b>shippingQuoteId</b> value. Call <b>createShippingQuote</b> to retrieve a set of live shipping rates.<br><br><span class="tablenote"><b>Note:</b> The Logistics API only supports USPS shipping rates and labels.</span><br/>When you create a shipment, eBay generates a shipping label that you can download and use to ship your package.<br/><br/>In a <b>createFromShippingQuote</b> 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 shipping quote.<br/><br/>In addition to a configurable return-to location and other details about the shipment, the response to this method includes:<ul><li>The shipping carrier and service to be used for the package shipment</li><li>A list of selected shipping options, if any</li><li>The shipment tracking number</li><li>The total shipping cost (the sum cost of the base shipping service and any added options)</li></ul>When you create a shipment, your billing agreement account is charged the sum of the <b>baseShippingCost</b> and the total cost of any additional shipping options you might have selected. Use the URL returned in <b>labelDownloadURL</b> field, or call <b>downloadLabelFile</b> with the <b>shipmentId</b> value from the response, to download a shipping label for your package.<br/><br/><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Sellers must set up their payment method before they can use this method to create a shipment and the associated shipping label.</p></div><h3 id="ba">Set up a billing agreement</h3>Prior to using this method to create a shipment, sellers must first set up their billing agreement. Failure to do so will return <code>Error 90030 Payment could not be completed.</code><br/><br/>The preferred method for sellers to set up their billing agreement is to go to <a href="https://gslblui.ebay.com/gslblui/payments " target="_blank">Set up billing agreement</a> and follow the on-screen directions.<br/><br/>Alternatively, sellers can do the following:<ul><li>Go to https://www.ebay.com/ship/single/{order_id}, where {order_id} is that of the order for which the label is being printed.</li><li>When prompted, select <b>PayPal</b>.</li><li>Verify that <b>Save PayPal for future purchases</b> is selected.</li><li>Click <b>Set up Payments</b> which will open PayPal in a pop-up window.</li><li>Log in using <i>PayPal credentials</i>, and then follow the on-screen prompts to set up the billing agreement.</li><li>Once the agreement has been set up, sellers can leave this page as there is no need to actually print a label.</li></ul>'
operationId: createFromShippingQuote
parameters:
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: The create shipment from quote request.
content:
application/json:
schema:
description: The create shipment from quote request.
$ref: '#/components/schemas/CreateShipmentFromQuoteRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
'400':
description: Bad Request
x-response-codes:
errors:
'90010':
domain: API_LOGISTICS
category: REQUEST
description: Missing field {fieldName}.
'90020':
domain: API_LOGISTICS
category: REQUEST
description: Invalid field {fieldName}.
'409':
description: Conflict
x-response-codes:
errors:
'90030':
domain: API_LOGISTICS
category: REQUEST
description: Payment could not be completed.
'90200':
domain: API_LOGISTICS
category: REQUEST
description: The quote has expired. Please request a new quote.
'90210':
domain: API_LOGISTICS
category: REQUEST
description: The quote has already been purchased. Please request a new quote.
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
/shipment/{shipmentId}/download_label_file:
get:
tags:
- Shipment
description: This method returns the shipping label file that was generated for the <b>shipmentId</b> value specified in the request. Call <b>createFromShippingQuote</b> to generate a shipment ID.<br><br><span class="tablenote"><b>Note:</b> The Logistics API only supports USPS shipping rates and labels.</span><br>Use the <code>Accept</code> HTTP header to specify the format of the returned file. The default file format is a PDF file. <!-- Are other options available? -->
operationId: downloadLabelFile
parameters:
- name: shipmentId
in: path
description: This path parameter specifies the unique eBay-assigned identifier of the shipment associated with the shipping label you want to download.<br><br> The <b>shipmentId</b> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method.
required: true
schema:
type: string
- name: Accept
in: header
description: 'This header specifies the format of the returned file. For this method, the value of the header should be <code>Accept: application/pdf</code>. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/pdf:
schema:
type: array
items:
type: string
'400':
description: Bad Request
'404':
description: Not Found
x-response-codes:
errors:
'90005':
domain: API_LOGISTICS
category: REQUEST
description: The resource could not be found.
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
/shipment/{shipmentId}:
get:
tags:
- Shipment
description: This method retrieves the shipment details for the specified shipment ID. Call <b>createFromShippingQuote</b> to generate a shipment ID.
operationId: getShipment
parameters:
- name: shipmentId
in: path
description: This path parameter specifies the unique eBay-assigned identifier of the shipment you want to retrieve.<br><br>The <b>shipmentId</b> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
'400':
description: Bad Request
'404':
description: Not Found
x-response-codes:
errors:
'90005':
domain: API_LOGISTICS
category: REQUEST
description: The resource could not be found.
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
/shipping_quote:
post:
tags:
- Shipping_quote
description: 'The <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 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.<br><br><span class="tablenote"><b>Note:</b> The Logistics API only supports USPS shipping rates and labels.</span><br>Each rate is for a single package and is based on the following information: <ul><li>The shipping origin</li> <li>The shipping destination</li> <li>The package size (weight and dimensions)</li></ul> Rates are identified by a unique eBay-assigned <b>rateId</b> 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. <br><br>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 <b>rateId</b>, call <b>createFromShippingQuote</b> to create a shipment and generate a shipping label that you can use to ship the package.'
operationId: createShippingQuote
parameters:
- name: X-EBAY-C-MARKETPLACE-ID
in: header
description: This header parameter specifies the eBay marketplace for the shipping quote that is being created.<br><br>For a list of valid values, refer to the section <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">Marketplace ID Values</a> in the <b>Using eBay RESTful APIs</b> guide.
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: The request object for <b>createShippingQuote</b>.
content:
application/json:
schema:
description: The request object for <b>createShippingQuote</b>.
$ref: '#/components/schemas/ShippingQuoteRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingQuote'
x-response-codes:
errors:
'90135':
domain: API_LOGISTICS
category: REQUEST
description: The provided shipTo address does not match the destination address of the order(s).
'400':
description: Bad Request
x-response-codes:
errors:
'90010':
domain: API_LOGISTICS
category: REQUEST
description: Missing field {fieldName}.
'90020':
domain: API_LOGISTICS
category: REQUEST
description: Invalid field {fieldName}.
'90110':
domain: API_LOGISTICS
category: REQUEST
description: The order {orderId} was not found on the platform.
'409':
description: Conflict
x-response-codes:
errors:
'90100':
domain: API_LOGISTICS
category: REQUEST
description: No shipping services available for the provided addresses.
'90120':
domain: API_LOGISTICS
category: REQUEST
description: The package specification is incompatible with the destination.
'90130':
domain: API_LOGISTICS
category: REQUEST
description: Order {orderId} is incompatible with our services.
'90133':
domain: API_LOGISTICS
category: REQUEST
description: Maximum number of orders exceeded. Current limitation is 10.
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
/shipping_quote/{shippingQuoteId}:
get:
tags:
- Shipping_quote
description: This method retrieves the complete details of the shipping quote associated with the specified <b>shippingQuoteId</b> value. <br><br>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. <br><br>Call <b>createShippingQuote</b> to create a <b>shippingQuoteId</b>.
operationId: getShippingQuote
parameters:
- name: shippingQuoteId
in: path
description: This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.<br><br>The <b>shippingQuoteId</b> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingQuote'
'400':
description: Bad Request
'404':
description: Not Found
x-response-codes:
errors:
'90005':
domain: API_LOGISTICS
category: REQUEST
description: The resource could not be found.
'500':
description: Internal Server Error
x-response-codes:
errors:
'90000':
domain: API_LOGISTICS
category: APPLICATION
description: A system error has occurred.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.logistics
components:
schemas:
AdditionalOption:
type: object
properties:
additionalCost:
description: The monetary cost of the additional shipping option identified by the <b>optionType</b> field.
$ref: '#/components/schemas/Amount'
optionType:
type: string
description: The name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected rate.
description: This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional options for each rate are defined, named, and offered by the selected shipping carrier. Examples include shipping insurance or the requirement for a recipient signature.
Amount:
type: object
properties:
currency:
type: string
description: The base currency applied to the <b>value</b> field to establish a monetary amount. <br><br>The currency is represented as a 3-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> currency code. For example, the code for the Canadian Dollar is <code>CAD</code>. <br><br><b>Default:</b> The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/bas:CurrencyCodeEnum'>eBay API documentation</a>
value:
type: string
description: The monetary amount in the specified <b>currency</b>. <br><br><i>Required in</i> the <b>amount</b> type.
description: A complex type that describes the value of a monetary amount as represented by a global currency.
Contact:
type: object
properties:
companyName:
type: string
description: The company name with which the contact is associated.
contactAddress:
description: The details of the contact's geographical address.
$ref: '#/components/schemas/ContactAddress'
fullName:
type: string
description: The contact's full name.
primaryPhone:
description: The contact's primary telephone number.
$ref: '#/components/schemas/PhoneNumber'
description: This complex type contains contact information for an individual buyer or seller.
ContactAddress:
type: object
properties:
addressLine1:
type: string
description: The first line of the street address.
addressLine2:
type: string
description: The second line of the street address. Use this field for additional address information, such as a suite or apartment number.
city:
type: string
description: The city in which the address is located.
countryCode:
type: string
description: The country of the address, represented as two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code. For example, <code>US</code> represents the United States and <code>DE</code> represents Germany. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/bas:CountryCodeEnum'>eBay API documentation</a>
county:
type: string
description: The county (not country) in which the address is located. Counties typically contain multiple cities or towns.
postalCode:
type: string
description: The postal code of the address.
stateOrProvince:
type: string
description: The state or province in which the address is located. States and provinces often contain multiple counties.
description: This complex type specifies the details of a geographical address.
CreateShipmentFromQuoteRequest:
type: object
properties:
additionalOptions:
type: array
description: Supply a list of one or more shipping options that the seller wants to purchase for this shipment. <br><br>The <b>baseShippingCost</b> 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.
items:
$ref: '#/components/schemas/AdditionalOption'
labelCustomMessage:
type: string
description: Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels.
labelSize:
type: string
description: '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. <br><br>Currently, the only valid value is: <code>4"x6"</code>'
rateId:
type: string
description: The unique eBay-assigned identifier of the shipping rate that the seller selected for the shipment. This value is generated by using the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method and is returned in the <b>rates.rateId</b> field.
returnTo:
description: 'The optional return address and contact details for the shipment. The return address is printed on the shipping label. If not specified, the return address defaults to the <b>shipFrom</b> address returned in shipping quote. '
$ref: '#/components/schemas/Contact'
shippingQuoteId:
type: string
description: The unique eBay-assigned identifier of the shipping quote that was generated by the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method.
description: This complex type contains the request payload for the <b>createFromShippingQuote</b> method.
Dimensions:
type: object
properties:
height:
type: string
description: The numeric value of the height of the package.
length:
type: string
description: The numeric value of the length of the package.
unit:
type: string
description: The unit of measure used to express the height, length, and width of the package. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/api:LengthUnitOfMeasureEnum'>eBay API documentation</a>
width:
type: string
description: The numeric value of the width of the package.
description: This complex type defines the dimensions of a package to be shipped.
Error:
type: object
properties:
category:
type: string
description: 'The category type for this error or warning. It takes a string that can have one of three values:<ul><li><code>Application</code>: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service''s business logic, system failures, or request errors from a dependency.</li><li><code>Business</code>: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.</li><li><code>Request</code>: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.</li></ul>'
domain:
type: string
description: Name of the domain containing the service or application.
errorId:
type: integer
description: A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
format: int32
inputRefIds:
type: array
description: Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use <i>JSONPath</i> notation.
items:
type: string
longMessage:
type: string
description: An expanded version of message that should be around 100-200 characters long, but is not required to be such.
message:
type: string
description: An end user and app-developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.
outputRefIds:
type: array
description: Identifies specific response elements associated with the error, if any. Path format is the same as <code>inputRefId</code>.
items:
type: string
parameters:
type: array
description: This optional complex field type contains a list of one or more context-specific <code>ErrorParameter</code> objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each <code>ErrorParameter</code> object consists of two fields, a <code>name</code> and a <code>value</code>.
items:
$ref: '#/components/schemas/ErrorParameter'
subdomain:
type: string
description: Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.
description: A container that defines the elements of error and warning message.
ErrorParameter:
type: object
properties:
name:
type: string
description: Name of the entity that threw the error.
value:
type: string
description: A description of the error.
description: Container for an error parameter.
Order:
type: object
properties:
channel:
type: string
description: The marketplace where the order was created.<br><br>Use the value <code>EBAY</code> to get the rates available for eBay orders.
orderId:
type: string
description: The unique identifier of the order. The <a href=/api-docs/sell/fulfillment/resources/order/methods/getOrders" target="_blank">getOrders</a> method of the <b>Fulfillment API</b> can be used to retrieve order IDs.
description: This complex type defines an order from which a seller is including one or more line items in a single package to be shipped.
PackageSpecification:
type: object
properties:
dimensions:
description: Declares the height, length, width, and unit of measure for the package to be shipped.
$ref: '#/components/schemas/Dimensions'
weight:
description: Declares the weight of the package.
$ref: '#/components/schemas/Weight'
description: This complex type specifies the dimensions and weight of a package.
PhoneNumber:
type: object
properties:
phoneNumber:
type: string
description: A telephone number.
description: This complex type contains a string field representing a telephone number.
PickupSlot:
type: object
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ebay/refs/heads/main/openapi/ebay-logistics-openapi-original.yml