EDIS public shipping API — client.sell.edelivery_international_shipping¶
Version 1.1.0 · base path /sell/edelivery_international_shipping/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_actual_costs ¶
get_actual_costs(*, tracking_numbers: str | None = None, trans_begin_time: str | None = None, trans_end_time: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetActualCostResponses
get_actual_costs(*, tracking_numbers: str | None = None, trans_begin_time: str | None = None, trans_end_time: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_actual_costs(*, tracking_numbers: str | None = None, trans_begin_time: str | None = None, trans_end_time: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetActualCostResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method is used to retrieve the actual weight and cost for one or more packages based on the provided input criteria. Responses can be filtered by the tracking_numbers query parameter.
get_address_preferences ¶
get_address_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetAddressPreferenceListResponses
get_address_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_address_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetAddressPreferenceListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve information about all the ship-from and/or return addresses associated with a seller's eDIS account.
create_address_preference ¶
create_address_preference(*, body: CreateAddressPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.CreateAddressPreferenceResponses
create_address_preference(*, body: CreateAddressPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_address_preference(*, body: CreateAddressPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.CreateAddressPreferenceResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to create an address on your eDIS account.
get_agents ¶
get_agents(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetAgentListResponses
get_agents(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_agents(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetAgentListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve information about the EU Authorized Representative (AR) agent(s) associated with a seller's eDIS account. An EU AR agent acts as a liaison between non-EU manufacturers and European regulatory authorities to ensure compliance with EU regulations.
get_battery_qualifications ¶
get_battery_qualifications(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetBatteryQualListResponses
get_battery_qualifications(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_battery_qualifications(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetBatteryQualListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method is used to retrieve all battery qualifications associated with your eDIS account. This includes the type, electronic qualification ID and name, and expiration date for each battery.
cancel_bundle ¶
cancel_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
cancel_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
cancel_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method is used to cancel a bundle. The bundleId value of the bundle to be canceled must be input as a path parameter in the request. Note: Bundles cannot be canceled if they are currently being processed.
create_bundle ¶
create_bundle(*, body: CreateBundleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.CreateBundleResponse
create_bundle(*, body: CreateBundleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_bundle(*, body: CreateBundleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.CreateBundleResponse | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method is used to create a bundle for multiple packages in an order. To create a bundle, the consign address to be associated with the bundle and the tracking numbers of the packages to be used in the bundle must be specified in the request.
get_bundle ¶
get_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.BundleDetailResponse
get_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_bundle(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.BundleDetailResponse | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method is used to retrieved information about a specific bundle based on the provided bundle ID value. The bundle_id value of the bundle to be retrieved must be input as a path parameter in the request.
get_bundle_label ¶
get_bundle_label(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.BundleLabelResponse
get_bundle_label(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_bundle_label(bundle_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.BundleLabelResponse | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve the bundle label for a bundle of packages. The bundle for which to retrieve a bundle label is specified through the bundleId path parameter. Bundle labels will be returned as base64 string values which can be converted to PDF files.
create_complaint ¶
create_complaint(*, body: AddComplaintRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_complaint(*, body: AddComplaintRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_complaint(*, body: AddComplaintRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to create a complaint about a shipment order. Complaints can be filed if there is a pickup delay on an order or if an item has been lost in transit. The complaint reason, complaint type, and the date the issue occurred must be specified in the request.
get_consign_preferences ¶
get_consign_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetConsignPreferenceListResponses
get_consign_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_consign_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetConsignPreferenceListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve information about all the pickup, drop-off, and/or forward deployment consign addresses associated with a seller's eDIS account.
create_consign_preference ¶
create_consign_preference(*, body: CreateConsignPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.CreateConsignPreferenceResponses
create_consign_preference(*, body: CreateConsignPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_consign_preference(*, body: CreateConsignPreferenceRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.CreateConsignPreferenceResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to create a consign address.
get_dropoff_sites ¶
get_dropoff_sites(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetDropoffSiteListResponses
get_dropoff_sites(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_dropoff_sites(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetDropoffSiteListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve metadata for one or more drop-off sites associated with a seller's eDIS account. Pagination query parameters are provided that allow users to control how many drop-off site locations are returned in the response.
get_handover_sheet ¶
get_handover_sheet(*, tracking_numbers: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetHandoverSheetResponses
get_handover_sheet(*, tracking_numbers: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_handover_sheet(*, tracking_numbers: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetHandoverSheetResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve the handover sheet for one or more packages in a pickup request. The tracking numbers for the packages for which to retrieve handover sheets are specified through the tracking_numbers query parameter.
get_labels ¶
get_labels(*, tracking_numbers: str, page_size: str | None = None, print_preference: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetLabelListResponses
get_labels(*, tracking_numbers: str, page_size: str | None = None, print_preference: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_labels(*, tracking_numbers: str, page_size: str | None = None, print_preference: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetLabelListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve shipping labels for the one or more specified packages. The packages for which to retrieve shipping labels can be specified through the tracking_numbers query parameter.
bulk_cancel_packages ¶
bulk_cancel_packages(*, body: CancelPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.CancelPackagesResponses
bulk_cancel_packages(*, body: CancelPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_cancel_packages(*, body: CancelPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.CancelPackagesResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to cancel multiple packages and their associated tracking numbers. The package ID values for the packages to be canceled must be input in the packageIds array of the request. Note: Packages cannot be cancelled if they are currently being processed.
bulk_confirm_packages ¶
bulk_confirm_packages(*, body: ConfirmPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.ConfirmPackagesResponses
bulk_confirm_packages(*, body: ConfirmPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_confirm_packages(*, body: ConfirmPackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.ConfirmPackagesResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to confirm the shipping order for multiple packages. The package ID values for the packages to be confirmed must be input in the packageIds array of the request.
bulk_delete_packages ¶
bulk_delete_packages(*, body: DeletePackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.DeletePackagesResponses
bulk_delete_packages(*, body: DeletePackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_delete_packages(*, body: DeletePackagesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.DeletePackagesResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to delete multiple packages. The package ID values for the packages to be deleted must be input in the packageIds array of the request.
cancel_package ¶
cancel_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
cancel_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
cancel_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to cancel a package and its associated tracking number. The packageId value of the package to be canceled must be input as a path parameter in the request. Note: Packages cannot be canceled if they are currently being processed.
clone_package ¶
clone_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.ClonePackageResponses
clone_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
clone_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.ClonePackageResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to clone a package for redelivery, resending the package with the same information input during the createPackage call. The packageId value of the package to be cloned must be input as a path parameter in the request.
confirm_package ¶
confirm_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
confirm_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
confirm_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to confirm the shipping order for a package. The packageId value of the package to be confirmed must be input as a path parameter in the request. After confirmation the estimated cost will be frozen in your wallet and the pickup request will be submitted.
create_package ¶
create_package(*, body: AddPackageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.AddPackageResponses
create_package(*, body: AddPackageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_package(*, body: AddPackageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.AddPackageResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to create a package for an order. To create a package, the package's shipping information, such as the dimensions, weight, ship from, and ship to address, as well as information about the item(s) it contains must be specified in the request.
get_package ¶
get_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetPackageDetailResponses
get_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetPackageDetailResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve a package based on the provided package ID value. The packageId value of the package to be retrieved must be input as a path parameter in the request.
delete_package ¶
delete_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_package(package_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to delete a package. The packageId value of the package to be deleted must be input as a path parameter in the request. If the call is successful, HTTP status code 204 No Content will be returned, and the package will be deleted.
get_packages_by_line_item_id ¶
get_packages_by_line_item_id(order_line_item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetItemPackageIdResponses
get_packages_by_line_item_id(order_line_item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_packages_by_line_item_id(order_line_item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetItemPackageIdResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve one or more packages based on the provided order line item ID. This method can be followed up with getPackage call to retrieve more detailed information about a specific package.
get_services ¶
get_services(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetServiceListResponses
get_services(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_services(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetServiceListResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve metadata on available shipping services, such as the name, description, and directions.
get_tracking ¶
get_tracking(*, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_edelivery_international_shipping_models.GetTrackingDetailResponses
get_tracking(*, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_tracking(*, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_edelivery_international_shipping_models.GetTrackingDetailResponses | httpx.Response
Important! This method is only available for Greater-China based sellers with an active eDIS account. This method can be used to retrieve tracking event details for a package associated with the provided tracking number. Each tracking event is returned in the trackingDetails array and includes the description, location, time, and status of the event.
Models¶
AddressTypeEnum ¶
AgentInfoData ¶
Bases: EbayModel
agent_address
class-attribute
instance-attribute
¶
agent_address = Field(None, alias='agentAddress', description='The address of the EU AR agent.')
agent_name
class-attribute
instance-attribute
¶
agent_name = Field(None, alias='agentName', description='The name of the EU AR agent.')
agent_phone
class-attribute
instance-attribute
¶
agent_phone = Field(None, alias='agentPhone', description='The phone number of the EU AR agent.')
AgentPreferenceListResponse ¶
Bases: EbayModel
ebay_id
class-attribute
instance-attribute
¶
ebay_id = Field(None, alias='ebayId', description='The eBay ID of the EU AR agent.')
shipping_country
class-attribute
instance-attribute
¶
shipping_country = Field(None, alias='shippingCountry', description='The two-letter ISO 3166 code of the shipping country that an EU AR agent supports.')
BundleDetailResponseData ¶
Bases: EbayModel
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the consign address associated with the retrieved bundle.')
tracking_numbers
class-attribute
instance-attribute
¶
tracking_numbers = Field(None, alias='trackingNumbers', description='This array specifies the tracking numbers of the packages included in the bundle.')
BundleLabelResponseData ¶
Bases: EbayModel
base64_str
class-attribute
instance-attribute
¶
base64_str = Field(None, alias='base64Str', description='The base 64 string value for the bundle label. This string value can be converted into a PDF file.')
CancelPackagesRequestData ¶
Bases: EbayModel
package_ids
class-attribute
instance-attribute
¶
package_ids = Field(None, alias='packageIds', description='This comma-delimited array lists the unique identifiers of the packages being canceled. Up to 200 package IDs can be specified.')
CancelPackagesResponsesData ¶
Bases: EbayModel
message
class-attribute
instance-attribute
¶
message = Field(None, description='This string returns any additional information about the cancelation of the package.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the canceled package.')
result_code
class-attribute
instance-attribute
¶
result_code = Field(None, alias='resultCode', description='The result code detailing the results cancelation process. For example, a result code of 200 indicates that the call was a success and the package and tracking number were canceled.')
ComplaintTypeEnum ¶
ConfirmPackagesRequestData ¶
Bases: EbayModel
package_ids
class-attribute
instance-attribute
¶
package_ids = Field(None, alias='packageIds', description='This comma-delimited array lists the unique identifiers of the packages being confirmed. Up to 200 packages can be specified.')
ConfirmPackagesResponsesData ¶
Bases: EbayModel
message
class-attribute
instance-attribute
¶
message = Field(None, description='This string returns any additional information about the confirmation of the package.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the confirmed package.')
result_code
class-attribute
instance-attribute
¶
result_code = Field(None, alias='resultCode', description='The result code relating to the confirmation of the package. For example, a result code of 200 indicates that the call was a success and the package was confirmed.')
ConsignTypeEnum ¶
Bases: OpenStrEnum
CreateAddressPreferenceRequestData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the address. See 商户API地址编码主数据 for valid city codes.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The company name associated with the address. Max length : 50 characters')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the address. Max length : 50 characters')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the address. Valid values : CN HK')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the address. See 商户API地址编码主数据 for valid district codes.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the address. Max length : 50 characters')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the address. See 商户API地址编码主数据 for valid province codes.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the address. Max length : 50 characters')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line, if applicable, of the street address of the address. Max length : 50 characters')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line, if applicable, of the street address of the address. Max length : 50 characters')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The address type of the address being created. Valid values : SHIP_FROM_ADDRESS RETURN_ADRESS')
CreateAddressPreferenceResponsesData ¶
Bases: EbayModel
address_id
class-attribute
instance-attribute
¶
address_id = Field(None, alias='addressId', description='The unique identifier of the newly-created address. This ID value can be used when creating a package through the createPackage method to specify the ship-from or return address associated with the package.')
CreateBundleRequestData ¶
Bases: EbayModel
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the consign address to be associated with the bundle. This ID can be retrieved using the getConsignPreferences method.')
tracking_numbers
class-attribute
instance-attribute
¶
tracking_numbers = Field(None, alias='trackingNumbers', description='This array specifies the tracking numbers of the packages to be included in the bundle. Tracking numbers are returned when creating a package through the createPackage method.')
CreateBundleResponseData ¶
Bases: EbayModel
bundle_id
class-attribute
instance-attribute
¶
bundle_id = Field(None, alias='bundleId', description='The unique identifier of the newly created bundle.')
CreateConsignPreferenceResponsesData ¶
Bases: EbayModel
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the newly-created consign address. This ID can be used when creating a package through the createPackage method to specify the pickup, drop-off, or forward deployment address associated with the package.')
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DeletePackagesRequestData ¶
Bases: EbayModel
package_ids
class-attribute
instance-attribute
¶
package_ids = Field(None, alias='packageIds', description='This comma-delimited array lists the unique identifiers of the packages being deleted. These values must be for packages that have been cancelled and do not have tracking numbers associated with them. Package ID values are returned when creating a package through the createPackage method.')
DeletePackagesResponsesData ¶
Bases: EbayModel
message
class-attribute
instance-attribute
¶
message = Field(None, description='This string returns any additional information about the deletion of the package.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the deleted package.')
result_code
class-attribute
instance-attribute
¶
result_code = Field(None, alias='resultCode', description='The result code detailing the result of the deletion process. For example, a result code of 200 indicates that the call was a success and the package was deleted.')
DirectionsResponses ¶
Bases: EbayModel
battery_type
class-attribute
instance-attribute
¶
battery_type = Field(None, alias='batteryType', description='The supported battery type for the shipping service.')
from_
class-attribute
instance-attribute
¶
from_ = Field(None, alias='from', description='The two-letter ISO 3166 ship-from country code.')
to
class-attribute
instance-attribute
¶
to = Field(None, description='The two-letter ISO 3166 destination country code.')
ErrorParameter ¶
FDCSkuRequest ¶
GetAddressPreferencesResponses ¶
Bases: EbayModel
address_id
class-attribute
instance-attribute
¶
address_id = Field(None, alias='addressId', description='The unique identifier of the address.')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the address. See 商户API地址编码主数据 for valid city codes.')
city_name
class-attribute
instance-attribute
¶
city_name = Field(None, alias='cityName', description='The city name of the address.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The company name associated with the address.')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the address.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description='The country name of the address.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the address. See 商户API地址编码主数据 for valid district codes.')
district_name
class-attribute
instance-attribute
¶
district_name = Field(None, alias='districtName', description='The district name of the address.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the address.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the address. See 商户API地址编码主数据 for valid province codes.')
province_name
class-attribute
instance-attribute
¶
province_name = Field(None, alias='provinceName', description='The province name of the address.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the address.')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line of the street address of the address. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line of the street address of address. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The address type of the address.')
GetDropoffSitesResponses ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the drop-off site location. See 商户API地址编码主数据 for valid city codes.')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the drop-off site location.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter country code associated with the drop-off site location.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the drop-off site location. See 商户API地址编码主数据 for valid district codes.')
dropoff_site_id
class-attribute
instance-attribute
¶
dropoff_site_id = Field(None, alias='dropoffSiteId', description='The unique identifier of the drop-off site location.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the drop-off site location.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the drop-off site location.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the drop-off site location. See 商户API地址编码主数据 for valid province codes.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the drop-off site location.')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line, if applicable, of the street address of the drop-off site location. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line, if applicable, of the street address of the drop-off site location. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The type of the drop-off site location. Currently, the only valid response is DROP_OFF .')
GetDropoffSitesResponsesData ¶
Bases: EbayModel
dropoff_sites
class-attribute
instance-attribute
¶
dropoff_sites = Field(None, alias='dropoffSites', description="This array returns address, contact, and identifier information for each of a seller's drop-off locations associated with their eDIS account.")
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter submitted in the request.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of results that match the input criteria.')
GetHandoverSheetResponsesData ¶
Bases: EbayModel
base64_str
class-attribute
instance-attribute
¶
base64_str = Field(None, alias='base64Str', description='The base 64 string value for a handover sheet. This string can be converted to a PDF file once it has been retrieved.')
GetLabelListResponsesData ¶
Bases: EbayModel
base64_str
class-attribute
instance-attribute
¶
base64_str = Field(None, alias='base64Str', description='The base 64 string value for a shipping label. This string value can be converted to a PDF file.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A message relating to the status of the shipping label retrieval process.')
result_code
class-attribute
instance-attribute
¶
result_code = Field(None, alias='resultCode', description='The result code detailing the results of the shipping label retrieval process. For example, a result code of 200 indicates that at least one shipping label was successfully retrieved.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number for which the shipping label is being retrieved.')
GetTrackingDetailResponsesData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code in which the tracking event occurred. See 商户API地址编码主数据 for valid city codes. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 country code where the tracking event occurred.')
description_en
class-attribute
instance-attribute
¶
description_en = Field(None, alias='descriptionEn', description='The English description of the tracking event.')
description_zh
class-attribute
instance-attribute
¶
description_zh = Field(None, alias='descriptionZh', description='The Chinese description of the tracking event.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code where the tracking event occurred. See 商户API地址编码主数据 for valid district codes. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
event_postal_code
class-attribute
instance-attribute
¶
event_postal_code = Field(None, alias='eventPostalCode', description='The postal code of where the tracking event occurred. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
event_time
class-attribute
instance-attribute
¶
event_time = Field(None, alias='eventTime', description='This timestamp the time and date the tracking event occurred.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code where the tracking event occurred. See 商户API地址编码主数据 for province district codes. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The status of the shipment.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number specified in the request.')
IncotermEnum ¶
LiBatteryTypeEnum ¶
Bases: OpenStrEnum
lithium_ion_battery_packed_with_equipment
class-attribute
instance-attribute
¶
lithium_ion_battery_packed_with_equipment = 'LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT'
lithium_ion_battery_contained_in_equipment
class-attribute
instance-attribute
¶
lithium_ion_battery_contained_in_equipment = 'LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT'
lithium_metal_battery_packed_with_equipment
class-attribute
instance-attribute
¶
lithium_metal_battery_packed_with_equipment = 'LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT'
lithium_metal_battery_contained_in_equipment
class-attribute
instance-attribute
¶
lithium_metal_battery_contained_in_equipment = 'LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT'
dry_packed_with_equipment
class-attribute
instance-attribute
¶
dry_packed_with_equipment = 'DRY_PACKED_WITH_EQUIPMENT'
special_goods_with_no_battery
class-attribute
instance-attribute
¶
special_goods_with_no_battery = 'SPECIAL_GOODS_WITH_NO_BATTERY'
PackageStatusEnum ¶
Bases: OpenStrEnum
applied_tracking_code
class-attribute
instance-attribute
¶
applied_tracking_code = 'APPLIED_TRACKING_CODE'
fdcvalidationfailed
class-attribute
instance-attribute
¶
fdcvalidationfailed = 'FDCVALIDATIONFAILED'
fdcvalidationinprogress
class-attribute
instance-attribute
¶
fdcvalidationinprogress = 'FDCVALIDATIONINPROGRESS'
PickUpTimeTypeEnum ¶
PickupAddressRequestData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the pickup address. See 商户API地址编码主数据 for valid city codes.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The company name associated with the pickup address. Max length : 50 characters')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the pickup address. Max length : 50 characters')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the pickup address. Valid values : CN HK')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the pickup address. See 商户API地址编码主数据 for valid district codes.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the pickup address. Max length : 50 characters')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the pickup address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the pickup address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the the pickup address. See 商户API地址编码主数据 for valid province codes.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the pickup address. Max length : 50 characters')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line, if applicable, of the street address of the pickup address. Max length : 50 characters')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line, if applicable, of the street address of the pickup address. Max length : 50 characters')
PickupAddressResponsesData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the pickup address. See 商户API地址编码主数据 for valid city codes.')
city_name
class-attribute
instance-attribute
¶
city_name = Field(None, alias='cityName', description='The city name of the pickup address.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The name of the company associated with the pickup address.')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the pickup address.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the pickup address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description='The name of the country of the pickup address.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the pickup address. See 商户API地址编码主数据 for valid district codes.')
district_name
class-attribute
instance-attribute
¶
district_name = Field(None, alias='districtName', description='The district name of the pickup address.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the pickup address.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the pickup address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the pickup address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the pickup address. See 商户API地址编码主数据 for valid province codes.')
province_name
class-attribute
instance-attribute
¶
province_name = Field(None, alias='provinceName', description='The name of the province of the pickup address.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the pickup address.')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line, if applicable, of the street address of the pickup address.')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line, if applicable, of the street address of the pickup address.')
ServiceInfoResponses ¶
Bases: EbayModel
description_en
class-attribute
instance-attribute
¶
description_en = Field(None, alias='descriptionEn', description='Basic shipping service information in English.')
description_hk
class-attribute
instance-attribute
¶
description_hk = Field(None, alias='descriptionHk', description='Basic shipping service information in traditional Chinese.')
description_jp
class-attribute
instance-attribute
¶
description_jp = Field(None, alias='descriptionJp', description='Basic shipping service information in Japanese.')
description_zh
class-attribute
instance-attribute
¶
description_zh = Field(None, alias='descriptionZh', description='Basic shipping service information in simplified Chinese.')
directions
class-attribute
instance-attribute
¶
directions = Field(None, description='This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service.')
incoterm
class-attribute
instance-attribute
¶
incoterm = Field(None, description='The incoterm information associated with the the shipping service. Supported values : DDP DDU')
max_length
class-attribute
instance-attribute
¶
max_length = Field(None, alias='maxLength', description='This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
max_total_length
class-attribute
instance-attribute
¶
max_total_length = Field(None, alias='maxTotalLength', description='This value indicates the total maximum value of the length, width, and height of the package. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
max_weight
class-attribute
instance-attribute
¶
max_weight = Field(None, alias='maxWeight', description='This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
name_en
class-attribute
instance-attribute
¶
name_en = Field(None, alias='nameEn', description='The shipping service name in English')
name_hk
class-attribute
instance-attribute
¶
name_hk = Field(None, alias='nameHk', description='The shipping service name in traditional Chinese')
name_jp
class-attribute
instance-attribute
¶
name_jp = Field(None, alias='nameJp', description='The shipping service name in Japanese.')
name_zh
class-attribute
instance-attribute
¶
name_zh = Field(None, alias='nameZh', description='The shipping service name in simplified Chinese')
shipping_service_id
class-attribute
instance-attribute
¶
shipping_service_id = Field(None, alias='shippingServiceId', description='The unique identifier of the shipping service being retrieved. This value can be input in the shippingServiceId field when creating a package through the the createPackage method.')
ShipToAddressRequestData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the ship-to address. See 商户API地址编码主数据 for valid city codes.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The name of the company associated with the ship-to address.')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the the ship-to address.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the ship-to address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description='The country name of the ship-to address.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the ship-to address. See 商户API地址编码主数据 for valid district codes.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the ship-to address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the ship-to address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the ship-to address. See 商户API地址编码主数据 for valid province codes.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the ship-to address. Max length : 50 characters')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line, if applicable, of the street address of the ship-to address. Max length : 50 characters')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line, if applicable, of the street address of the ship-to address. Max length : 50 characters')
ShipToAddressResponsesData ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city code of the ship-to address. See 商户API地址编码主数据 for valid city codes.')
company
class-attribute
instance-attribute
¶
company = Field(None, description='The name of the company associated with the ship-to address.')
contact
class-attribute
instance-attribute
¶
contact = Field(None, description='The name of the contact person associated with the ship-to address.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter country code of the ship-to address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description='The country name of the ship-to address.')
district
class-attribute
instance-attribute
¶
district = Field(None, description='The district code of the ship-to address. See 商户API地址编码主数据 for valid district codes.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number associated with the ship-to address.')
postcode
class-attribute
instance-attribute
¶
postcode = Field(None, description='The postal code of the ship-to address.')
province
class-attribute
instance-attribute
¶
province = Field(None, description='The province code of the ship-to address. See 商户API地址编码主数据 for valid province codes.')
street1
class-attribute
instance-attribute
¶
street1 = Field(None, description='The first line of the street address of the ship-to address.')
street2
class-attribute
instance-attribute
¶
street2 = Field(None, description='The second line of the street address of the ship-to address.')
street3
class-attribute
instance-attribute
¶
street3 = Field(None, description='The third line of the street address of the ship-to address.')
SpecialServiceDetail ¶
Bases: EbayModel
insurance_fee
class-attribute
instance-attribute
¶
insurance_fee = Field(None, alias='insuranceFee', description='The insurance fee, if applicable, on the package. The insurance amount and currency are consistent with the currency of the destination country')
packaging_type
class-attribute
instance-attribute
¶
packaging_type = Field(None, alias='packagingType', description='The package type. Valid values : PAK (limited weight ≤ 2.5KG) PACKAGE (limited weight 68KG)')
signature_type
class-attribute
instance-attribute
¶
signature_type = Field(None, alias='signatureType', description='The signature type, if applicable, for the package. Valid values : ISR (Indirect Signature Required) DSR (Direct Signature Required) ASR (Adult Signature Required)')
special_service_types
class-attribute
instance-attribute
¶
special_service_types = Field(None, alias='specialServiceTypes', description='Any special service types supported for the package. For example, SATURDAY_DELIVERY indicates that the item is eligible for Saturday delivery.')
AddComplaintRequestData ¶
Bases: EbayModel
affected_packages
class-attribute
instance-attribute
¶
affected_packages = Field(None, alias='affectedPackages', description='This array specifies a list of packages, specified by their packageId , affected by the issue causing the complaint. Package ID values are returned when creating a package through the createPackage method This array is required if the complaint being filed is for a missing package.')
complaint_date
class-attribute
instance-attribute
¶
complaint_date = Field(None, alias='complaintDate', description='The date in which the issue associated with the complaint occurred. Format: YYYY-MM-DDTHH:MM:SS.SSSZ')
complaint_reason
class-attribute
instance-attribute
¶
complaint_reason = Field(None, alias='complaintReason', description='This string specifies the reason the complaint was filed. Max length : 200 characters')
complaint_type
class-attribute
instance-attribute
¶
complaint_type = Field(None, alias='complaintType', description='The type of complaint being filed. Valid values : ABNORMAL_COLLECTION_COMPLAINT LOST_PACKAGE_COMPLAINT')
preference_id
class-attribute
instance-attribute
¶
preference_id = Field(None, alias='preferenceId', description='The unique identifier of the address associated with the complaint. This field is required if the complain being filed is associated with a specific address.')
remark
class-attribute
instance-attribute
¶
remark = Field(None, description='A remark to the seller themselves.')
AgentModelResponses ¶
Bases: EbayModel
agent_address
class-attribute
instance-attribute
¶
agent_address = Field(None, alias='agentAddress', description='The address of the EU AR agent.')
agent_name
class-attribute
instance-attribute
¶
agent_name = Field(None, alias='agentName', description='The name of the EU AR agent.')
agent_phone
class-attribute
instance-attribute
¶
agent_phone = Field(None, alias='agentPhone', description='The phone number of the EU AR agent.')
agent_preferences
class-attribute
instance-attribute
¶
agent_preferences = Field(None, alias='agentPreferences', description='This array returns the supported shipping countries and eBay user IDs associated with the EU AR agent.')
ar_name
class-attribute
instance-attribute
¶
ar_name = Field(None, alias='arName', description='The seller-defined setting name of the AR agent.')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost. See the CurrencyCodeEnum type for the full list of supported values. Both the value and currency fields are required/always returned when expressing cost.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount, in the currency specified by the currency field. Both the value and currency fields are required/always returned when expressing cost.')
BatteryQualResponses ¶
Bases: EbayModel
battery_type
class-attribute
instance-attribute
¶
battery_type = Field(None, alias='batteryType', description='The type of the battery.')
elec_qualification_id
class-attribute
instance-attribute
¶
elec_qualification_id = Field(None, alias='elecQualificationId', description="The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping.")
elec_qualification_name
class-attribute
instance-attribute
¶
elec_qualification_name = Field(None, alias='elecQualificationName', description="The name of the battery's electric qualification.")
expire_date
class-attribute
instance-attribute
¶
expire_date = Field(None, alias='expireDate', description='The expiration date of the battery qualification.')
remark
class-attribute
instance-attribute
¶
remark = Field(None, description='A remark to the seller themselves. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
BundleDetailResponse ¶
Bases: EbayModel
bundle_detail
class-attribute
instance-attribute
¶
bundle_detail = Field(None, alias='bundleDetail', description='This container returns information about the retrieved bundle, such as its tracking numbers and consign preference ID.')
BundleLabelResponse ¶
Bases: EbayModel
label
class-attribute
instance-attribute
¶
label = Field(None, description='This container returns the bundle label information, such as the base64 string value, for the specified bundle.')
CancelPackagesRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This container is used to specify the package ID values for the packages being canceled.')
CancelPackagesResponses ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This array returns the result code and message for each cancelled package. Each package is denoted by its package ID value.')
ClonePackageResponsesData ¶
Bases: EbayModel
last_mile_tracking_number
class-attribute
instance-attribute
¶
last_mile_tracking_number = Field(None, alias='lastMileTrackingNumber', description='The last-mile tracking number of the package. This field is only returned if the last-mile tracking number is provided by the carrier.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the package. A new packageId value is generated when a package is cloned.')
payment_cost
class-attribute
instance-attribute
¶
payment_cost = Field(None, alias='paymentCost', description='The payment cost for the package.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number for the cloned package.')
ConfirmPackagesRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This container is used to specify the package ID values of the packages being confirmed.')
ConfirmPackagesResponses ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This array returns the result code and message for each confirmed package. Each package is denoted by its package ID value.')
ConsignPreferenceInfoResponses ¶
Bases: EbayModel
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the consign address.')
consign_preference_name
class-attribute
instance-attribute
¶
consign_preference_name = Field(None, alias='consignPreferenceName', description='The name of the consign address.')
dropoff_site_id
class-attribute
instance-attribute
¶
dropoff_site_id = Field(None, alias='dropoffSiteId', description='The unique identifier of the drop-off site. This field is only returned if the consign address is a drop-off location.')
pickup_address
class-attribute
instance-attribute
¶
pickup_address = Field(None, alias='pickupAddress', description='This container returns the address and contact information for a pickup address. Note: This container is always returned, but will show as null or have an empty value if not defined/applicable.')
pickup_time
class-attribute
instance-attribute
¶
pickup_time = Field(None, alias='pickupTime', description='The supported pickup window that the pickup location supports. This field is only returned if the consign address is a pickup-from location')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The address type of the consign address. Valid values : PICK_UP DROP_OFF FORWARD_DEPLOYMENT')
CreateAddressPreferenceRequest ¶
Bases: EbayModel
ship_from_address
class-attribute
instance-attribute
¶
ship_from_address = Field(None, alias='shipFromAddress', description='This container is used to specify the address details used to create an address.')
CreateAddressPreferenceResponses ¶
Bases: EbayModel
ship_from_address_id
class-attribute
instance-attribute
¶
ship_from_address_id = Field(None, alias='shipFromAddressId', description='This container specifies the unique identifier of the newly created address.')
CreateBundleRequest ¶
Bases: EbayModel
bundle
class-attribute
instance-attribute
¶
bundle = Field(None, description='This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle.')
CreateBundleResponse ¶
Bases: EbayModel
bundle
class-attribute
instance-attribute
¶
bundle = Field(None, description='This container returns information about the newly created bundle, such as its bundleId value.')
CreateConsignPreferenceRequestData ¶
Bases: EbayModel
consign_preference_name
class-attribute
instance-attribute
¶
consign_preference_name = Field(None, alias='consignPreferenceName', description='The name of the consign address.')
dropoff_site_id
class-attribute
instance-attribute
¶
dropoff_site_id = Field(None, alias='dropoffSiteId', description='The unique identifier of a drop-off site location. This value can be retrieved using the getDropoffSites method. This field is required if the DROPOFF address type is specified.')
pickup_address
class-attribute
instance-attribute
¶
pickup_address = Field(None, alias='pickupAddress', description='This container is used to specify the address details used to create a pickup-from address. This container is required if the PICK_UP address type is specified.')
pickup_time
class-attribute
instance-attribute
¶
pickup_time = Field(None, alias='pickupTime', description='The pickup time that the pickup location supports. This field is required if the PICK_UP address type is specified.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The address type of the consign address. Valid values : PICK_UP DROP_OFF FORWARD_DEPLOYMENT RDC CN_POST_DROP_OFF CN_POST_PICK_UP HK_POST_DROP_OFF')
CreateConsignPreferenceResponses ¶
Bases: EbayModel
consign_address_id
class-attribute
instance-attribute
¶
consign_address_id = Field(None, alias='consignAddressId', description='This container specifies the unique identifier of the newly created consign address.')
DeletePackagesRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This container is used to specify the package ID values for the packages being deleted.')
DeletePackagesResponses ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This array returns the result code and message for each deleted package. Each package is denoted by its package ID value.')
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.')
GetActualCostResponsesData ¶
Bases: EbayModel
actual_weight
class-attribute
instance-attribute
¶
actual_weight = Field(None, alias='actualWeight', description='The actual weight of the package in grams.')
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container specifies the total monetary amount of the actual cost of the package.')
billing_time
class-attribute
instance-attribute
¶
billing_time = Field(None, alias='billingTime', description='The time the seller was charged for the actual cost of the package in UTC format.')
charge_mode
class-attribute
instance-attribute
¶
charge_mode = Field(None, alias='chargeMode', description='The two-digit charge mode for the package. Valid values : 01 : Actual weight 02 : Additional dimension weight 03 : Charged by lite mode')
charge_weight
class-attribute
instance-attribute
¶
charge_weight = Field(None, alias='chargeWeight', description='The weight, in grams, charged for when shipping the package.')
cost_type
class-attribute
instance-attribute
¶
cost_type = Field(None, alias='costType', description='The two-digit cost type of the package. This field indicates any fees associated with the package. The following values are the typical cost types returned through this field.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A seller-defined message to the buyer regarding the transaction. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
remark
class-attribute
instance-attribute
¶
remark = Field(None, description='A remark to the seller themselves. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
result_code
class-attribute
instance-attribute
¶
result_code = Field(None, alias='resultCode', description='The result code associated with the call. For example, a result code of 200 indicates that the call was a success.')
size
class-attribute
instance-attribute
¶
size = Field(None, description='The size of the package in centimeters. This value is returned in Length*Width*Height format.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number associated with the package.')
GetAddressPreferenceListResponsesData ¶
Bases: EbayModel
addresses
class-attribute
instance-attribute
¶
addresses = Field(None, description="This array returns a list of address, contact, and identifier information for each of a seller's ship-from and/or return addresses associated with their eDIS account.")
GetAgentListResponsesData ¶
Bases: EbayModel
agents
class-attribute
instance-attribute
¶
agents = Field(None, description="This array returns information about each EU AR agent associated with a seller's eDIS account, including their contact information, eBay ID, and supported shipping countries.")
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter submitted in the request.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of results that match the input criteria.')
GetBatteryQualListResponsesData ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter submitted in the request.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
qualifications
class-attribute
instance-attribute
¶
qualifications = Field(None, description='This array returns information about each battery qualification associated with an eDIS account, such as the battery type, qualification name, and expiration date.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of results that match the input criteria.')
GetConsignPreferenceListResponsesData ¶
Bases: EbayModel
consign_preferences
class-attribute
instance-attribute
¶
consign_preferences = Field(None, alias='consignPreferences', description="This array returns information about each of a seller's consign addresses associated with their eDIS account.")
GetDropoffSiteListResponses ¶
Bases: EbayModel
dropoff_site_list
class-attribute
instance-attribute
¶
dropoff_site_list = Field(None, alias='dropoffSiteList', description='This container returns a list of all of the drop-off site locations associated with an eDIS account.')
GetHandoverSheetResponses ¶
Bases: EbayModel
handover_sheet
class-attribute
instance-attribute
¶
handover_sheet = Field(None, alias='handoverSheet', description='This container returns the base64 string value for a handover sheet.')
GetItemPackageIdResponsesData ¶
Bases: EbayModel
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the package.')
package_status
class-attribute
instance-attribute
¶
package_status = Field(None, alias='packageStatus', description='The current status of the package.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number of the package.')
GetLabelListResponses ¶
Bases: EbayModel
labels
class-attribute
instance-attribute
¶
labels = Field(None, description='This array returns the shipping label information, such as the base64 string value and result code for each specified tracking number.')
GetServiceListResponsesData ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter submitted in the request.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
services
class-attribute
instance-attribute
¶
services = Field(None, description='This array returns a list of available shipping services, as well as the descriptions, directions, and identifiers of each service.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of shipping services being displayed on the current results page.')
GetTrackingDetailResponses ¶
Bases: EbayModel
tracking_details
class-attribute
instance-attribute
¶
tracking_details = Field(None, alias='trackingDetails', description='This array returns a list of tracking event details for the specified tracking number.')
SkuRequest ¶
Bases: EbayModel
elec_qualification_id
class-attribute
instance-attribute
¶
elec_qualification_id = Field(None, alias='elecQualificationId', description="The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping. This value is returned in the getBatteryQualifications method.")
fdc_skus
class-attribute
instance-attribute
¶
fdc_skus = Field(None, alias='fdcSkus', description='This array lists the FDC SKUs associated with the item. An FDC SKU is the SKU label in a forward deployment center. Important! Please contact customer service before using these fields.')
height
class-attribute
instance-attribute
¶
height = Field(None, description='The height of the item in centimeters.')
is_li_battery
class-attribute
instance-attribute
¶
is_li_battery = Field(None, alias='isLiBattery', description='This boolean indicates if the item contains a battery.')
length
class-attribute
instance-attribute
¶
length = Field(None, description='The length of the item in centimeters.')
li_battery_type
class-attribute
instance-attribute
¶
li_battery_type = Field(None, alias='liBatteryType', description='If the item contains a battery, this field indicates the type of battery the item contains.')
name_en
class-attribute
instance-attribute
¶
name_en = Field(None, alias='nameEn', description='The English name of the item.')
name_zh
class-attribute
instance-attribute
¶
name_zh = Field(None, alias='nameZh', description='The Chinese name of the item.')
origin
class-attribute
instance-attribute
¶
origin = Field(None, description='The country of origin of the item.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='The declared price of the item.')
remark
class-attribute
instance-attribute
¶
remark = Field(None, description='A remark to the seller themselves.')
sku_number
class-attribute
instance-attribute
¶
sku_number = Field(None, alias='skuNumber', description='The stock keeping unit (SKU) identifier of the item.')
tariff_code
class-attribute
instance-attribute
¶
tariff_code = Field(None, alias='tariffCode', description='The Harmonized System code for custom declaration. This value declares the category of the item..')
weight
class-attribute
instance-attribute
¶
weight = Field(None, description='The weight of the item in grams.')
width
class-attribute
instance-attribute
¶
width = Field(None, description='The width of the item in centimeters.')
AddComplaintRequest ¶
Bases: EbayModel
complaint_request
class-attribute
instance-attribute
¶
complaint_request = Field(None, alias='complaintRequest', description='This container is used to specify the information included in a complaint request, such as the complaint reason, date, and type.')
AddPackageResponsesData ¶
Bases: EbayModel
estimate_cost
class-attribute
instance-attribute
¶
estimate_cost = Field(None, alias='estimateCost', description='The estimated shipping cost of the package.')
last_mile_tracking_number
class-attribute
instance-attribute
¶
last_mile_tracking_number = Field(None, alias='lastMileTrackingNumber', description='The last-mile tracking number of the package. This field is only returned if the last-mile tracking number is provided by the carrier.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the created package. Note: Sellers should keep track of the returned packageId , as there is no programmatic way to retrieve this value at this time.')
payment_cost
class-attribute
instance-attribute
¶
payment_cost = Field(None, alias='paymentCost', description='The actual payment cost of the package.')
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number of the created package.')
ClonePackageResponses ¶
Bases: EbayModel
clone_package_result
class-attribute
instance-attribute
¶
clone_package_result = Field(None, alias='clonePackageResult', description='This container returns the package ID, payment cost, and tracking number for the cloned package.')
CreateConsignPreferenceRequest ¶
Bases: EbayModel
consign_address
class-attribute
instance-attribute
¶
consign_address = Field(None, alias='consignAddress', description='This container is used to specify the address details used to create a consign address.')
GetActualCostResponses ¶
Bases: EbayModel
actual_costs
class-attribute
instance-attribute
¶
actual_costs = Field(None, alias='actualCosts', description='This array returns a list of actual costs associated with the packages matching the input criteria.')
GetAddressPreferenceListResponses ¶
Bases: EbayModel
address_preference_list
class-attribute
instance-attribute
¶
address_preference_list = Field(None, alias='addressPreferenceList', description="This container returns all ship-from and/or return addresses associated with a seller's eDIS account.")
GetAgentListResponses ¶
Bases: EbayModel
agent_list
class-attribute
instance-attribute
¶
agent_list = Field(None, alias='agentList', description='This container returns a list of all EU AR agents associated with your eDIS account and their information.')
GetBatteryQualListResponses ¶
Bases: EbayModel
battery_qualification_list
class-attribute
instance-attribute
¶
battery_qualification_list = Field(None, alias='batteryQualificationList', description='This container returns a list of all battery qualifications associated with an eDIS account.')
GetConsignPreferenceListResponses ¶
Bases: EbayModel
consign_preference_list
class-attribute
instance-attribute
¶
consign_preference_list = Field(None, alias='consignPreferenceList', description="This container returns a list of all consign addresses associated with a seller's eDIS account.")
GetItemPackageIdResponses ¶
Bases: EbayModel
item_packages
class-attribute
instance-attribute
¶
item_packages = Field(None, alias='itemPackages', description='This array returns a list of packages associated with the specified line item ID.')
GetServiceListResponses ¶
Bases: EbayModel
service_list
class-attribute
instance-attribute
¶
service_list = Field(None, alias='serviceList', description="This container returns shipping service metadata associated with a seller's eDIS account.")
ItemRequest ¶
Bases: EbayModel
buyer_id
class-attribute
instance-attribute
¶
buyer_id = Field(None, alias='buyerId', description="The buyer's eBay user ID. Note: Effective September 26, 2025, both usernames and public user IDs will be accepted in this field. For more information, please refer to Data Handling Compliance .")
buyer_tax_id
class-attribute
instance-attribute
¶
buyer_tax_id = Field(None, alias='buyerTaxId', description='The tax ID for the buyer. The type of Tax ID is specified in the buyerTaxIdType field.')
buyer_tax_type
class-attribute
instance-attribute
¶
buyer_tax_type = Field(None, alias='buyerTaxType', description='The type of tax ID that was supplied by the buyer during the checkout process.')
ebay_collect_and_remit_tax
class-attribute
instance-attribute
¶
ebay_collect_and_remit_tax = Field(None, alias='ebayCollectAndRemitTax', description="This boolean indicates if the corresponding line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf.")
ebay_collect_and_remit_taxes_value
class-attribute
instance-attribute
¶
ebay_collect_and_remit_taxes_value = Field(None, alias='ebayCollectAndRemitTaxesValue', description="The value of the 'Collect and Remit' tax for the order that the line item belongs to.")
email
class-attribute
instance-attribute
¶
email = Field(None, description="The buyer's email address.")
item_title
class-attribute
instance-attribute
¶
item_title = Field(None, alias='itemTitle', description='The title of the listing.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing. Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A message from the seller to the buyer.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the eBay order that the line item belongs to.')
order_line_item
class-attribute
instance-attribute
¶
order_line_item = Field(None, alias='orderLineItem', description='The unique identifier of the line item. Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item.')
payment_date
class-attribute
instance-attribute
¶
payment_date = Field(None, alias='paymentDate', description='The date and time the buyer pays for the order. Format: YYYY-MM-DDTHH:MM:SS.SSSZ')
pay_pal_email
class-attribute
instance-attribute
¶
pay_pal_email = Field(None, alias='payPalEmail', description="The buyer's PayPal email address.")
pay_pal_message
class-attribute
instance-attribute
¶
pay_pal_message = Field(None, alias='payPalMessage', description="The buyer's PayPal message.")
posted_quantity
class-attribute
instance-attribute
¶
posted_quantity = Field(None, alias='postedQuantity', description='The quantity of the line item that will be shipped with the package. This value can differ from the order quantity in the case of a combined or split shipment. Min : 1 Max : 999')
site_id
class-attribute
instance-attribute
¶
site_id = Field(None, alias='siteId', description='The unique identifier of the eBay site in which the order occurred.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='This container specifies information relating to the item being shipped in the package.')
sold_date
class-attribute
instance-attribute
¶
sold_date = Field(None, alias='soldDate', description='The date the item was sold. Format : YYYY-MM-DDTHH:MM:SS.SSSZ')
sold_price
class-attribute
instance-attribute
¶
sold_price = Field(None, alias='soldPrice', description='The price for which the item was sold.')
sold_quantity
class-attribute
instance-attribute
¶
sold_quantity = Field(None, alias='soldQuantity', description='The quantity of the line item that was sold.')
transaction_id
class-attribute
instance-attribute
¶
transaction_id = Field(None, alias='transactionId', description='The unique identifier of the monetary transaction. Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item.')
ItemResponses ¶
Bases: EbayModel
buyer_id
class-attribute
instance-attribute
¶
buyer_id = Field(None, alias='buyerId', description="The buyer's eBay ID. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .")
buyer_tax_id
class-attribute
instance-attribute
¶
buyer_tax_id = Field(None, alias='buyerTaxId', description="The buyer's tax ID.")
buyer_tax_type
class-attribute
instance-attribute
¶
buyer_tax_type = Field(None, alias='buyerTaxType', description="The buyer's tax type.")
ebay_collect_and_remit_tax
class-attribute
instance-attribute
¶
ebay_collect_and_remit_tax = Field(None, alias='ebayCollectAndRemitTax', description="If returned as true , this boolean indicates that eBay will collect tax for the corresponding line item, and remit the tax to the taxing authority of the buyer's residence.")
ebay_collect_and_remit_taxes_value
class-attribute
instance-attribute
¶
ebay_collect_and_remit_taxes_value = Field(None, alias='ebayCollectAndRemitTaxesValue', description='The value of the collect and remit tax for the corresponding line item. This field is only returned if collect and remit tax is applied to the line item.')
email
class-attribute
instance-attribute
¶
email = Field(None, description="The buyer's eBay email address.")
item_title
class-attribute
instance-attribute
¶
item_title = Field(None, alias='itemTitle', description='The seller created title of the item.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing associated with the item.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="The buyer's eBay message.")
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the eBay order that the line item belongs to.')
order_line_item
class-attribute
instance-attribute
¶
order_line_item = Field(None, alias='orderLineItem', description='The unique identifier of an eBay order line item.')
payment_date
class-attribute
instance-attribute
¶
payment_date = Field(None, alias='paymentDate', description='The date and time that the payment was received by the seller. This timestamp is returned in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.')
pay_pal_email
class-attribute
instance-attribute
¶
pay_pal_email = Field(None, alias='payPalEmail', description="The buyer's PayPal email address.")
pay_pal_message
class-attribute
instance-attribute
¶
pay_pal_message = Field(None, alias='payPalMessage', description="The buyer's PayPal message")
posted_quantity
class-attribute
instance-attribute
¶
posted_quantity = Field(None, alias='postedQuantity', description='The quantity of the line item shipped with the package.')
site_id
class-attribute
instance-attribute
¶
site_id = Field(None, alias='siteId', description='The unique identifier of the eBay site in which the order occurred.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='This container returns SKU-related information relating to the item being shipped in the package.')
sold_date
class-attribute
instance-attribute
¶
sold_date = Field(None, alias='soldDate', description='The date the item was sold.')
sold_price
class-attribute
instance-attribute
¶
sold_price = Field(None, alias='soldPrice', description='The price for which the item was sold.')
sold_quantity
class-attribute
instance-attribute
¶
sold_quantity = Field(None, alias='soldQuantity', description='The quantity of the line item that was sold.')
transaction_id
class-attribute
instance-attribute
¶
transaction_id = Field(None, alias='transactionId', description='The unique identifier of the eBay transaction.')
PackageInfoRequest ¶
Bases: EbayModel
agent_info_request
class-attribute
instance-attribute
¶
agent_info_request = Field(None, alias='agentInfoRequest', description='This container specifies the EU AR agent information associated with the package. This information can be retrieved using the getAgents method.')
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the consign address to be associated with the package. This ID can be retrieved using the getConsignPreferences method.')
incoterm
class-attribute
instance-attribute
¶
incoterm = Field(None, description='The incoterm information associated with the package. Supported values : DDP DDU')
items
class-attribute
instance-attribute
¶
items = Field(None, description='This array is used to specify applicable information about the eBay line item(s) that will be included in the package.')
max_quantity_limit
class-attribute
instance-attribute
¶
max_quantity_limit = Field(None, alias='maxQuantityLimit', description='This field is used to limit the maximum number of parcels used in a single order. If the order has more than one parcel, revise this value to increase the limit.')
package_comment
class-attribute
instance-attribute
¶
package_comment = Field(None, alias='packageComment', description='A seller-defined comment about the package.')
package_height
class-attribute
instance-attribute
¶
package_height = Field(None, alias='packageHeight', description='The height of the package in centimeters.')
package_length
class-attribute
instance-attribute
¶
package_length = Field(None, alias='packageLength', description='The length of the package in centimeters.')
package_weight
class-attribute
instance-attribute
¶
package_weight = Field(None, alias='packageWeight', description='The weight of the package in grams.')
package_width
class-attribute
instance-attribute
¶
package_width = Field(None, alias='packageWidth', description='The width of the package in centimeters.')
ship_from_address_id
class-attribute
instance-attribute
¶
ship_from_address_id = Field(None, alias='shipFromAddressId', description='The unique identifier of the ship-from address used for the package. Use the getAddressPreferences method to retrieve valid ship-from addressId values associated with your account.')
shipping_service_id
class-attribute
instance-attribute
¶
shipping_service_id = Field(None, alias='shippingServiceId', description='The unique identifier of the shipping service being used for the package. This value can be retrieved using the getServices method.')
ship_to_address
class-attribute
instance-attribute
¶
ship_to_address = Field(None, alias='shipToAddress', description='This container specifies the address details of the address ship-to address.')
special_service_detail
class-attribute
instance-attribute
¶
special_service_detail = Field(None, alias='specialServiceDetail', description='This container specifies any special service details about the package, such as any insurance fee, required signatures, or delivery exceptions.')
value_for_carriage
class-attribute
instance-attribute
¶
value_for_carriage = Field(None, alias='valueForCarriage', description='The declared value of a large carriage (a combination of several orders together).')
AddPackageRequest ¶
Bases: EbayModel
package_info
class-attribute
instance-attribute
¶
package_info = Field(None, alias='packageInfo', description='This container is used to specify the information needed to create a package.')
AddPackageResponses ¶
Bases: EbayModel
create_package_result
class-attribute
instance-attribute
¶
create_package_result = Field(None, alias='createPackageResult', description='This container returns information about the newly created package, including its tracking number and packageId value.')
GetPackageDetailResponsesData ¶
Bases: EbayModel
agent_info_response
class-attribute
instance-attribute
¶
agent_info_response = Field(None, alias='agentInfoResponse', description='This container returns EU AR agent information associated with the package.')
consign_preference_id
class-attribute
instance-attribute
¶
consign_preference_id = Field(None, alias='consignPreferenceId', description='The unique identifier of the consign address associated with the package.')
incoterm
class-attribute
instance-attribute
¶
incoterm = Field(None, description='The incoterm information associated with the package. Supported values : DDP DDU')
items
class-attribute
instance-attribute
¶
items = Field(None, description='This array returns information about the eBay line item(s) that are included in the package.')
last_mile_tracking_number
class-attribute
instance-attribute
¶
last_mile_tracking_number = Field(None, alias='lastMileTrackingNumber', description='The last-mile tracking number of the package. This field is only returned if the last-mile tracking number is provided by the carrier.')
package_comment
class-attribute
instance-attribute
¶
package_comment = Field(None, alias='packageComment', description='The seller-defined remark to the buyer associated with the package.')
package_height
class-attribute
instance-attribute
¶
package_height = Field(None, alias='packageHeight', description='The height of the package in centimeters.')
package_id
class-attribute
instance-attribute
¶
package_id = Field(None, alias='packageId', description='The unique identifier of the package.')
package_length
class-attribute
instance-attribute
¶
package_length = Field(None, alias='packageLength', description='The length of the package in centimeters.')
package_status
class-attribute
instance-attribute
¶
package_status = Field(None, alias='packageStatus', description='The current status of the package.')
package_weight
class-attribute
instance-attribute
¶
package_weight = Field(None, alias='packageWeight', description='The weight of the package in grams.')
package_width
class-attribute
instance-attribute
¶
package_width = Field(None, alias='packageWidth', description='The width of the package in centimeters.')
payment_cost
class-attribute
instance-attribute
¶
payment_cost = Field(None, alias='paymentCost', description='The actual payment cost of the package.')
ship_from_address_id
class-attribute
instance-attribute
¶
ship_from_address_id = Field(None, alias='shipFromAddressId', description='The unique identifier of the ship-from address associated with the package.')
shipping_service_id
class-attribute
instance-attribute
¶
shipping_service_id = Field(None, alias='shippingServiceId', description='The unique identifier of the shipping service used for the package.')
ship_to_address
class-attribute
instance-attribute
¶
ship_to_address = Field(None, alias='shipToAddress', description='This container returns information about the address the package is being shipped to.')
special_service_detail
class-attribute
instance-attribute
¶
special_service_detail = Field(None, alias='specialServiceDetail', description='This container returns any special services associated with this package. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.')
value_for_carriage
class-attribute
instance-attribute
¶
value_for_carriage = Field(None, alias='valueForCarriage', description='The declared value of the package.')