Skip to main content

GET/shipment/{shipmentId}

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

Input

Resource URI (production)

GET https://api.ebay.com/sell/logistics/v1_beta/shipment/{shipmentId}

URI parameters

ParameterTypeDescription
shipmentIdstringThis 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.

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

{ /* Shipment */
"orders" : [
{ /* Order */ }
],
}

Response fields

Output container/fieldTypeDescription
cancellationShipmentCancellation

Cancellation status for the package, if one exists.

Occurrence: Conditional

cancellation.cancellationRequestedDatestring

The time and date the request was made to cancel the shipment, formatted as an ISO 8601 UTC string.

Occurrence: Conditional

cancellation.cancellationStatusShipmentCancellationStatusEnum

This enum specifies the current cancellation status of a shipment, if a cancellation request has been made.

Occurrence: Conditional

creationDatestring

The date and time the shipment was created, 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

labelCustomMessagestring

If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label.

Occurrence: Conditional

labelDownloadUrlstring

The direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See downloadLabelFile for requesting different response file formats.

Occurrence: Conditional

labelSizestring

The seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the creaateFromShippingQuote call matches a size the carrier supports, the value will be represented here in the shipment.

Currently, the only valid value is: 4"x6"

Occurrence: Conditional

ordersarray of Order

This list value is optionally assigned by the seller. When present, each element in the returned list contains seller-assigned information about an order (such as an order number). Because a package can contain all or part of one or more orders, this field provides a way for sellers to identify the packages that contain specific orders.

Occurrence: Conditional

orders.channelstring

The e-commerce platform or environment where the order was created. Use the value EBAY to get the rates available for eBay orders.

Occurrence: Conditional

orders.orderIdstring

The unique ID of the order supplied by the channel of origin. For eBay orders, this would be the orderId.

Occurrence: Conditional

packageSpecificationPackageSpecification

The weight and dimensions of the package.

Occurrence: Conditional

packageSpecification.dimensionsDimensions

Declares the height, length, width, and unit of measure for the package to be shipped.

Occurrence: Conditional

packageSpecification.dimensions.heightstring

The numeric value of the height of the package.

Occurrence: Conditional

packageSpecification.dimensions.lengthstring

The numeric value of the length of the package.

Occurrence: Conditional

packageSpecification.dimensions.unitLengthUnitOfMeasureEnum

The unit of measure used to express the height, length, and width of the package.

Occurrence: Conditional

packageSpecification.dimensions.widthstring

The numeric value of the width of the package.

Occurrence: Conditional

packageSpecification.weightWeight

Declares the weight of the package.

Occurrence: Conditional

packageSpecification.weight.unitWeightUnitOfMeasureEnum

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.valuestring

The numeric value of the weight of the package, as measured by the value of unit.

Occurrence: Conditional

ratePurchasedRate

The shipping rate that the seller has chosen to purchase for this shipment. Each rate, identified by a rateId, contains the offered base service, options, and shipping parameters that were selected for the package shipment.

Occurrence: Conditional

rate.additionalOptionsarray of AdditionalOption

An list of additional, optional features that have been purchased for the shipment.

Occurrence: Conditional

rate.additionalOptions.additionalCostAmount

The monetary cost of the additional shipping option identified by the optionType field.

Occurrence: Conditional

rate.additionalOptions.additionalCost.currencyCurrencyCodeEnum

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

rate.additionalOptions.additionalCost.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

rate.additionalOptions.optionTypestring

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

rate.baseShippingCostAmount

The amount of the "base cost" for the shipment as set by the given carrier for the specified service. This cost excludes any addition costs accrued from the addition of any optional shipping options.

Occurrence: Conditional

rate.baseShippingCost.currencyCurrencyCodeEnum

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

rate.baseShippingCost.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

rate.destinationTimeZonestring

The time zone of the destination according to Time Zone Database. For example, "America/Los_Angeles".

Occurrence: Conditional

rate.maxEstimatedDeliveryDatestring

A string value representing maximum (latest) estimated delivery time, 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

rate.minEstimatedDeliveryDatestring

A string value representing minimum (earliest) estimated delivery time, formatted as an ISO 8601ISO 8601 UTC string.

Occurrence: Conditional

rate.pickupNetworksarray of string

A list of pickup networks compatible with the shipping service.

Occurrence: Conditional

rate.pickupSlotIdstring

This unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup.

Occurrence: Conditional

rate.pickupTypePickupTypeEnum

The type of pickup or drop off configured for the shipment.

Occurrence: Conditional

rate.rateIdstring

The eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment.

Occurrence: Conditional

rate.shippingCarrierCodestring

