getShippingQuote: eBay Logistics API | eBay Developers Program

GET/shipping_quote/{shippingQuoteId}

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.

Input

Resource URI

GET https://api.ebay.com/sell/logistics/v1_beta/shipping_quote/{shippingQuoteId}

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
shippingQuoteId	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 the createShippingQuote method. Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.logistics

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* ShippingQuote */

"creationDate" : "string",

"expirationDate" : "string",

"orders" : [

{ /* Order */

"channel" : "string",

"orderId" : "string"

}

"packageSpecification" :

{ /* PackageSpecification */

"dimensions" :

{ /* Dimensions */

"height" : "string",

"length" : "string",

"unit" : "LengthUnitOfMeasureEnum : [INCH,FEET,CENTIMETER...]",

"width" : "string"

"weight" :

{ /* Weight */

"unit" : "WeightUnitOfMeasureEnum : [GRAM,KILOGRAM,OUNCE...]",

"value" : "string"

}

"rates" : [

{ /* Rate */

"additionalOptions" : [

{ /* AdditionalOption */

"additionalCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"optionType" : "string"

}

"baseShippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"destinationTimeZone" : "string",

"maxEstimatedDeliveryDate" : "string",

"minEstimatedDeliveryDate" : "string",

"pickupNetworks" : [

"string"

"pickupSlots" : [

{ /* PickupSlot */

"pickupSlotEndTime" : "string",

"pickupSlotId" : "string",

"pickupSlotStartTime" : "string",

"pickupSlotTimeZone" : "string"

}

"pickupType" : "PickupTypeEnum : [REGULAR_PICKUP,SCHEDULED_PICKUP,DROP_OFF]",

"rateId" : "string",

"rateRecommendation" : [

"RateRecommendationEnum : [BUYER_CHOSEN,CHEAPEST_ON_TIME,EBAY_PLUS_OK...]"

"shippingCarrierCode" : "string",

"shippingCarrierName" : "string",

"shippingServiceCode" : "string",

"shippingServiceName" : "string"

}

"shipFrom" :

{ /* Contact */

"companyName" : "string",

"contactAddress" :

{ /* ContactAddress */

"addressLine1" : "string",

"addressLine2" : "string",

"city" : "string",

"countryCode" : "CountryCodeEnum : [AD,AE,AF...]",

"county" : "string",

"postalCode" : "string",

"stateOrProvince" : "string"

"fullName" : "string",

"primaryPhone" :

{ /* PhoneNumber */

"phoneNumber" : "string"

}

"shippingQuoteId" : "string",

"shipTo" :

{ /* Contact */

"companyName" : "string",

"contactAddress" :

{ /* ContactAddress */

"addressLine1" : "string",

"addressLine2" : "string",

"city" : "string",

"countryCode" : "CountryCodeEnum : [AD,AE,AF...]",

"county" : "string",

"postalCode" : "string",

"stateOrProvince" : "string"

"fullName" : "string",

"primaryPhone" :

{ /* PhoneNumber */

"phoneNumber" : "string"

}

"warnings" : [

{ /* ErrorDetailV3 */

"category" : "string",

"domain" : "string",

"errorId" : "integer",

"inputRefIds" : [

"string"

"longMessage" : "string",

"message" : "string",

"outputRefIds" : [

"string"

"parameters" : [

{ /* ErrorParameterV3 */

"name" : "string",

"value" : "string"

}

"subdomain" : "string"

}

]

}

Response fields

Output container/field	Type	Description
creationDate	string	The date and time this quote was created, expressed as an ISO 8601 UTC string. Occurrence: Conditional
expirationDate	string	The last date and time that this quote will be honored, expressed as an ISO 8601 UTC string. After this time the quote expires and the expressed rates can no longer be purchased. Occurrence: Conditional
orders	array of Order	A list of one or more orders that will be shipped in the shipping package. Occurrence: Always
orders.channel	string	The marketplace where the order was created. Use the value `EBAY` to get the rates available for eBay orders. Occurrence: Always
orders.orderId	string	The unique identifier of the order. The getOrders method of the Fulfillment API can be used to retrieve order IDs. Occurrence: Always
packageSpecification	PackageSpecification	The weight and dimensions of the package covered by this shipping quote. Occurrence: Conditional
packageSpecification.dimensions	Dimensions	Declares the height, length, width, and unit of measure for the package to be shipped. Occurrence: Conditional
packageSpecification.dimensions.height	string	The numeric value of the height of the package. Occurrence: Conditional
packageSpecification.dimensions.length	string	The numeric value of the length of the package. Occurrence: Conditional
packageSpecification.dimensions.unit	LengthUnitOfMeasureEnum	The unit of measure used to express the height, length, and width of the package. Occurrence: Conditional
packageSpecification.dimensions.width	string	The numeric value of the width of the package. Occurrence: Conditional
packageSpecification.weight	Weight	Declares the weight of the package. Occurrence: Conditional
packageSpecification.weight.unit	WeightUnitOfMeasureEnum	The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are `POUND` and `OUNCE`. If the metric system of measurement is being used, the applicable values for weight units are `KILOGRAM` and `GRAM`. The metric system is used by most countries outside of the US. Occurrence: Conditional
packageSpecification.weight.value	string	The numeric value of the weight of the package, as measured by the value of unit. Occurrence: Conditional
rates	array of Rate	A list of rates where each rate, as identified by a rateId, contains information about a specific shipping service offered by a carrier. Rates include shipping carrier and service, the to and from locations, the pickup and delivery windows, the seller's shipping parameters, the service constraints, and the cost for the base service and a list of additional shipping options. Note: The Logistics API only supports USPS shipping rates and labels. Each rate offered is supported by a label service where you can purchase the rate, and associated shipping label, via a call to createFromShippingQuote. Occurrence: Conditional
rates.additionalOptions	array of AdditionalOption	Contains service and pricing information for one or more shipping options that are offered by the carrier and can be purchased in addition to the base shipping service provided by this rate. Shipping options can include items such as `INSURANCE` and `SIGNATURE`. Occurrence: Conditional
rates.additionalOptions.additionalCost	Amount	The monetary cost of the additional shipping option identified by the optionType field. Occurrence: Conditional
rates.additionalOptions.additionalCost.currency	CurrencyCodeEnum	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is `CAD`. Default: The default currency of the eBay marketplace that hosts the listing. Occurrence: Conditional
rates.additionalOptions.additionalCost.value	string	The monetary amount in the specified currency. Required in the amount type. Occurrence: Conditional
rates.additionalOptions.optionType	string	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. Occurrence: Conditional
rates.baseShippingCost	Amount	A live quote for the cost that the carrier (identified by shippingCarrierCode) is charging for the shipping service being offered (identified by shippingServiceCode), excluding any additional shipping options. Occurrence: Conditional
rates.baseShippingCost.currency	CurrencyCodeEnum	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is `CAD`. Default: The default currency of the eBay marketplace that hosts the listing. Occurrence: Conditional
rates.baseShippingCost.value	string	The monetary amount in the specified currency. Required in the amount type. Occurrence: Conditional
rates.destinationTimeZone	string	The name of the time zone region, as defined in the IANA Time Zone Database, to which the package is being shipped. Delivery dates are calculated relative to this time zone. Note: This is different from a Coordinated Universal Time (UTC) offset. For example, the America/Los_Angeles time zone identifies a region with the UTC standard time offset of `-08:00`, but so do several other time zones, including America/Tijuana,America/Dawson, and Pacific/Pitcairn. Occurrence: Conditional
rates.maxEstimatedDeliveryDate	string	The latest stated date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z` Example: `2018-08-20T07:09:00.000Z` Occurrence: Conditional
rates.minEstimatedDeliveryDate	string	The estimated earliest date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 UTC string. Occurrence: Conditional
rates.pickupNetworks	array of string	A list of pickup networks compatible with the shipping service. Occurrence: Conditional
rates.pickupSlots	array of PickupSlot	A list of available pickup slots for the package. Occurrence: Conditional
rates.pickupSlots.pickupSlotEndTime	string	The date and time the pickup slot ends, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z` Example: `2018-08-20T07:09:00.000Z` Occurrence: Conditional
rates.pickupSlots.pickupSlotId	string	Seller-defined name for the pickup slot. Occurrence: Conditional
rates.pickupSlots.pickupSlotStartTime	string	The date and time the pickup slot begins, formatted as an ISO 8601 UTC string. Occurrence: Conditional
rates.pickupSlots.pickupSlotTimeZone	string	The time zone of the pickup location, returned as Time Zone Database ID (also know as an Olson time zone ID). Occurrence: Conditional
rates.pickupType	PickupTypeEnum	The type of pickup or drop-off service associated with the pickupSlots time frames. Occurrence: Conditional
rates.rateId	string	The unique eBay-assigned ID for this shipping rate. Occurrence: Conditional
rates.rateRecommendation	array of RateRecommendationEnum	A list of reasons this rate is recommended. Available values are: `BUYER_CHOSEN` — The rate meets or exceeds the requirements of the buyer's preferred shipping option. `CHEAPEST_ON_TIME` — The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment. `EBAY_PLUS_OK` — The rate complies with the shipping requirements of the eBay Plus program. `FASTEST_ON_TIME` — The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment. `GUARANTEED_DELIVERY_OK` — The rate complies with the shipping requirements of the eBay Guaranteed Delivery program. Occurrence: Conditional
rates.shippingCarrierCode	string	The code name of the shipping carrier who will provide the service identified by shippingServiceCode. Occurrence: Conditional
rates.shippingCarrierName	string	The common name of the shipping carrier. Occurrence: Conditional
rates.shippingServiceCode	string	The code name of the shipping service to be provided by the carrier identified by shippingCarrierCode. Occurrence: Conditional
rates.shippingServiceName	string	The common name of the shipping service. Occurrence: Conditional
shipFrom	Contact	The address and contact details for the origin of the shipment. Occurrence: Conditional
shipFrom.companyName	string	The company name with which the contact is associated. Occurrence: Conditional
shipFrom.contactAddress	ContactAddress	The details of the contact's geographical address. Occurrence: Conditional
shipFrom.contactAddress.addressLine1	string	The first line of the street address. Occurrence: Always
shipFrom.contactAddress.addressLine2	string	The second line of the street address. Use this field for additional address information, such as a suite or apartment number. Occurrence: Conditional
shipFrom.contactAddress.city	string	The city in which the address is located. Occurrence: Conditional
shipFrom.contactAddress.countryCode	CountryCodeEnum	The country of the address, represented as two-letter ISO 3166 country code. For example, `US` represents the United States and `DE` represents Germany. Occurrence: Conditional
shipFrom.contactAddress.county	string	The county (not country) in which the address is located. Counties typically contain multiple cities or towns. Occurrence: Conditional
shipFrom.contactAddress.postalCode	string	The postal code of the address. Occurrence: Always
shipFrom.contactAddress.stateOrProvince	string	The state or province in which the address is located. States and provinces often contain multiple counties. Occurrence: Conditional
shipFrom.fullName	string	The contact's full name. Occurrence: Conditional
shipFrom.primaryPhone	PhoneNumber	The contact's primary telephone number. Occurrence: Conditional
shipFrom.primaryPhone.phoneNumber	string	A telephone number. Occurrence: Conditional
shippingQuoteId	string	The unique eBay-assigned ID for this shipping quote. The value of this field is associated with a specific package, based on its origin, destination, and size. Occurrence: Conditional
shipTo	Contact	The address and contact details for the origin of the shipment. Occurrence: Conditional
shipTo.companyName	string	The company name with which the contact is associated. Occurrence: Conditional
shipTo.contactAddress	ContactAddress	The details of the contact's geographical address. Occurrence: Conditional
shipTo.contactAddress.addressLine1	string	The first line of the street address. Occurrence: Always
shipTo.contactAddress.addressLine2	string	The second line of the street address. Use this field for additional address information, such as a suite or apartment number. Occurrence: Conditional
shipTo.contactAddress.city	string	The city in which the address is located. Occurrence: Conditional
shipTo.contactAddress.countryCode	CountryCodeEnum	The country of the address, represented as two-letter ISO 3166 country code. For example, `US` represents the United States and `DE` represents Germany. Occurrence: Conditional
shipTo.contactAddress.county	string	The county (not country) in which the address is located. Counties typically contain multiple cities or towns. Occurrence: Conditional
shipTo.contactAddress.postalCode	string	The postal code of the address. Occurrence: Always
shipTo.contactAddress.stateOrProvince	string	The state or province in which the address is located. States and provinces often contain multiple counties. Occurrence: Conditional
shipTo.fullName	string	The contact's full name. Occurrence: Conditional
shipTo.primaryPhone	PhoneNumber	The contact's primary telephone number. Occurrence: Conditional
shipTo.primaryPhone.phoneNumber	string	A telephone number. Occurrence: Conditional
warnings	array of ErrorDetailV3	A list of any warnings triggered by the request. Occurrence: Conditional
warnings.category	string	The category type for this error or warning. It takes a string that can have one of three values: `Application`: 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. `Business`: 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. `Request`: 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. Occurrence: Conditional
warnings.domain	string	Name of the domain containing the service or application. Occurrence: Conditional
warnings.errorId	integer	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. Occurrence: Conditional
warnings.inputRefIds	array of string	Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. Occurrence: Conditional
warnings.longMessage	string	An expanded version of message that should be around 100-200 characters long, but is not required to be such. Occurrence: Conditional
warnings.message	string	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. Occurrence: Conditional
warnings.outputRefIds	array of string	Identifies specific response elements associated with the error, if any. Path format is the same as `inputRefId`. Occurrence: Conditional
warnings.parameters	array of ErrorParameterV3	This optional complex field type contains a list of one or more context-specific `ErrorParameter` objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each `ErrorParameter` object consists of two fields, a `name` and a `value`. Occurrence: Conditional
warnings.parameters.name	string	Name of the entity that threw the error. Occurrence: Conditional
warnings.parameters.value	string	A description of the error. Occurrence: Conditional
warnings.subdomain	string	Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. Occurrence: NA

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	Success
404	Not Found
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
90000	API_LOGISTICS	APPLICATION	A system error has occurred.
90005	API_LOGISTICS	REQUEST	The resource could not be found.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve the details of a shipping quote

This example gets the details of an existing shipping quote.

Input

Supply the shippingQuoteId as a path parameter in your request.

GEThttps://api.ebay.com/sell/logistics/v1_beta/shipping_quote/Q********1

Output

If the call is successful, it returns the complete details of the selected shipping quote.

{
  "shippingQuoteId": "Q*****1",
  "creationDate": "2018-08-03T11:33:43Z",
  "expirationDate": "2018-08-03T11:43:43Z",
  "shipFrom": {
    "companyName": "T*****s",
    "contactAddress": {
      "addressLine1": "2*****e",
      "addressLine2": "B*****7",
      "city": "S*****e",
      "countryCode": "US",
      "county": null,
      "postalCode": "9****5",
      "stateOrProvince": "**"
    },
    "fullName": "S*****r",
    "primaryPhone": {
      "phoneNumber": "+1*********0"
    }
  },
  "shipTo": {
    "companyName": null,
    "contactAddress": {
      "addressLine1": "6*****e",
      "addressLine2": null,
      "city": "N*****k",
      "countryCode": "US",
      "county": null,
      "postalCode": "1****1",
      "stateOrProvince": "**"
    },
    "fullName": "B*****r",
    "primaryPhone": {
      "phoneNumber": "+1*********9"
    }
  },
  "packageSpecification": {
    "dimensions": {
      "width": "2",
      "length": "5",
      "height": "2",
      "unit": "INCH"
    },
    "weight": {
      "unit": "OUNCE",
      "value": "8"
    }
  },
  "rates": [
    {
      "rateId": "R*****1",
      "shippingServiceCode": "USPSFirstClass",
      "shippingServiceName": "USPS First Class Package",
      "shippingCarrierCode": "USPS",
      "shippingCarrierName": "USPS",
      "pickupType": "DROP_OFF",
      "baseShippingCost": {
        "value": "3.18",
        "currency": "USD"
      },
      "minEstimatedDeliveryDate": "2018-08-05T12:00:00Z",
      "maxEstimatedDeliveryDate": "2018-08-08T12:00:00Z",
      "destinationTimeZone": "EDT",
      "additionalOptions": [
        {
          "optionType": "SIGNATURE",
          "additionalCost": {
            "value": "2.55",
            "currency": "USD"
          }
        },
        {
          "optionType": "SHIPCOVER_INSURANCE",
          "additionalCost": {
            "value": "0.12",
            "currency": "USD"
          }
        }
      ],
      "rateRecommendation": []
    },
    {
      "rateId": "R*****2",
      "shippingServiceCode": "USPSPriorityFlatRate",
      "shippingServiceName": "USPS Priority Flat Rate Medium Box",
      "shippingCarrierCode": "USPS",
      "shippingCarrierName": "USPS",
      "pickupType": "DROP_OFF",
      "baseShippingCost": {
        "value": "12.85",
        "currency": "USD"
      },
      "minEstimatedDeliveryDate": "2018-08-04T12:00:00Z",
      "maxEstimatedDeliveryDate": "2018-08-05T12:00:00Z",
      "destinationTimeZone": "EDT",
      "additionalOptions": [
        {
          "optionType": "SIGNATURE",
          "additionalCost": {
            "value": "2.55",
            "currency": "USD"
          }
        },
        {
          "optionType": "SHIPCOVER_INSURANCE",
          "provider": "ShipCover - hardcoded",
          "additionalCost": {
            "value": "0.12",
            "currency": "USD"
          }
        }
      ],
      "rateRecommendation": []
    }
  ]
}