Logistics API — client.sell.logistics¶
Version v1_beta.0.0 · base path /sell/logistics/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
cancel_shipment ¶
cancel_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_logistics_models.Shipment
cancel_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
cancel_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_logistics_models.Shipment | httpx.Response
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.
create_from_shipping_quote ¶
create_from_shipping_quote(*, body: CreateShipmentFromQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_logistics_models.Shipment
create_from_shipping_quote(*, body: CreateShipmentFromQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_from_shipping_quote(*, body: CreateShipmentFromQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_logistics_models.Shipment | httpx.Response
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.
download_label_file ¶
download_label_file(shipment_id: str, *, accept: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
download_label_file(shipment_id: str, *, accept: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
download_label_file(shipment_id: str, *, accept: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
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. Note: The Logistics API only supports USPS shipping rates and labels. Use the Accept HTTP header to specify the format of the returned file. The default file format is a PDF file.
get_shipment ¶
get_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_logistics_models.Shipment
get_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipment(shipment_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_logistics_models.Shipment | httpx.Response
This method retrieves the shipment details for the specified shipment ID. Call createFromShippingQuote to generate a shipment ID.
create_shipping_quote ¶
create_shipping_quote(*, body: ShippingQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_logistics_models.ShippingQuote
create_shipping_quote(*, body: ShippingQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_shipping_quote(*, body: ShippingQuoteRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_logistics_models.ShippingQuote | httpx.Response
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.
get_shipping_quote ¶
get_shipping_quote(shipping_quote_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_logistics_models.ShippingQuote
get_shipping_quote(shipping_quote_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_quote(shipping_quote_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_logistics_models.ShippingQuote | httpx.Response
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.
Models¶
CountryCodeEnum ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
ErrorParameterV3 ¶
LengthUnitOfMeasureEnum ¶
Order ¶
Bases: EbayModel
channel
class-attribute
instance-attribute
¶
channel = Field(None, description='The marketplace where the order was created. Currently, only EBAY is supported. This value can be used to retrieve rates available for eBay orders.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the order. The getOrders method of the Fulfillment API can be used to retrieve order IDs.')
PhoneNumber ¶
Bases: EbayModel
phone_number
class-attribute
instance-attribute
¶
phone_number = Field(None, alias='phoneNumber', description='A telephone number.')
PickupSlot ¶
Bases: EbayModel
pickup_slot_end_time
class-attribute
instance-attribute
¶
pickup_slot_end_time = Field(None, alias='pickupSlotEndTime', description='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')
pickup_slot_id
class-attribute
instance-attribute
¶
pickup_slot_id = Field(None, alias='pickupSlotId', description='Seller-defined name for the pickup slot.')
pickup_slot_start_time
class-attribute
instance-attribute
¶
pickup_slot_start_time = Field(None, alias='pickupSlotStartTime', description='The date and time the pickup slot begins, formatted as an ISO 8601 UTC string.')
pickup_slot_time_zone
class-attribute
instance-attribute
¶
pickup_slot_time_zone = Field(None, alias='pickupSlotTimeZone', description='The time zone of the pickup location, returned as Time Zone Database ID (also known as an Olson time zone ID).')
PickupTypeEnum ¶
RateRecommendationEnum ¶
Bases: OpenStrEnum
guaranteed_delivery_ok
class-attribute
instance-attribute
¶
guaranteed_delivery_ok = 'GUARANTEED_DELIVERY_OK'
ShipmentCancellationStatusEnum ¶
Bases: OpenStrEnum
cancellation_requested
class-attribute
instance-attribute
¶
cancellation_requested = 'CANCELLATION_REQUESTED'
cancellation_accepted
class-attribute
instance-attribute
¶
cancellation_accepted = 'CANCELLATION_ACCEPTED'
cancellation_rejected
class-attribute
instance-attribute
¶
cancellation_rejected = 'CANCELLATION_REJECTED'
WeightUnitOfMeasureEnum ¶
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='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.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the specified currency . Required in the amount type.')
ContactAddress ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of the street address. Use this field for additional address information, such as a suite or apartment number.')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city in which the address is located.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The country of the address, represented as two-letter ISO 3166 country code. For example, US represents the United States and DE represents Germany.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county (not country) in which the address is located. Counties typically contain multiple cities or towns.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the address.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province in which the address is located. States and provinces often contain multiple counties.')
Dimensions ¶
Bases: EbayModel
height
class-attribute
instance-attribute
¶
height = Field(None, description='The numeric value of the height of the package.')
length
class-attribute
instance-attribute
¶
length = Field(None, description='The numeric value of the length of the package.')
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='The unit of measure used to express the height, length, and width of the package.')
width
class-attribute
instance-attribute
¶
width = Field(None, description='The numeric value of the width of the package.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description="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.")
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name of the domain containing the service or application.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', 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.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.")
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='An expanded version of message that should be around 100-200 characters long, but is not required to be such.')
message
class-attribute
instance-attribute
¶
message = Field(None, 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.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='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 .')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description="Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.")
ShipmentCancellation ¶
Bases: EbayModel
cancellation_requested_date
class-attribute
instance-attribute
¶
cancellation_requested_date = Field(None, alias='cancellationRequestedDate', description='The time and date the request was made to cancel the shipment, formatted as an ISO 8601 UTC string.')
cancellation_status
class-attribute
instance-attribute
¶
cancellation_status = Field(None, alias='cancellationStatus', description='This enum specifies the current cancellation status of a shipment, if a cancellation request has been made.')
Weight ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='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 .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The numeric value of the weight of the package, as measured by the value of unit .')
AdditionalOption ¶
Bases: EbayModel
additional_cost
class-attribute
instance-attribute
¶
additional_cost = Field(None, alias='additionalCost', description='The monetary cost of the additional shipping option identified by the optionType field.')
option_type
class-attribute
instance-attribute
¶
option_type = Field(None, alias='optionType', 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.')
Contact ¶
Bases: EbayModel
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The company name with which the contact is associated.')
contact_address
class-attribute
instance-attribute
¶
contact_address = Field(None, alias='contactAddress', description="The details of the contact's geographical address.")
full_name
class-attribute
instance-attribute
¶
full_name = Field(None, alias='fullName', description="The contact's full name.")
primary_phone
class-attribute
instance-attribute
¶
primary_phone = Field(None, alias='primaryPhone', description="The contact's primary telephone number.")
CreateShipmentFromQuoteRequest ¶
Bases: EbayModel
additional_options
class-attribute
instance-attribute
¶
additional_options = Field(None, alias='additionalOptions', description="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.")
label_custom_message
class-attribute
instance-attribute
¶
label_custom_message = Field(None, alias='labelCustomMessage', description='Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels.')
label_size
class-attribute
instance-attribute
¶
label_size = Field(None, alias='labelSize', 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. Currently, the only valid value is: 4"x6"')
rate_id
class-attribute
instance-attribute
¶
rate_id = Field(None, alias='rateId', description='The unique eBay-assigned identifier of the shipping rate that the seller selected for the shipment. This value is generated by using the createShippingQuote method and is returned in the rates.rateId field.')
return_to
class-attribute
instance-attribute
¶
return_to = Field(None, alias='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 shipFrom address returned in shipping quote.')
shipping_quote_id
class-attribute
instance-attribute
¶
shipping_quote_id = Field(None, alias='shippingQuoteId', description='The unique eBay-assigned identifier of the shipping quote that was generated by the createShippingQuote method.')
PackageSpecification ¶
Bases: EbayModel
PurchasedRate ¶
Bases: EbayModel
additional_options
class-attribute
instance-attribute
¶
additional_options = Field(None, alias='additionalOptions', description='A list of additional, optional features that have been purchased for the shipment.')
base_shipping_cost
class-attribute
instance-attribute
¶
base_shipping_cost = Field(None, alias='baseShippingCost', description='The amount of the "base cost" for the shipment as set by the given carrier for the specified service. This cost excludes any additional costs accrued from the addition of any optional shipping options.')
destination_time_zone
class-attribute
instance-attribute
¶
destination_time_zone = Field(None, alias='destinationTimeZone', description='The time zone of the destination according to Time Zone Database . For example, "America/Los_Angeles".')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='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')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='A string value representing minimum (earliest) estimated delivery time, formatted as an ISO 8601 UTC string.')
pickup_networks
class-attribute
instance-attribute
¶
pickup_networks = Field(None, alias='pickupNetworks', description='A list of pickup networks compatible with the shipping service.')
pickup_slot_id
class-attribute
instance-attribute
¶
pickup_slot_id = Field(None, alias='pickupSlotId', description='This unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup.')
pickup_type
class-attribute
instance-attribute
¶
pickup_type = Field(None, alias='pickupType', description='The type of pickup or drop-off configured for the shipment.')
rate_id
class-attribute
instance-attribute
¶
rate_id = Field(None, alias='rateId', description='The eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment.')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='The ID code for the carrier that was selected for the package shipment.')
shipping_carrier_name
class-attribute
instance-attribute
¶
shipping_carrier_name = Field(None, alias='shippingCarrierName', description='The name of the shipping carrier.')
shipping_quote_id
class-attribute
instance-attribute
¶
shipping_quote_id = Field(None, alias='shippingQuoteId', description='The unique eBay-generated ID of the shipping quote from which the seller selected a shipping rate ( rateId ).')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='String ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies.')
shipping_service_name
class-attribute
instance-attribute
¶
shipping_service_name = Field(None, alias='shippingServiceName', description='The name of the shipping service.')
total_shipping_cost
class-attribute
instance-attribute
¶
total_shipping_cost = Field(None, alias='totalShippingCost', description='The total shipping cost, which is the sum cost of the base shipping cost and the cost of all the selected shipping options.')
Rate ¶
Bases: EbayModel
additional_options
class-attribute
instance-attribute
¶
additional_options = Field(None, alias='additionalOptions', description='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 .')
base_shipping_cost
class-attribute
instance-attribute
¶
base_shipping_cost = Field(None, alias='baseShippingCost', description='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.')
destination_time_zone
class-attribute
instance-attribute
¶
destination_time_zone = Field(None, alias='destinationTimeZone', description='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.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='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')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='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.')
pickup_networks
class-attribute
instance-attribute
¶
pickup_networks = Field(None, alias='pickupNetworks', description='A list of pickup networks compatible with the shipping service.')
pickup_slots
class-attribute
instance-attribute
¶
pickup_slots = Field(None, alias='pickupSlots', description='A list of available pickup slots for the package.')
pickup_type
class-attribute
instance-attribute
¶
pickup_type = Field(None, alias='pickupType', description='The type of pickup or drop-off service associated with the pickupSlots time frames.')
rate_id
class-attribute
instance-attribute
¶
rate_id = Field(None, alias='rateId', description='The unique eBay-assigned ID for this shipping rate.')
rate_recommendation
class-attribute
instance-attribute
¶
rate_recommendation = Field(None, alias='rateRecommendation', description="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.")
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='The code name of the shipping carrier who will provide the service identified by shippingServiceCode .')
shipping_carrier_name
class-attribute
instance-attribute
¶
shipping_carrier_name = Field(None, alias='shippingCarrierName', description='The common name of the shipping carrier.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='The code name of the shipping service to be provided by the carrier identified by shippingCarrierCode .')
shipping_service_name
class-attribute
instance-attribute
¶
shipping_service_name = Field(None, alias='shippingServiceName', description='The common name of the shipping service.')
Shipment ¶
Bases: EbayModel
cancellation
class-attribute
instance-attribute
¶
cancellation = Field(None, description='Cancellation status for the package, if one exists.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='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')
label_custom_message
class-attribute
instance-attribute
¶
label_custom_message = Field(None, alias='labelCustomMessage', description='If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label.')
label_download_url
class-attribute
instance-attribute
¶
label_download_url = Field(None, alias='labelDownloadUrl', description='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.')
label_size
class-attribute
instance-attribute
¶
label_size = Field(None, alias='labelSize', description='The seller\'s desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the createFromShippingQuote 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
class-attribute
instance-attribute
¶
orders = Field(None, description='A list of one or more orders that will be shipped in the shipping package.')
package_specification
class-attribute
instance-attribute
¶
package_specification = Field(None, alias='packageSpecification', description='The weight and dimensions of the package.')
rate
class-attribute
instance-attribute
¶
rate = Field(None, description='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.')
return_to
class-attribute
instance-attribute
¶
return_to = Field(None, alias='returnTo', description='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.')
ship_from
class-attribute
instance-attribute
¶
ship_from = Field(None, alias='shipFrom', description='The address and contact details for the origin of the package shipment.')
shipment_id
class-attribute
instance-attribute
¶
shipment_id = Field(None, alias='shipmentId', description='The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to createFromShippingQuote .')
shipment_tracking_number
class-attribute
instance-attribute
¶
shipment_tracking_number = Field(None, alias='shipmentTrackingNumber', description='A unique carrier-assigned ID string that can be used to track the shipment.')
ship_to
class-attribute
instance-attribute
¶
ship_to = Field(None, alias='shipTo', description='The address and contact details for the destination of the shipment.')
ShippingQuote ¶
Bases: EbayModel
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date and time this quote was created, expressed as an ISO 8601 UTC string.')
expiration_date
class-attribute
instance-attribute
¶
expiration_date = Field(None, alias='expirationDate', description='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.')
orders
class-attribute
instance-attribute
¶
orders = Field(None, description='A list of one or more orders that will be shipped in the shipping package.')
package_specification
class-attribute
instance-attribute
¶
package_specification = Field(None, alias='packageSpecification', description='The weight and dimensions of the package covered by this shipping quote.')
rates
class-attribute
instance-attribute
¶
rates = Field(None, description="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.")
ship_from
class-attribute
instance-attribute
¶
ship_from = Field(None, alias='shipFrom', description='The address and contact details for the origin of the shipment.')
shipping_quote_id
class-attribute
instance-attribute
¶
shipping_quote_id = Field(None, alias='shippingQuoteId', description='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.')
ship_to
class-attribute
instance-attribute
¶
ship_to = Field(None, alias='shipTo', description='The address and contact details for the destination of the shipment.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of any warnings triggered by the request.')
ShippingQuoteRequest ¶
Bases: EbayModel
orders
class-attribute
instance-attribute
¶
orders = Field(None, description='In this array, the seller specifies one or more orders that will be shipped in the shipping package. A shipping 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')
package_specification
class-attribute
instance-attribute
¶
package_specification = Field(None, alias='packageSpecification', description='Declares the weight and dimensions of the package.')
ship_from
class-attribute
instance-attribute
¶
ship_from = Field(None, alias='shipFrom', description='The address and contact details pertaining to the origin of the shipment.')
ship_to
class-attribute
instance-attribute
¶
ship_to = Field(None, alias='shipTo', description="The address and contact details pertaining to the shipment's destination.")