logistics APIv1_beta.0.0

Shipment

This complex type defines a shipment for a specific package (for example, a box or letter). Shipments are always linked to a purchased shipping label.

Types that use Shipment

Not used by any types

Calls that use Shipment

Fields

Field
Type
Description
cancellation
Cancellation status for the package, if one exists.
creationDate
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
labelCustomMessage
If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label.
labelDownloadUrl
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.
labelSize
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"
orders
array 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.
packageSpecification
The weight and dimensions of the package.
rate
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.
returnTo
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.
shipFrom
The address and contact details for the origin of the package shipment.
shipmentId
The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to createFromShippingQuote.
shipmentTrackingNumber
A unique carrier-assigned ID string that can be used to track the shipment.
shipTo
The address and contact details for the destination of the shipment.