The ID code for the carrier that was selected for the package shipment.

Occurrence: Conditional

rate.shippingCarrierNamestring

The name of the shipping carrier.

Occurrence: Conditional

rate.shippingQuoteIdstring

The unique eBay-generated ID of the shipping quote from which the seller selected a shipping rate (rateId).

Occurrence: Conditional

rate.shippingServiceCodestring

String ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies.

Occurrence: Conditional

rate.shippingServiceNamestring

The name of the shipping service.

Occurrence: Conditional

rate.totalShippingCostAmount

The total shipping cost, which is the sum cost of the base shipping cost and the cost of all the selected shipping options.

Occurrence: Conditional

rate.totalShippingCost.currencyCurrencyCodeEnum

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

rate.totalShippingCost.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

returnToContact

The address and contact details that should be used for item returns. Sellers have the option to define a return address that is different from their shipFrom address. If not specified, the return address defaults to the shipFrom address in the shipping quote.

Occurrence: Conditional

returnTo.companyNamestring

The company name with which the contact is associated.

Occurrence: Conditional

returnTo.contactAddressContactAddress

The details of the contact's geographical address.

Occurrence: Conditional

returnTo.contactAddress.addressLine1string

The first line of the street address.

Occurrence: Always

returnTo.contactAddress.addressLine2string

The second line of the street address. Use this field for additional address information, such as a suite or apartment number.

Occurrence: Conditional

returnTo.contactAddress.citystring

The city in which the address is located.

Occurrence: Conditional

returnTo.contactAddress.countryCodeCountryCodeEnum

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

returnTo.contactAddress.countystring

The county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

returnTo.contactAddress.postalCodestring

The postal code of the address.

Occurrence: Always

returnTo.contactAddress.stateOrProvincestring

The state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

returnTo.fullNamestring

The contact's full name.

Occurrence: Conditional

returnTo.primaryPhonePhoneNumber

The contact's primary telephone number.

Occurrence: Conditional

returnTo.primaryPhone.phoneNumberstring

A telephone number.

Occurrence: Conditional

shipFromContact

The address and contact details for the origin of the package shipment.

Occurrence: Conditional

shipFrom.companyNamestring

The company name with which the contact is associated.

Occurrence: Conditional

shipFrom.contactAddressContactAddress

The details of the contact's geographical address.

Occurrence: Conditional

shipFrom.contactAddress.addressLine1string

The first line of the street address.

Occurrence: Always

shipFrom.contactAddress.addressLine2string

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.citystring

The city in which the address is located.

Occurrence: Conditional

shipFrom.contactAddress.countryCodeCountryCodeEnum

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.countystring

The county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

shipFrom.contactAddress.postalCodestring

The postal code of the address.

Occurrence: Always

shipFrom.contactAddress.stateOrProvincestring

The state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

shipFrom.fullNamestring

The contact's full name.

Occurrence: Conditional

shipFrom.primaryPhonePhoneNumber

The contact's primary telephone number.

Occurrence: Conditional

shipFrom.primaryPhone.phoneNumberstring

A telephone number.

Occurrence: Conditional

shipmentIdstring

The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to createFromShippingQuote.

Occurrence: Conditional

shipmentTrackingNumberstring

A unique carrier-assigned ID string that can be used to track the shipment.

Occurrence: Conditional

shipToContact

The address and contact details for the destination of the shipment.

Occurrence: Conditional

shipTo.companyNamestring

The company name with which the contact is associated.

Occurrence: Conditional

shipTo.contactAddressContactAddress

The details of the contact's geographical address.

Occurrence: Conditional

shipTo.contactAddress.addressLine1string

The first line of the street address.

Occurrence: Always

shipTo.contactAddress.addressLine2string

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.citystring

The city in which the address is located.

Occurrence: Conditional

shipTo.contactAddress.countryCodeCountryCodeEnum

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.countystring

The county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

shipTo.contactAddress.postalCodestring

The postal code of the address.

Occurrence: Always

shipTo.contactAddress.stateOrProvincestring

The state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

shipTo.fullNamestring

The contact's full name.

Occurrence: Conditional

shipTo.primaryPhonePhoneNumber

The contact's primary telephone number.

Occurrence: Conditional

shipTo.primaryPhone.phoneNumberstring

A telephone number.

Occurrence: Conditional

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.

StatusMeaning
200Success
404Not Found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
90000API_LOGISTICSAPPLICATIONA system error has occurred.
90005API_LOGISTICSREQUESTThe 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: Get the details of an existing shipment

Use the getShippingQuote method to retrieve 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/shipment/S********1

Output

If the call is successful, the full details of the specified shipping quote are returned.