Fulfillment API — client.sell.fulfillment¶
Version v1.20.6 · base path /sell/fulfillment/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_order ¶
get_order(order_id: str, *, field_groups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.Order
get_order(order_id: str, *, field_groups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order(order_id: str, *, field_groups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.Order | httpx.Response
Use this call to retrieve the contents of an order based on its unique identifier, orderId . This value is returned in the getOrders call's orders.orderId field when you search for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.
get_orders ¶
get_orders(*, field_groups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, order_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.OrderSearchPagedCollection
get_orders(*, field_groups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, order_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_orders(*, field_groups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, order_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.OrderSearchPagedCollection | httpx.Response
Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.
issue_refund ¶
issue_refund(order_id: str, *, body: IssueRefundRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.Refund
issue_refund(order_id: str, *, body: IssueRefundRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
issue_refund(order_id: str, *, body: IssueRefundRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.Refund | httpx.Response
Issue Refund
get_shipping_fulfillments ¶
get_shipping_fulfillments(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.ShippingFulfillmentPagedCollection
get_shipping_fulfillments(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_fulfillments(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.ShippingFulfillmentPagedCollection | httpx.Response
Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId . This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status.
create_shipping_fulfillment ¶
create_shipping_fulfillment(order_id: str, *, body: ShippingFulfillmentDetails, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_shipping_fulfillment(order_id: str, *, body: ShippingFulfillmentDetails, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_shipping_fulfillment(order_id: str, *, body: ShippingFulfillmentDetails, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is shipping fulfillment . For each package, execute this call once to generate the shipping fulfillment associated with that package.
get_shipping_fulfillment ¶
get_shipping_fulfillment(fulfillment_id: str, order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.ShippingFulfillment
get_shipping_fulfillment(fulfillment_id: str, order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_fulfillment(fulfillment_id: str, order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.ShippingFulfillment | httpx.Response
Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId ). The fulfillmentId value was originally generated by the createShippingFulfillment call and is returned by the getShippingFulfillments call in the members.fulfillmentId field.
get_payment_dispute ¶
get_payment_dispute(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.PaymentDispute
get_payment_dispute(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payment_dispute(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.PaymentDispute | httpx.Response
Get Payment Dispute Details
fetch_evidence_content ¶
fetch_evidence_content(payment_dispute_id: str, *, evidence_id: str, file_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
fetch_evidence_content(payment_dispute_id: str, *, evidence_id: str, file_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
fetch_evidence_content(payment_dispute_id: str, *, evidence_id: str, file_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
Get Payment Dispute Evidence File
get_activities ¶
get_activities(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.PaymentDisputeActivityHistory
get_activities(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_activities(payment_dispute_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.PaymentDisputeActivityHistory | httpx.Response
Get Payment Dispute Activity
get_payment_dispute_summaries ¶
get_payment_dispute_summaries(*, order_id: str | None = None, buyer_username: str | None = None, open_date_from: str | None = None, open_date_to: str | None = None, payment_dispute_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.DisputeSummaryResponse
get_payment_dispute_summaries(*, order_id: str | None = None, buyer_username: str | None = None, open_date_from: str | None = None, open_date_to: str | None = None, payment_dispute_status: str | None = None, 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_payment_dispute_summaries(*, order_id: str | None = None, buyer_username: str | None = None, open_date_from: str | None = None, open_date_to: str | None = None, payment_dispute_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.DisputeSummaryResponse | httpx.Response
Search Payment Dispute by Filters
contest_payment_dispute ¶
contest_payment_dispute(payment_dispute_id: str, *, body: ContestPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
contest_payment_dispute(payment_dispute_id: str, *, body: ContestPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
contest_payment_dispute(payment_dispute_id: str, *, body: ContestPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Contest Payment Dispute
accept_payment_dispute ¶
accept_payment_dispute(payment_dispute_id: str, *, body: AcceptPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
accept_payment_dispute(payment_dispute_id: str, *, body: AcceptPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
accept_payment_dispute(payment_dispute_id: str, *, body: AcceptPaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Accept Payment Dispute
upload_evidence_file ¶
upload_evidence_file(payment_dispute_id: str, *, files: Mapping[str, Any], x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.FileEvidence
upload_evidence_file(payment_dispute_id: str, *, files: Mapping[str, Any], x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
upload_evidence_file(payment_dispute_id: str, *, files: Mapping[str, Any], x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.FileEvidence | httpx.Response
Upload an Evidence File
add_evidence ¶
add_evidence(payment_dispute_id: str, *, body: AddEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_fulfillment_models.AddEvidencePaymentDisputeResponse
add_evidence(payment_dispute_id: str, *, body: AddEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
add_evidence(payment_dispute_id: str, *, body: AddEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_fulfillment_models.AddEvidencePaymentDisputeResponse | httpx.Response
Add an Evidence File
update_evidence ¶
update_evidence(payment_dispute_id: str, *, body: UpdateEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_evidence(payment_dispute_id: str, *, body: UpdateEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_evidence(payment_dispute_id: str, *, body: UpdateEvidencePaymentDisputeRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Update evidence
Models¶
AcknowledgeStatusEnum ¶
ActivityEnum ¶
Bases: OpenStrEnum
additional_evidence_request
class-attribute
instance-attribute
¶
additional_evidence_request = 'ADDITIONAL_EVIDENCE_REQUEST'
evidence_request_overdue
class-attribute
instance-attribute
¶
evidence_request_overdue = 'EVIDENCE_REQUEST_OVERDUE'
seller_accept_with_return
class-attribute
instance-attribute
¶
seller_accept_with_return = 'SELLER_ACCEPT_WITH_RETURN'
seller_response_overdue
class-attribute
instance-attribute
¶
seller_response_overdue = 'SELLER_RESPONSE_OVERDUE'
ActorEnum ¶
AddEvidencePaymentDisputeResponse ¶
Bases: EbayModel
evidence_id
class-attribute
instance-attribute
¶
evidence_id = Field(None, alias='evidenceId', description='The value returned in this field is the unique identifier of the newly-created evidence set. Upon a successful call, this value is automatically genererated. This new evidence set for the payment dispute includes the evidence file(s) that were passed in to the fileId array in the request payload.')
AppointmentStatusEnum ¶
AppointmentTypeEnum ¶
AppointmentWindowEnum ¶
AuthenticityVerificationReasonEnum ¶
Bases: OpenStrEnum
not_authentic_no_return
class-attribute
instance-attribute
¶
not_authentic_no_return = 'NOT_AUTHENTIC_NO_RETURN'
AuthenticityVerificationStatusEnum ¶
Bases: OpenStrEnum
CancelRequestStateEnum ¶
CancelStateEnum ¶
ChargeTypeEnum ¶
Bases: OpenStrEnum
CollectionMethodEnum ¶
CountryCodeEnum ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DisputeAmount ¶
Bases: EbayModel
converted_from_currency
class-attribute
instance-attribute
¶
converted_from_currency = Field(None, alias='convertedFromCurrency', description='The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. This field is only returned if/when currency conversion was applied by eBay.')
converted_from_value
class-attribute
instance-attribute
¶
converted_from_value = Field(None, alias='convertedFromValue', description='The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. This field is only returned if/when currency conversion was applied by eBay.')
currency
class-attribute
instance-attribute
¶
currency = Field(None, description="A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default : The currency of the authenticated user's country.")
exchange_rate
class-attribute
instance-attribute
¶
exchange_rate = Field(None, alias='exchangeRate', description='The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. This field is only returned if/when currency conversion was applied by eBay.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.')
DisputeReasonEnum ¶
Bases: OpenStrEnum
significantly_not_as_described
class-attribute
instance-attribute
¶
significantly_not_as_described = 'SIGNIFICANTLY_NOT_AS_DESCRIBED'
credit_not_processed
class-attribute
instance-attribute
¶
credit_not_processed = 'CREDIT_NOT_PROCESSED'
return_refund_not_processed
class-attribute
instance-attribute
¶
return_refund_not_processed = 'RETURN_REFUND_NOT_PROCESSED'
authorization_failed
class-attribute
instance-attribute
¶
authorization_failed = 'AUTHORIZATION_FAILED'
DisputeStateEnum ¶
EbayFulfillmentProgram ¶
Bases: EbayModel
fulfilled_by
class-attribute
instance-attribute
¶
fulfilled_by = Field(None, alias='fulfilledBy', description='The value returned in this field indicates the party that is handling fulfillment of the order line item. Valid value : EBAY')
EbayInternationalShipping ¶
Bases: EbayModel
returns_managed_by
class-attribute
instance-attribute
¶
returns_managed_by = Field(None, alias='returnsManagedBy', description='The value returned in this field indicates the party that is responsible for managing returns of the order line item. Valid value: EBAY')
EbayShipping ¶
Bases: EbayModel
shipping_label_provided_by
class-attribute
instance-attribute
¶
shipping_label_provided_by = Field(None, alias='shippingLabelProvidedBy', description='This field contains the shipping label provider. If EBAY , this order is managed by eBay shipping and a free shipping label created by eBay is downloadable by the seller via the eBay website.')
EbayTaxReference ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following: ABN : If this string is returned, the ID in the value field is an Australia tax ID. DDG : If this string is returned, it indicates that tax has been collected and remitted for Digitally Delivered Goods (DDG).')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value returned in this field is the VAT identifier number (VATIN), which will vary by country/region. This field will be returned if VAT tax is applicable for the order.')
EbayVaultFulfillmentTypeEnum ¶
EbayVaultProgram ¶
Bases: EbayModel
fulfillment_type
class-attribute
instance-attribute
¶
fulfillment_type = Field(None, alias='fulfillmentType', description="This field specifies how an eBay vault order will be fulfilled. Supported options are: Seller to Vault : The order will be shipped by the seller to an authenticator. Vault to Vault : The order will be shipped from an eBay vault to the buyer's vault. Vault to Buyer : The order will be shipped from an eBay vault to the buyer's shipping address.")
ErrorParameter ¶
ErrorParameterV3 ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This is the name of input field that caused an issue with the call request.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This is the actual value that was passed in for the element specified in the name field.')
EvidenceTypeEnum ¶
Bases: OpenStrEnum
proof_of_authenticity
class-attribute
instance-attribute
¶
proof_of_authenticity = 'PROOF_OF_AUTHENTICITY'
proof_of_item_as_described
class-attribute
instance-attribute
¶
proof_of_item_as_described = 'PROOF_OF_ITEM_AS_DESCRIBED'
proof_of_credit_not_due
class-attribute
instance-attribute
¶
proof_of_credit_not_due = 'PROOF_OF_CREDIT_NOT_DUE'
proof_of_return_not_received
class-attribute
instance-attribute
¶
proof_of_return_not_received = 'PROOF_OF_RETURN_NOT_RECEIVED'
proof_of_delivery_as_file
class-attribute
instance-attribute
¶
proof_of_delivery_as_file = 'PROOF_OF_DELIVERY_AS_FILE'
proof_of_delivery_signature
class-attribute
instance-attribute
¶
proof_of_delivery_signature = 'PROOF_OF_DELIVERY_SIGNATURE'
optional_supporting_documents
class-attribute
instance-attribute
¶
optional_supporting_documents = 'OPTIONAL_SUPPORTING_DOCUMENTS'
FileEvidence ¶
Bases: EbayModel
file_id
class-attribute
instance-attribute
¶
file_id = Field(None, alias='fileId', description='This field is used to identify the evidence file to be uploaded to the evidence set. This file is created with the uploadEvidenceFile method and can be retrieved using the getPaymentDispute method.')
FileInfo ¶
Bases: EbayModel
file_id
class-attribute
instance-attribute
¶
file_id = Field(None, alias='fileId', description='The unique identifier of the evidence file.')
file_type
class-attribute
instance-attribute
¶
file_type = Field(None, alias='fileType', description='The type of file uploaded. Supported file extensions are .JPEG, .JPG, and .PNG., and maximum file size allowed is 1.5 MB.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-provided name of the evidence file.')
uploaded_date
class-attribute
instance-attribute
¶
uploaded_date = Field(None, alias='uploadedDate', description='The timestamp in this field shows the date/time when the seller uploaded the evidential document to eBay. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
FulfillmentInstructionsType ¶
Bases: OpenStrEnum
GiftDetails ¶
Bases: EbayModel
message
class-attribute
instance-attribute
¶
message = Field(None, description='This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift. Note: The message will not be returned for any order that is more than 90 days old.')
recipient_email
class-attribute
instance-attribute
¶
recipient_email = Field(None, alias='recipientEmail', description='The email address of the gift recipient. The seller will send the digital gift card to this email address. Note: The recipientEmail will not be returned for any order that is more than 90 days old.')
sender_name
class-attribute
instance-attribute
¶
sender_name = Field(None, alias='senderName', description='The name of the buyer, which will appear on the email that is sent to the gift recipient. Note: The senderName will not be returned for any order that is more than 90 days old.')
ItemLocation ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter ISO 3166 code representing the country of the address.')
location
class-attribute
instance-attribute
¶
location = Field(None, description='Indicates the geographical location of the item (along with the values in the countryCode and postalCode fields). This field provides city, province, state, or similar information. Note: If the item is shipped from a fulfillment center location through the Multi-Warehouse Program, this field will return the geographical location of the fulfillment center closest to the buyer.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the address.')
LegacyReference ¶
Bases: EbayModel
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The unique identifier of a listing. This value can be found in the Transaction container in the response of the GetOrders call of the Trading API . Note: Both legacyItemId and legacyTransactionId are needed to identify an order line item.')
legacy_transaction_id
class-attribute
instance-attribute
¶
legacy_transaction_id = Field(None, alias='legacyTransactionId', description="The unique identifier of a sale/transaction in legacy/Trading API format. A 'transaction ID' is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder. This value can be found in the Transaction container in the response of the getOrder call of the Trading API .")
LineItemFulfillmentInstructions ¶
Bases: EbayModel
destination_time_zone
class-attribute
instance-attribute
¶
destination_time_zone = Field(None, alias='destinationTimeZone', description='This field is reserved for internal or future use.')
guaranteed_delivery
class-attribute
instance-attribute
¶
guaranteed_delivery = Field(None, alias='guaranteedDelivery', description='Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description="The estimated latest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. The seller must pay extra attention to this date, as a failure to deliver by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status.")
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description="The estimated earliest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z")
ship_by_date
class-attribute
instance-attribute
¶
ship_by_date = Field(None, alias='shipByDate', description="The latest date and time by which the seller should ship line item in order to meet the expected delivery window. This timestamp will be set by eBay based on time of purchase and the seller's stated handling time.")
source_time_zone
class-attribute
instance-attribute
¶
source_time_zone = Field(None, alias='sourceTimeZone', description='This field is reserved for internal or future use.')
LineItemFulfillmentStatusEnum ¶
LineItemProperties ¶
Bases: EbayModel
buyer_protection
class-attribute
instance-attribute
¶
buyer_protection = Field(None, alias='buyerProtection', description="A value of true indicates that the line item is covered by eBay's Buyer Protection program.")
from_best_offer
class-attribute
instance-attribute
¶
from_best_offer = Field(None, alias='fromBestOffer', description='This field is only returned if true and indicates that the purchase occurred by the buyer and seller mutually agreeing on a Best Offer amount. The Best Offer feature can be set up for any listing type, but if this feature is set up for an auction listing, it will no longer be available once a bid has been placed on the listing.')
sold_via_ad_campaign
class-attribute
instance-attribute
¶
sold_via_ad_campaign = Field(None, alias='soldViaAdCampaign', description="This field is only returned if true and indicates that the line item was sold as a result of a seller's ad campaign.")
LineItemReference ¶
Bases: EbayModel
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='This is the unique identifier of the eBay order line item that is part of the shipping fulfillment. Line item Ids can be found in the lineItems.lineItemId field of the getOrders response.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='This is the number of lineItems associated with the trackingNumber specified by the seller. This must be a whole number greater than zero (0). Default: 1')
MarketplaceIdEnum ¶
Bases: OpenStrEnum
MonetaryTransactionReasonEnum ¶
MonetaryTransactionTypeEnum ¶
NameValuePair ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The text representing the name of the aspect for the name-value pair. For example, color or Tire Type .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value of the aspect for the name-value pair. For example, red or All Season .')
OrderFulfillmentStatus ¶
OrderLineItems ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of the eBay listing associated with the order.')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='The unique identifier of the line item within the order.')
OrderPaymentStatusEnum ¶
Bases: OpenStrEnum
OutcomeEnum ¶
PaymentDisputeActivity ¶
Bases: EbayModel
activity_date
class-attribute
instance-attribute
¶
activity_date = Field(None, alias='activityDate', description='The timestamp in this field shows the date/time of the payment dispute activity. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ . An example would be 2019-08-04T19:09:02.768Z .')
activity_type
class-attribute
instance-attribute
¶
activity_type = Field(None, alias='activityType', description='This enumeration value indicates the type of activity that occured on the payment dispute.')
actor
class-attribute
instance-attribute
¶
actor = Field(None, description='This enumeration value indicates the actor that performed the action. Possible values include the BUYER , SELLER , CS_AGENT (eBay customer service), or SYSTEM .')
PaymentDisputeActivityHistory ¶
Bases: EbayModel
activity
class-attribute
instance-attribute
¶
activity = Field(None, description='This array holds all activities of a payment dispute, from creation to resolution. For each activity, the activity type, the actor, and a timestamp is shown. The getActivities response is dynamic, and grows with each recorded activity.')
PaymentMethodTypeEnum ¶
Bases: OpenStrEnum
PaymentStatusEnum ¶
Phone ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description="The two-letter, ISO 3166 code associated with the seller's phone number. This field is needed if the buyer is located in a different country than the seller. It is also OK to provide if the buyer and seller are both located in the same country See CountryCodeEnum for a list of supported values.")
number
class-attribute
instance-attribute
¶
number = Field(None, description="The seller's primary phone number associated with the return address. When this number is provided in a contestPaymentDispute or contestPaymentDispute method, it is provided as one continuous numeric string, including the area code.")
PhoneNumber ¶
Bases: EbayModel
phone_number
class-attribute
instance-attribute
¶
phone_number = Field(None, alias='phoneNumber', description='The primary telephone number for the shipping recipient.')
PickupStep ¶
Bases: EbayModel
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description="A merchant-defined unique identifier of the merchant's store where the buyer will pick up their In-Store Pickup order. This field is always returned with the pickupStep container.")
PostSaleAuthenticationProgram ¶
Bases: EbayModel
outcome_reason
class-attribute
instance-attribute
¶
outcome_reason = Field(None, alias='outcomeReason', description='This field indicates the result of the authenticity verification inspection on an order line item. This field is not returned when the status value of the order line item is PENDING or PASSED . The possible values returned here are NOT_AUTHENTIC , NOT_AS_DESCRIBED , CUSTOMIZED , MISCATEGORIZED , or NOT_AUTHENTIC_NO_RETURN .')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are PENDING , PASSED , FAILED , or PASSED_WITH_EXCEPTION .')
Program ¶
Bases: EbayModel
authenticity_verification
class-attribute
instance-attribute
¶
authenticity_verification = Field(None, alias='authenticityVerification', description='This field is returned when the third-party authenticator performs the authentication verification inspection on the order line item. Different values will be returned based on whether the item passed or failed the authentication verification inspection.')
ebay_shipping
class-attribute
instance-attribute
¶
ebay_shipping = Field(None, alias='ebayShipping', description='This container is returned only if the order is an eBay shipping order. It consists of a field that indicates the provider of a shipping label for this order.')
ebay_vault
class-attribute
instance-attribute
¶
ebay_vault = Field(None, alias='ebayVault', description='This field provides information about the eBay vault program that has been selected for an order. This is returned only for those items that are eligible for the eBay Vault Program.')
ebay_international_shipping
class-attribute
instance-attribute
¶
ebay_international_shipping = Field(None, alias='ebayInternationalShipping', description='This container is returned if the order is being fulfilled through eBay International Shipping.')
fulfillment_program
class-attribute
instance-attribute
¶
fulfillment_program = Field(None, alias='fulfillmentProgram', description='This field provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner.')
Property ¶
Bases: EbayModel
property_display_name
class-attribute
instance-attribute
¶
property_display_name = Field(None, alias='propertyDisplayName', description='The display name of the motor vehicle aspect. This is the localized name of the compatibility property.')
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description="The name of the motor vehicle aspect. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.")
property_value
class-attribute
instance-attribute
¶
property_value = Field(None, alias='propertyValue', description='The value of the property specified in the propertyName field. For example, if the propertyName is Make , then the propertyValue will be the specific make of the vehicle, such as Toyota .')
ProtectionStatusEnum ¶
Bases: OpenStrEnum
partially_protected
class-attribute
instance-attribute
¶
partially_protected = 'PARTIALLY_PROTECTED'
RangeValue ¶
Bases: EbayModel
end
class-attribute
instance-attribute
¶
end = Field(None, description='The high end of the range; empty if the high end is unbounded.')
exclusive_end
class-attribute
instance-attribute
¶
exclusive_end = Field(None, alias='exclusiveEnd', description='A value of true indicates that the provided end value is not included in the range.')
exclusive_start
class-attribute
instance-attribute
¶
exclusive_start = Field(None, alias='exclusiveStart', description='A value of true indicates that the provided start value is not included in the range.')
range
class-attribute
instance-attribute
¶
range = Field(None, description='This field is reserved for internal or future use.')
start
class-attribute
instance-attribute
¶
start = Field(None, description='The low end of the range; empty if the low end is unbounded.')
ReasonForRefundEnum ¶
Bases: OpenStrEnum
item_not_as_described
class-attribute
instance-attribute
¶
item_not_as_described = 'ITEM_NOT_AS_DESCRIBED'
RefundStatusEnum ¶
RefundTypeEnum ¶
ReturnAddress ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of the street address. This line is not always necessarily, but is often used for apartment number or suite number, or other relevant information that can not fit on the first line.')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the return address.')
country
class-attribute
instance-attribute
¶
country = Field(None, description="The country's two-letter, ISO 3166-1 country code. See the enumeration type for a country's value.")
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county of the return address. Counties are not applicable to all countries.')
full_name
class-attribute
instance-attribute
¶
full_name = Field(None, alias='fullName', description='The full name of return address owner.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the return address.')
primary_phone
class-attribute
instance-attribute
¶
primary_phone = Field(None, alias='primaryPhone', description="This container shows the seller's primary phone number associated with the return address.")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the return address.')
SellerActionsToRelease ¶
Bases: EbayModel
seller_action_to_release
class-attribute
instance-attribute
¶
seller_action_to_release = Field(None, alias='sellerActionToRelease', description='A possible action that the seller can take to expedite the release of a payment hold. A sellerActionToRelease field is returned for each possible action that a seller may take. Possible actions may include providing shipping/tracking information, issuing a refund, providing refund information, contacting customer support, etc.')
SellerDecisionEnum ¶
Bases: OpenStrEnum
SellerResponseEnum ¶
ShippingFulfillment ¶
Bases: EbayModel
fulfillment_id
class-attribute
instance-attribute
¶
fulfillment_id = Field(None, alias='fulfillmentId', description='The unique identifier of the fulfillment; for example, 9405509699937003457459 . This eBay-generated value is created with a successful createShippingFulfillment call.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies.')
shipment_tracking_number
class-attribute
instance-attribute
¶
shipment_tracking_number = Field(None, alias='shipmentTrackingNumber', description='The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available.')
shipped_date
class-attribute
instance-attribute
¶
shipped_date = Field(None, alias='shippedDate', description='The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description="The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available. Note: The Trading API's ShippingCarrierCodeType enumeration type contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType .")
ShippingFulfillmentDetails ¶
Bases: EbayModel
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array contains a list of or more line items and the quantity that will be shipped in the same package.')
shipped_date
class-attribute
instance-attribute
¶
shipped_date = Field(None, alias='shippedDate', description='This is the actual date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. The seller should use the actual date/time that the package was shipped, but if this field is omitted, it will default to the current date/time.')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description="The unique identifier of the shipping carrier being used to ship the line item(s). Technically, the shippingCarrierCode and trackingNumber fields are optional, but generally these fields will be provided if the shipping carrier and tracking number are known. Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier enumeration values.")
tracking_number
class-attribute
instance-attribute
¶
tracking_number = Field(None, alias='trackingNumber', description='The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number. This field and the shippingCarrierCode field are mutually dependent. If you include one, you must also include the other.')
SimpleAmount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='A three-letter ISO 4217 code (such as USD for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are always returned with the amount container.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container.')
SoldFormatEnum ¶
Bases: OpenStrEnum
second_chance_offer
class-attribute
instance-attribute
¶
second_chance_offer = 'SECOND_CHANCE_OFFER'
TaxAddress ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city name that can be used by sellers for tax purposes.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The country code that can be used by sellers for tax purposes, represented as a two-letter ISO 3166‑1 alpha‑2 country code. For example, US represents the United States, and DE represents Germany.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code that can be used by sellers for tax purposes. Usually referred to as ZIP codes in the US.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state name that can be used by sellers for tax purposes.')
TaxIdentifierTypeEnum ¶
Bases: OpenStrEnum
TaxTypeEnum ¶
Bases: OpenStrEnum
electronic_recycling_fee
class-attribute
instance-attribute
¶
electronic_recycling_fee = 'ELECTRONIC_RECYCLING_FEE'
mattress_recycling_fee
class-attribute
instance-attribute
¶
mattress_recycling_fee = 'MATTRESS_RECYCLING_FEE'
battery_recycling_fee
class-attribute
instance-attribute
¶
battery_recycling_fee = 'BATTERY_RECYCLING_FEE'
white_goods_disposable_tax
class-attribute
instance-attribute
¶
white_goods_disposable_tax = 'WHITE_GOODS_DISPOSABLE_TAX'
TrackingInfo ¶
Bases: EbayModel
shipment_tracking_number
class-attribute
instance-attribute
¶
shipment_tracking_number = Field(None, alias='shipmentTrackingNumber', description='This string value represents the shipment tracking number of the package.')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='This string value represents the shipping carrier used to ship the package.')
UpdateEvidencePaymentDisputeRequest ¶
Bases: EbayModel
evidence_id
class-attribute
instance-attribute
¶
evidence_id = Field(None, alias='evidenceId', description='The unique identifier of the evidence set that is being updated with new evidence files. This ID is returned under the evidence array in the getPaymentDispute response.')
evidence_type
class-attribute
instance-attribute
¶
evidence_type = Field(None, alias='evidenceType', description='This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field. See the EvidenceTypeEnum type for the supported evidence types.')
files
class-attribute
instance-attribute
¶
files = Field(None, description='This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files array. The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This required array identifies the order line item(s) for which the evidence file(s) will be applicable. These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response. Note: Both the itemId and lineItemID fields are needed to identify each order line item.')
AcceptPaymentDisputeRequest ¶
Bases: EbayModel
return_address
class-attribute
instance-attribute
¶
return_address = Field(None, alias='returnAddress', description='This container is used if the seller wishes to provide a return address to the buyer. This container should be used if the seller is requesting that the buyer return the item.')
revision
class-attribute
instance-attribute
¶
revision = Field(None, description='This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.')
AddEvidencePaymentDisputeRequest ¶
Bases: EbayModel
evidence_type
class-attribute
instance-attribute
¶
evidence_type = Field(None, alias='evidenceType', description='This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field. See the EvidenceTypeEnum type for the supported evidence types.')
files
class-attribute
instance-attribute
¶
files = Field(None, description='This array is used to specify one or more evidence files that will become part of a new evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array identifies the order line item(s) for which the evidence file(s) will be applicable. These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response.')
Address ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address. Note: addressLine1 will not be returned for any order that is more than 90 days old.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address. Note: addressLine2 will not be returned for any order that is more than 90 days old.')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the shipping destination.')
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The country of the shipping destination, represented as a two-letter ISO 3166‑1 alpha‑2 country code. For example, US represents the United States, and DE represents Germany.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the shipping destination. This is usually referred to as ZIP codes in the US. Most countries have postal codes, but not all. The postal code will be returned, if applicable.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable.')
Amount ¶
Bases: EbayModel
converted_from_currency
class-attribute
instance-attribute
¶
converted_from_currency = Field(None, alias='convertedFromCurrency', description='A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required and represents the pre-conversion currency.')
converted_from_value
class-attribute
instance-attribute
¶
converted_from_value = Field(None, alias='convertedFromValue', description='The monetary amount, before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value in the currency specified by the currency field.')
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field. Default: The default currency with be that of the eBay marketplace that hosts the listing.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency. Required in the amount type.')
AppliedPromotion ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='A description of the applied sales promotion.')
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='The monetary amount of the sales promotion.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="An eBay-generated unique identifier of the sales promotion. Multiple types of sales promotions are available to eBay Store owners, including order size/volume discounts, shipping discounts, special coupons, and price markdowns. Sales promotions can be managed through the Marketing tab of Seller Hub in My eBay or by using the Marketing API's createItemPromotion method.")
AppointmentDetails ¶
Bases: EbayModel
appointment_end_time
class-attribute
instance-attribute
¶
appointment_end_time = Field(None, alias='appointmentEndTime', description='The date and time the appointment ends, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Required for tire installation. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-10-28T00:00:00.000Z')
appointment_start_time
class-attribute
instance-attribute
¶
appointment_start_time = Field(None, alias='appointmentStartTime', description='The date and time the appointment begins, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-10-28T00:10:00.000Z')
appointment_status
class-attribute
instance-attribute
¶
appointment_status = Field(None, alias='appointmentStatus', description='The status of the appointment.')
appointment_type
class-attribute
instance-attribute
¶
appointment_type = Field(None, alias='appointmentType', description='The type of appointment. MACRO appointments only have a start time (not bounded with end time). TIME_SLOT appointments have a period (both start time and end time). Required for tire installation.')
appointment_window
class-attribute
instance-attribute
¶
appointment_window = Field(None, alias='appointmentWindow', description='Appointment window for MACRO appointments.')
service_provider_appointment_date
class-attribute
instance-attribute
¶
service_provider_appointment_date = Field(None, alias='serviceProviderAppointmentDate', description='Service provider date of the appointment (no time stamp). Returned only for MACRO appointment types.')
CancelRequest ¶
Bases: EbayModel
cancel_completed_date
class-attribute
instance-attribute
¶
cancel_completed_date = Field(None, alias='cancelCompletedDate', description='This string is the date and time that the order cancellation was completed, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the cancellation request has actually been approved by the seller. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
cancel_initiator
class-attribute
instance-attribute
¶
cancel_initiator = Field(None, alias='cancelInitiator', description="This string value indicates the party who made the initial cancellation request. This is typically, either the 'Buyer' or 'Seller'. If a cancellation request has been made, this field should be returned.")
cancel_reason
class-attribute
instance-attribute
¶
cancel_reason = Field(None, alias='cancelReason', description="This string indicates the reason why the cancelInitiator initiated the cancellation request. Cancellation reasons for a buyer might include 'order placed by mistake' or 'order won't arrive in time'. For a seller, a typical cancellation reason is 'out of stock'. If a cancellation request has been made, this field should be returned.")
cancel_requested_date
class-attribute
instance-attribute
¶
cancel_requested_date = Field(None, alias='cancelRequestedDate', description='This string is the date and time that the order cancellation was requested. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is returned for each cancellation request. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
cancel_request_id
class-attribute
instance-attribute
¶
cancel_request_id = Field(None, alias='cancelRequestId', description='This string vlaue is the unique identifier of the order cancellation request. This field is returned for each cancellation request.')
cancel_request_state
class-attribute
instance-attribute
¶
cancel_request_state = Field(None, alias='cancelRequestState', description='The current stage or condition of the cancellation request. This field is returned for each cancellation request.')
CancelStatus ¶
Bases: EbayModel
cancelled_date
class-attribute
instance-attribute
¶
cancelled_date = Field(None, alias='cancelledDate', description='The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
cancel_requests
class-attribute
instance-attribute
¶
cancel_requests = Field(None, alias='cancelRequests', description='This array contains details of one or more buyer requests to cancel the order. For the getOrders call: This array is returned but is always empty. For the getOrder call: This array is returned fully populated with information about any cancellation requests.')
cancel_state
class-attribute
instance-attribute
¶
cancel_state = Field(None, alias='cancelState', description='The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned.')
Charge ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container shows the amount and currency of the charge.')
charge_type
class-attribute
instance-attribute
¶
charge_type = Field(None, alias='chargeType', description='This field shows the type of buyer charge. Note: Currently, the only supported charge type is BUYER_PROTECTION .')
ContestPaymentDisputeRequest ¶
Bases: EbayModel
note
class-attribute
instance-attribute
¶
note = Field(None, description='This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth. Max Length: 1000 characters.')
return_address
class-attribute
instance-attribute
¶
return_address = Field(None, alias='returnAddress', description='This container is needed if the seller is requesting that the buyer return the item. If this container is used, all relevant fields must be included, including fullName and primaryPhone . Note: If the Dispute Reason is SIGNIFICANTLY_NOT_AS_DESCRIBED , returnAddress is required.')
revision
class-attribute
instance-attribute
¶
revision = Field(None, description='This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.')
DeliveryCost ¶
Bases: EbayModel
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='The amount of any shipping discount that has been applied to the line item. This container is returned only if a shipping discount applies to the line item.')
handling_cost
class-attribute
instance-attribute
¶
handling_cost = Field(None, alias='handlingCost', description='The amount of any handing cost that has been applied to the line item. This container is returned only if a handling cost applies to the line item.')
import_charges
class-attribute
instance-attribute
¶
import_charges = Field(None, alias='importCharges', description='The amount of any import charges applied to international shipping of the line item. This container is only returned if import charges apply to the line item.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='The total cost of shipping all units of the line item. This container is always returned even when the shipping cost is free, in which case the value field will show 0.0 (dollars).')
shipping_intermediation_fee
class-attribute
instance-attribute
¶
shipping_intermediation_fee = Field(None, alias='shippingIntermediationFee', description="This field shows the fee due to eBay's international shipping provider for a line item that is being shipped through the Global Shipping Program. This container is only returned for line items being shipped internationally through the Global Shipping Program, which is currently only supported in the US and UK marketplaces.")
DisputeEvidence ¶
Bases: EbayModel
evidence_id
class-attribute
instance-attribute
¶
evidence_id = Field(None, alias='evidenceId', description='Unique identifier for the evidential file set. Each file set may contain multiple files, which is why there is a file set identifier and a separate identifier for each individual file within the set.')
evidence_type
class-attribute
instance-attribute
¶
evidence_type = Field(None, alias='evidenceType', description='This enumeration value shows the type of evidential file provided.')
files
class-attribute
instance-attribute
¶
files = Field(None, description='This array shows the name, ID, file type, and upload date for each provided file.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array shows one or more order line items associated with the evidential document that has been provided.')
provided_date
class-attribute
instance-attribute
¶
provided_date = Field(None, alias='providedDate', description='The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
request_date
class-attribute
instance-attribute
¶
request_date = Field(None, alias='requestDate', description='The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
respond_by_date
class-attribute
instance-attribute
¶
respond_by_date = Field(None, alias='respondByDate', description='The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
shipment_tracking
class-attribute
instance-attribute
¶
shipment_tracking = Field(None, alias='shipmentTracking', description='This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the evidence container if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY for an INR-related payment dispute.')
EbayCollectAndRemitTax ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="The monetary amount of the 'Collect and Remit' tax.")
ebay_reference
class-attribute
instance-attribute
¶
ebay_reference = Field(None, alias='ebayReference', description='This container field describes the line-item level VAT tax details.')
tax_type
class-attribute
instance-attribute
¶
tax_type = Field(None, alias='taxType', description='The type of tax and fees that eBay will collect and remit to the taxing or fee authority. See the TaxTypeEnum type definition for more information about each tax or fee type.')
collection_method
class-attribute
instance-attribute
¶
collection_method = Field(None, alias='collectionMethod', description="This field indicates the collection method used to collect the 'Collect and Remit' tax for the order. This field is always returned for orders subject to 'Collect and Remit' tax, and its value is always NET .")
EbayCollectedCharges ¶
Bases: EbayModel
ebay_shipping
class-attribute
instance-attribute
¶
ebay_shipping = Field(None, alias='ebayShipping', description='This container consists of costs related to eBay Shipping collected by eBay from the buyer of this order.')
charges
class-attribute
instance-attribute
¶
charges = Field(None, description='This array shows any charges that eBay collects from the buyer. Note: Currently, the only supported charge type is BUYER_PROTECTION .')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='The context or source of this error or warning.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='The name of the domain containing the service or application. For example, sell is a domain.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='An expanded version of the message field. Maximum length: 200 characters')
message
class-attribute
instance-attribute
¶
message = Field(None, description="A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale. Maximum length: 50 characters")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='Contains a list of name-value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description="The name of the domain's subsystem or subdivision. For example, fulfillment is a subdomain in the sell domain.")
EvidenceRequest ¶
Bases: EbayModel
evidence_id
class-attribute
instance-attribute
¶
evidence_id = Field(None, alias='evidenceId', description='Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set.')
evidence_type
class-attribute
instance-attribute
¶
evidence_type = Field(None, alias='evidenceType', description='This enumeration value shows the type of evidential document provided.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array shows one or more order line items associated with the evidential document that has been provided.')
request_date
class-attribute
instance-attribute
¶
request_date = Field(None, alias='requestDate', description='The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
respond_by_date
class-attribute
instance-attribute
¶
respond_by_date = Field(None, alias='respondByDate', description='The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
ExtendedContact ¶
Bases: EbayModel
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner.')
contact_address
class-attribute
instance-attribute
¶
contact_address = Field(None, alias='contactAddress', description='This container shows the shipping address of the buyer or eBay shipping partner.')
email
class-attribute
instance-attribute
¶
email = Field(None, description='This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned. Note: If returned, this field contains the email address of the buyer, even for Global Shipping Program shipments. The email will not be returned for any order that is more than 90 days old.')
full_name
class-attribute
instance-attribute
¶
full_name = Field(None, alias='fullName', description='The full name of the buyer or eBay shipping partner. Note: The fullName will not be returned for any order that is more than 90 days old.')
primary_phone
class-attribute
instance-attribute
¶
primary_phone = Field(None, alias='primaryPhone', description='The primary telephone number of the buyer or eBay shipping partner. Note: The primaryPhone will not be returned for any order that is more than 90 days old.')
Fee ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The monetary amount of the special fee. This field is always returned for each fee that is returned under the fee container.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='An explanation of the special fee charged to the buyer, such as a Electronic Waste Recycling Fee, or a Tire Recycling Fee. This field is always returned for each fee that is returned under the fee container.')
FilterField ¶
Bases: EbayModel
field
class-attribute
instance-attribute
¶
field = Field(None, description='The name of a field to be used in the filter. Currently, three fields can be used: creationdate , lastmodifieddate , and orderfulfillmentstatus .')
range
class-attribute
instance-attribute
¶
range = Field(None, description='Contains the criteria for specifying a range of values of the specified field .')
set
class-attribute
instance-attribute
¶
set = Field(None, description='An enumerated set of values of the specified field that apply simultaneously to the filter.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='A single value of the specified field that applies to the filter.')
InfoFromBuyer ¶
Bases: EbayModel
content_on_hold
class-attribute
instance-attribute
¶
content_on_hold = Field(None, alias='contentOnHold', description="When the value of this field is true it indicates that the buyer's note regarding the payment dispute (i.e., the buyerProvided.note field,) is on hold. When this is the case, the buyerProvided.note field will not be returned. When the value of this field is false , it is not returned.")
note
class-attribute
instance-attribute
¶
note = Field(None, description='This field shows any note that was left by the buyer in regard to the dispute.')
return_shipment_tracking
class-attribute
instance-attribute
¶
return_shipment_tracking = Field(None, alias='returnShipmentTracking', description='This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute.')
LineItemRefund ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="This field shows the refund amount for a line item. This field is only returned if the buyer is due a refund for the line item. Note: The refund amount shown is the seller's net amount received from the sale/transaction. EBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value.")
refund_date
class-attribute
instance-attribute
¶
refund_date = Field(None, alias='refundDate', description='The date and time that the refund was issued for the line item. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
refund_id
class-attribute
instance-attribute
¶
refund_id = Field(None, alias='refundId', description="Unique identifier of a refund that was initiated for an order's line item through the issueRefund method. If the issueRefund method was used to issue a refund at the order level, this identifier is returned at the order level instead ( paymentSummary.refunds.refundId field).")
refund_reference_id
class-attribute
instance-attribute
¶
refund_reference_id = Field(None, alias='refundReferenceId', description='This field is reserved for internal or future use.')
LinkedOrderLineItem ¶
Bases: EbayModel
line_item_aspects
class-attribute
instance-attribute
¶
line_item_aspects = Field(None, alias='lineItemAspects', description='This array contains the complete set of item aspects for the linked line item. For example: "lineItemAspects": [ { "name": "Tire Type", "value": "All Season" }, ... { "name": "Car Type", "value": "Performance" } ] Note: All item specifics for the listing are returned.')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='The unique identifier of the linked order line item.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='The end of the date range in which the linked line item is expected to be delivered to the shipping address.')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='The beginning of the date range in which the linked line item is expected to be delivered to the shipping address.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the order to which the linked line item belongs.')
seller_id
class-attribute
instance-attribute
¶
seller_id = Field(None, alias='sellerId', description='The eBay user ID of the seller who sold the linked line item. For example, the user ID of the tire seller. 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 .')
shipments
class-attribute
instance-attribute
¶
shipments = Field(None, description='An array containing any shipment tracking information available for the linked line item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The listing title of the linked line item. Note: The Item ID value for the listing will be returned in this field instead of the actual title if this particular listing is on-hold due to an eBay policy violation.')
MonetaryTransaction ¶
Bases: EbayModel
date
class-attribute
instance-attribute
¶
date = Field(None, description='This timestamp indicates when the monetary transaction occurred. A date is returned for all monetary transactions. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ . For example, 2015-08-04T19:09:02.768Z .')
type
class-attribute
instance-attribute
¶
type = Field(None, description='This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller.')
reason
class-attribute
instance-attribute
¶
reason = Field(None, description='This enumeration value indicates the reason for the monetary transaction.')
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well.')
OrderRefund ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="This field shows the refund amount for an order. This container is always returned for each refund. Note: The refund amount shown is the seller's net amount received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value.")
refund_date
class-attribute
instance-attribute
¶
refund_date = Field(None, alias='refundDate', description='The date and time that the refund was issued. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
refund_id
class-attribute
instance-attribute
¶
refund_id = Field(None, alias='refundId', description='Unique identifier of a refund that was initiated for an order through the issueRefund method. If the issueRefund method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead ( lineItems.refunds.refundId field).')
refund_reference_id
class-attribute
instance-attribute
¶
refund_reference_id = Field(None, alias='refundReferenceId', description='The eBay-generated unique identifier for the refund. This field is not returned until the refund has been issued.')
refund_status
class-attribute
instance-attribute
¶
refund_status = Field(None, alias='refundStatus', description='This enumeration value indicates the current status of the refund to the buyer. This container is always returned for each refund.')
PaymentDisputeOutcomeDetail ¶
Bases: EbayModel
fees
class-attribute
instance-attribute
¶
fees = Field(None, description='This container will show the dollar value of any fees associated with the payment dispute. This container is only returned if there are fees associated with the payment dispute.')
protected_amount
class-attribute
instance-attribute
¶
protected_amount = Field(None, alias='protectedAmount', description="This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy.")
protection_status
class-attribute
instance-attribute
¶
protection_status = Field(None, alias='protectionStatus', description='This enumeration value indicates if the seller is fully protected, partially protected, or not protected by eBay for the payment dispute. This field is always returned once the payment dispute is resolved.')
reason_for_closure
class-attribute
instance-attribute
¶
reason_for_closure = Field(None, alias='reasonForClosure', description='The enumeration value returned in this field indicates the outcome of the payment dispute for the seller. This field is always returned once the payment dispute is resolved.')
recoup_amount
class-attribute
instance-attribute
¶
recoup_amount = Field(None, alias='recoupAmount', description="This container shows the dollar amount being recouped from the seller. This container is empty if the seller wins the payment dispute or if the seller is fully protected by eBay's seller protection policy.")
total_fee_credit
class-attribute
instance-attribute
¶
total_fee_credit = Field(None, alias='totalFeeCredit', description='This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled.')
PaymentDisputeSummary ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. This container is returned for all payment disputes returned in the response.")
buyer_username
class-attribute
instance-attribute
¶
buyer_username = Field(None, alias='buyerUsername', description="This is the buyer's eBay user ID. This field is returned for all payment disputes returned in the response. 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 .")
closed_date
class-attribute
instance-attribute
¶
closed_date = Field(None, alias='closedDate', description='The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.')
open_date
class-attribute
instance-attribute
¶
open_date = Field(None, alias='openDate', description='The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='This is the unique identifier of the order involved in the payment dispute.')
payment_dispute_id
class-attribute
instance-attribute
¶
payment_dispute_id = Field(None, alias='paymentDisputeId', description='This is the unique identifier of the payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. This identifier is passed in at the end of the getPaymentDispute call URI to retrieve a specific payment dispute. The getPaymentDispute method returns more details about a payment dispute than the getPaymentDisputeSummaries method.')
payment_dispute_status
class-attribute
instance-attribute
¶
payment_dispute_status = Field(None, alias='paymentDisputeStatus', description='The enumeration value in this field gives the current status of the payment dispute.')
reason
class-attribute
instance-attribute
¶
reason = Field(None, description='The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute.')
respond_by_date
class-attribute
instance-attribute
¶
respond_by_date = Field(None, alias='respondByDate', description='The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that require action by the seller, that same seller must call getPaymentDispute to see the next action(s) that they can take against the payment dispute.')
PaymentHold ¶
Bases: EbayModel
expected_release_date
class-attribute
instance-attribute
¶
expected_release_date = Field(None, alias='expectedReleaseDate', description='The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field will be returned if known by eBay. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
hold_amount
class-attribute
instance-attribute
¶
hold_amount = Field(None, alias='holdAmount', description='The monetary amount of the payment being held. This field is always returned with the paymentHolds array.')
hold_reason
class-attribute
instance-attribute
¶
hold_reason = Field(None, alias='holdReason', description="The reason that the payment is being held. A seller's payment may be held for a number of reasons, including when the seller is new, the seller's level is below standard, or if a return case or 'Significantly not as described' case is pending against the seller. This field is always returned with the paymentHolds array.")
hold_state
class-attribute
instance-attribute
¶
hold_state = Field(None, alias='holdState', description='The current stage or condition of the hold. This field is always returned with the paymentHolds array. Applicable values: HELD HELD_PENDING NOT_HELD RELEASE_CONFIRMED RELEASE_FAILED RELEASE_PENDING RELEASED')
release_date
class-attribute
instance-attribute
¶
release_date = Field(None, alias='releaseDate', description="The date and time that the payment being held was actually released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the seller's payment is actually released into the seller's account. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z")
seller_actions_to_release
class-attribute
instance-attribute
¶
seller_actions_to_release = Field(None, alias='sellerActionsToRelease', description='A list of one or more possible actions that the seller can take to expedite the release of the payment hold.')
PricingSummary ¶
Bases: EbayModel
adjustment
class-attribute
instance-attribute
¶
adjustment = Field(None, description='This container shows the total amount of any adjustments that were applied to the cost of the item(s) in the order. This amount does not include shipping, discounts, fixed fees, or taxes. This container is only returned if price adjustments were made to the order after the initial transaction/commitment to buy occurred.')
delivery_cost
class-attribute
instance-attribute
¶
delivery_cost = Field(None, alias='deliveryCost', description='This container shows the total cost of delivering the order to the buyer before any shipping/delivery discount is applied.')
delivery_discount
class-attribute
instance-attribute
¶
delivery_discount = Field(None, alias='deliveryDiscount', description='This container shows the total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number. This container is only returned if delivery discounts are being applied to the order.')
fee
class-attribute
instance-attribute
¶
fee = Field(None, description='This container shows the total amount of any special fees applied to the order, such as a tire recycling fee or an electronic waste fee. This container is returned if special fees are being applied to the order and if the fieldGroups is set to TAX_BREAKDOWN .')
price_discount
class-attribute
instance-attribute
¶
price_discount = Field(None, alias='priceDiscount', description='This container shows the total amount of all item price discounts (including promotions) that apply to the order and reduce its cost to the buyer. This should be a negative real number. This container is only returned if special discounts are being applied to the order.')
price_subtotal
class-attribute
instance-attribute
¶
price_subtotal = Field(None, alias='priceSubtotal', description='This container shows the cumulative costs of of all units of all line items in the order before any discount is applied.')
tax
class-attribute
instance-attribute
¶
tax = Field(None, description='This container shows the total amount of tax for the order. To calculate the tax percentage rate, divide this value by the value of the total field. This container is only returned if any type of tax (sales tax, tax on shipping, tax on handling, import tax, etc.) is applied to the order.')
total
class-attribute
instance-attribute
¶
total = Field(None, description="The total cost of the order after adding all line item costs, delivery costs, sales tax, and special fees and then subtracting all special discounts and price adjustments. Note: For orders that are subject to eBay 'Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN .")
Refund ¶
Bases: EbayModel
refund_id
class-attribute
instance-attribute
¶
refund_id = Field(None, alias='refundId', description='The unique identifier of the order refund. This value is returned unless the refund operation fails ( refundStatus value shows FAILED ). This identifier can be used to track the status of the refund through a getOrder or getOrders call.')
refund_status
class-attribute
instance-attribute
¶
refund_status = Field(None, alias='refundStatus', description='The value returned in this field indicates the success or failure of the refund operation. A successful issueRefund operation should result in a value of PENDING . A failed issueRefund operation should result in a value of FAILED , and an HTTP status code and/or API error code may also get returned to possibly indicate the issue.')
RefundItem ¶
Bases: EbayModel
refund_amount
class-attribute
instance-attribute
¶
refund_amount = Field(None, alias='refundAmount', description='This container is used to specify the amount of the refund for the corresponding order line item. If a seller wants to issue a refund for an entire order, the seller would use the orderLevelRefundAmount container instead.')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description="The unique identifier of an order line item. This identifier is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder. Either this field or the legacyReference container is needed to identify an individual order line item that will receive a refund. This value is returned using the getOrders method.")
legacy_reference
class-attribute
instance-attribute
¶
legacy_reference = Field(None, alias='legacyReference', description='This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID/transaction ID pair to identify the order line item. Either this container or the lineItemId field is needed to identify an individual order line item that will receive a refund.')
ShippingFulfillmentPagedCollection ¶
Bases: EbayModel
fulfillments
class-attribute
instance-attribute
¶
fulfillments = Field(None, description='This array contains one or more fulfillments required for the order that was specified in method endpoint.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of fulfillments in the specified order. Note: If no fulfillments are found for the order, this field is returned with a value of 0 .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This array is only returned if one or more errors or warnings occur with the call request.')
ShippingStep ¶
Bases: EbayModel
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description="The unique identifier of the shipping carrier being used to ship the line item. Note: The Trading API's GeteBayDetails call can be used to retrieve the latest shipping carrier and shipping service option enumeration values.")
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description="The unique identifier of the shipping service option being used to ship the line item. Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier and shipping service option enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingServiceDetails .")
ship_to
class-attribute
instance-attribute
¶
ship_to = Field(None, alias='shipTo', description="This container consists of shipping and contact information about the individual or organization to whom the fulfillment package will be shipped. Note: When FulfillmentInstructionsType is FULFILLED_BY_EBAY , there will be no shipTo address displayed. Note: For Digitally Delivered Goods (DDG), this address is the same as the Buyer's Registration Address.")
ship_to_reference_id
class-attribute
instance-attribute
¶
ship_to_reference_id = Field(None, alias='shipToReferenceId', description='This is the unique identifer of the Global Shipping Program (GSP) shipment. This field is only returned if the line item is being shipped via GSP (the value of the fulfillmentStartInstructions.ebaySupportedFulfillment field will be true .')
Tax ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The monetary amount of the tax. The taxes array is always returned for each line item in the order, but this amount will only be returned when the line item is subject to any type of sales tax.')
tax_type
class-attribute
instance-attribute
¶
tax_type = Field(None, alias='taxType', description='Tax type. This field is only available when fieldGroups is set to TAX_BREAKDOWN . If the order has fees, a breakdown of the fees is also provided.')
TaxIdentifier ¶
Bases: EbayModel
taxpayer_id
class-attribute
instance-attribute
¶
taxpayer_id = Field(None, alias='taxpayerId', description='This value is the unique tax ID associated with the buyer. The type of tax identification is shown in the taxIdentifierType field.')
tax_identifier_type
class-attribute
instance-attribute
¶
tax_identifier_type = Field(None, alias='taxIdentifierType', description='This enumeration value indicates the type of tax identification being used for the buyer. The different tax types are defined in the TaxIdentifierTypeEnum type.')
issuing_country
class-attribute
instance-attribute
¶
issuing_country = Field(None, alias='issuingCountry', description="This two-letter code indicates the country that issued the buyer's tax ID. The country that the two-letter code represents can be found in the CountryCodeEnum type or in the ISO 3166 standard.")
Buyer ¶
Bases: EbayModel
buyer_registration_address
class-attribute
instance-attribute
¶
buyer_registration_address = Field(None, alias='buyerRegistrationAddress', description="This container is the buyer's contact information that includes the buyer's name, email, phone number, and address.")
tax_address
class-attribute
instance-attribute
¶
tax_address = Field(None, alias='taxAddress', description='This container consists of address information that can be used by sellers for tax purpose. Note: When using the eBay vault program, if an item is shipped to a vault, the tax address will be the vault address.')
tax_identifier
class-attribute
instance-attribute
¶
tax_identifier = Field(None, alias='taxIdentifier', description='This container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces. Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders .')
username
class-attribute
instance-attribute
¶
username = Field(None, description="The buyer's eBay user 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 .")
DisputeSummaryResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the getPaymentDisputeSummaries call request that produced the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This value shows the maximum number of payment disputes that will appear on one page of the result set. The limit value can be passed in as a query parameter in the request, or if it is not used, it defaults to 200 . If the value in the total field exceeds this limit value, there are multiple pages in the current result set. Min : 1; Max : 200; Default : 200')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The getPaymentDisputeSummaries call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 11 through 20 from the collection of payment disputes: path/payment_dispute_summary?limit=10&offset=10 This field is only returned if there is a next page of results to view based on the current input criteria.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This integer value indicates the number of payment disputes skipped before listing the first payment dispute from the result set. The offset value can be passed in as a query parameter in the request, or if it is not used, it defaults to 0 and the first payment dispute of the result set is shown at the top of the response.')
payment_dispute_summaries
class-attribute
instance-attribute
¶
payment_dispute_summaries = Field(None, alias='paymentDisputeSummaries', description='Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The getPaymentDisputeSummaries call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 through 10 from the collection of payment disputes: path/payment_dispute_summary?limit=10&offset=0 This field is only returned if there is a previous page of results to view based on the current input criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This integer value is the total number of payment disputes that matched the input criteria. If the total number of entries exceeds the value that was set for limit in the request payload, you will have to make multiple API calls to see all pages of the results set. This field is returned even if it is 0 .')
FulfillmentStartInstruction ¶
Bases: EbayModel
appointment
class-attribute
instance-attribute
¶
appointment = Field(None, description='This container provides information used by the installation provider concerning appointment details selected by the buyer.')
destination_time_zone
class-attribute
instance-attribute
¶
destination_time_zone = Field(None, alias='destinationTimeZone', description='This field is reserved for internal or future use.')
ebay_supported_fulfillment
class-attribute
instance-attribute
¶
ebay_supported_fulfillment = Field(None, alias='ebaySupportedFulfillment', description="This field is only returned if its value is true and indicates that the fulfillment will be shipped via eBay's Global Shipping Program, eBay International Shipping, or the Authenticity Guarantee service program. For more information, see the Global Shipping Program help topic.")
final_destination_address
class-attribute
instance-attribute
¶
final_destination_address = Field(None, alias='finalDestinationAddress', description="This container is only returned if the value of ebaySupportedFulfillment field is true . This is the final destination address for a Global Shipping Program shipment or an eBay International Shipping shipment, which is usually the recipient's home. Sellers should not ship directly to this address; instead they should ship this package to their international shipping provider's domestic warehouse.")
fulfillment_instructions_type
class-attribute
instance-attribute
¶
fulfillment_instructions_type = Field(None, alias='fulfillmentInstructionsType', description='The enumeration value returned in this field indicates the method of fulfillment that will be used to deliver this set of line items (this package) to the buyer. This field will have a value of SHIP_TO if the ebaySupportedFulfillment field is returned with a value of true . See the FulfillmentInstructionsType definition for more information about different fulfillment types.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='This is the estimated latest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned ifthe value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP . Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='This is the estimated earliest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned if the value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP . Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
pickup_step
class-attribute
instance-attribute
¶
pickup_step = Field(None, alias='pickupStep', description="This container is only returned for In-Store Pickup orders, and it indicates the specific merchant's store where the buyer will pick up the order. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces.")
shipping_step
class-attribute
instance-attribute
¶
shipping_step = Field(None, alias='shippingStep', description='This container consists of shipping information for this fulfillment, including the shipping carrier, the shipping service option, and the shipment destination. This container is not returned if the value of the fulfillmentInstructionsType field is DIGITAL , or for In-Store Pickup orders.')
IssueRefundRequest ¶
Bases: EbayModel
reason_for_refund
class-attribute
instance-attribute
¶
reason_for_refund = Field(None, alias='reasonForRefund', description='The enumeration value passed in this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.')
comment
class-attribute
instance-attribute
¶
comment = Field(None, description='This free-text field allows the seller to clarify why the refund is being issued to the buyer. Max Length : 100')
refund_items
class-attribute
instance-attribute
¶
refund_items = Field(None, alias='refundItems', description='The refundItems array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order.')
order_level_refund_amount
class-attribute
instance-attribute
¶
order_level_refund_amount = Field(None, alias='orderLevelRefundAmount', description='This container is used to specify the amount of the refund for the entire order. If a seller wants to issue a refund for an individual line item within a multiple line item order, the seller would use the refundItems array instead.')
LineItem ¶
Bases: EbayModel
applied_promotions
class-attribute
instance-attribute
¶
applied_promotions = Field(None, alias='appliedPromotions', description='This array contains information about one or more sales promotions or discounts applied to the line item. It is always returned, but will be returned as an empty array if no special sales promotions or discounts apply to the order line item.')
compatibility_properties
class-attribute
instance-attribute
¶
compatibility_properties = Field(None, alias='compatibilityProperties', description="This array is only returned for a Parts & Accessory item and identifies the buyer's motor vehicle that is compatible with the part or accessory.")
delivery_cost
class-attribute
instance-attribute
¶
delivery_cost = Field(None, alias='deliveryCost', description='This container consists of a breakdown of all costs associated with the fulfillment of the line item.')
discounted_line_item_cost
class-attribute
instance-attribute
¶
discounted_line_item_cost = Field(None, alias='discountedLineItemCost', description='The cost of the line item after applying any discounts. This container is only returned if the order line item was discounted through a promotion.')
ebay_collect_and_remit_taxes
class-attribute
instance-attribute
¶
ebay_collect_and_remit_taxes = Field(None, alias='ebayCollectAndRemitTaxes', description="This container will be returned if the order 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_collected_charges
class-attribute
instance-attribute
¶
ebay_collected_charges = Field(None, alias='ebayCollectedCharges', description='This container consists of a breakdown of costs that are collected by eBay from the buyer for this order. Note: Currently, this container is returned only if eBay is directly charging the buyer for eBay shipping.')
gift_details
class-attribute
instance-attribute
¶
gift_details = Field(None, alias='giftDetails', description='This container consists of information that is needed by the seller to send a digital gift card to the buyer or recipient of the digital gift card. This container is only returned and applicable for digital gift card line items.')
item_location
class-attribute
instance-attribute
¶
item_location = Field(None, alias='itemLocation', description='This container field describes the physical location of the order line item. Note: If the item is shipped from a fulfillment center location through the Multi‑Warehouse Program, this container will return the location details of the fulfillment center closest to the buyer.')
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The eBay-generated legacy listing item ID of the listing. Note that the unique identifier of a listing in REST-based APIs is called the listingId instead.')
legacy_variation_id
class-attribute
instance-attribute
¶
legacy_variation_id = Field(None, alias='legacyVariationId', description='The unique identifier of a single variation within a multiple-variation listing. This field is only returned if the line item purchased was from a multiple-variation listing.')
line_item_cost
class-attribute
instance-attribute
¶
line_item_cost = Field(None, alias='lineItemCost', description='The selling price of the line item before applying any discounts. The value of this field is calculated by multiplying the single unit price by the number of units purchased (value of the quantity field).')
line_item_fulfillment_instructions
class-attribute
instance-attribute
¶
line_item_fulfillment_instructions = Field(None, alias='lineItemFulfillmentInstructions', description="This container consists of information related to shipping dates and expectations, including the 'ship-by date' and expected delivery windows that are based on the seller's stated handling time and the shipping service option that will be used.")
line_item_fulfillment_status
class-attribute
instance-attribute
¶
line_item_fulfillment_status = Field(None, alias='lineItemFulfillmentStatus', description='This enumeration value indicates the current fulfillment status of the line item.')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='This is the unique identifier of an eBay order line item. This field is created as soon as there is a commitment to buy from the seller.')
linked_order_line_items
class-attribute
instance-attribute
¶
linked_order_line_items = Field(None, alias='linkedOrderLineItems', description='An array of one or more line items related to the corresponding order, but not a part of that order. Details include the order ID, line item ID and title of the linked line item, the seller of that item, item specifics, estimated delivery times, and shipment tracking (if available).')
listing_marketplace_id
class-attribute
instance-attribute
¶
listing_marketplace_id = Field(None, alias='listingMarketplaceId', description='The unique identifier of the eBay marketplace where the line item was listed.')
properties
class-attribute
instance-attribute
¶
properties = Field(None, description='Contains information about the eBay programs, if any, under which the line item was listed.')
purchase_marketplace_id
class-attribute
instance-attribute
¶
purchase_marketplace_id = Field(None, alias='purchaseMarketplaceId', description='The unique identifier of the eBay marketplace where the line item was listed. Often, the listingMarketplaceId and the purchaseMarketplaceId identifier are the same, but there are occasions when an item will surface on multiple eBay marketplaces.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The number of units of the line item in the order. These are represented as a group by a single lineItemId .')
refunds
class-attribute
instance-attribute
¶
refunds = Field(None, description='This array is always returned, but it is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description="Seller-defined Stock-Keeping Unit (SKU). This inventory identifier must be unique within the seller's eBay inventory. SKUs are optional when listing in the legacy Trading API system, but SKUs are required when listing items through the Inventory API model.")
sold_format
class-attribute
instance-attribute
¶
sold_format = Field(None, alias='soldFormat', description='The eBay listing type of the line item. The most common listing types are AUCTION and FIXED_PRICE .')
taxes
class-attribute
instance-attribute
¶
taxes = Field(None, description='Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of the listing. Note: The Item ID value for the listing will be returned in this field instead of the actual title if this particular listing is on-hold due to an eBay policy violation.')
total
class-attribute
instance-attribute
¶
total = Field(None, description="This is the total price that the buyer must pay for the line item after all costs (item cost, delivery cost, taxes) are added, minus any discounts and/or promotions. Note: For orders that are subject to eBay 'Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN .")
variation_aspects
class-attribute
instance-attribute
¶
variation_aspects = Field(None, alias='variationAspects', description='An array of aspect name-value pairs that identifies the specific variation of a multi-variation listing. This array can contain multiple name-value pairs, such as color:blue and size:large , and will only be returned for orders created from a multiple-variation listing.')
Payment ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The amount that seller receives for the order via the payment method mentioned in Payment.paymentMethod .')
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 field will not be returned if buyer has yet to pay for the order. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
payment_holds
class-attribute
instance-attribute
¶
payment_holds = Field(None, alias='paymentHolds', description="This container is only returned if eBay is temporarily holding the seller's funds for the order. If a payment hold has been placed on the order, this container includes the reason for the payment hold, the expected release date of the funds into the seller's account, the current state of the hold, and as soon as the payment hold has been released, the actual release date.")
payment_method
class-attribute
instance-attribute
¶
payment_method = Field(None, alias='paymentMethod', description='The payment method used to pay for the order. See the PaymentMethodTypeEnum type for more information on the payment methods. Note: Effective September 26, 2025, access to buyer payment details for U.S. users will be limited to select developers. All other developers will receive a value of "CustomCode" in place of buyer payment details.')
payment_reference_id
class-attribute
instance-attribute
¶
payment_reference_id = Field(None, alias='paymentReferenceId', description='This field is only returned if payment has been made by the buyer, and the paymentMethod is ESCROW . This field contains a special ID for ESCROW.')
payment_status
class-attribute
instance-attribute
¶
payment_status = Field(None, alias='paymentStatus', description='The enumeration value returned in this field indicates the status of the payment for the order. See the PaymentStatusEnum type definition for more information on the possible payment states.')
PaymentDispute ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace.")
available_choices
class-attribute
instance-attribute
¶
available_choices = Field(None, alias='availableChoices', description='The value(s) returned in this array indicate the choices that the seller has when responding to the payment dispute. Once the seller has responded to the payment dispute, this field will no longer be shown, and instead, the sellerResponse field will show the decision that the seller made.')
buyer_provided
class-attribute
instance-attribute
¶
buyer_provided = Field(None, alias='buyerProvided', description='This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return.')
buyer_username
class-attribute
instance-attribute
¶
buyer_username = Field(None, alias='buyerUsername', description='This is the eBay user ID of the buyer that initiated the payment dispute. 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 .')
closed_date
class-attribute
instance-attribute
¶
closed_date = Field(None, alias='closedDate', description='The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.')
evidence
class-attribute
instance-attribute
¶
evidence = Field(None, description='This container shows any evidence that has been provided by the seller to contest the payment dispute. Evidence may include shipment tracking information, proof of authentication documentation, image(s) to proof that an item is as described, or financial documentation/invoice.')
evidence_requests
class-attribute
instance-attribute
¶
evidence_requests = Field(None, alias='evidenceRequests', description='This container is returned if one or more evidence documents are being requested from the seller.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array is used to identify one or more order line items associated with the payment dispute. There will always be at least one itemId / lineItemId pair returned in this array.')
monetary_transactions
class-attribute
instance-attribute
¶
monetary_transactions = Field(None, alias='monetaryTransactions', description='This array provide details about one or more monetary transactions that occur as part of a payment dispute. This array is only returned once one or more monetary transacations occur with a payment dispute.')
note
class-attribute
instance-attribute
¶
note = Field(None, description='This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth. This field is limited to 1000 characters.')
open_date
class-attribute
instance-attribute
¶
open_date = Field(None, alias='openDate', description='The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states. The timestamps returned here use the ISO 8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO 8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ .')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='This is the unique identifier of the order involved in the payment dispute.')
payment_dispute_id
class-attribute
instance-attribute
¶
payment_dispute_id = Field(None, alias='paymentDisputeId', description='This is the unique identifier of the payment dispute. This is the same identifier that is passed in to the call URI. This identifier is automatically created by eBay once the payment dispute comes into the eBay system.')
payment_dispute_status
class-attribute
instance-attribute
¶
payment_dispute_status = Field(None, alias='paymentDisputeStatus', description='The enumeration value in this field gives the current status of the payment dispute. The status of a payment dispute partially determines other fields that are returned in the response.')
reason
class-attribute
instance-attribute
¶
reason = Field(None, description='The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute.')
resolution
class-attribute
instance-attribute
¶
resolution = Field(None, description='This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes.')
respond_by_date
class-attribute
instance-attribute
¶
respond_by_date = Field(None, alias='respondByDate', description='The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that currently require action by the seller, that same seller should look at the availableChoices array to see the available actions.')
return_address
class-attribute
instance-attribute
¶
return_address = Field(None, alias='returnAddress', description='This container gives the address where the order will be returned to. This container is returned if the seller is accepting the payment dispute and will issue a refund to the buyer once the item is returned to this address.')
revision
class-attribute
instance-attribute
¶
revision = Field(None, description='This integer value indicates the revision number of the payment dispute. Each time an action is taken against a payment dispute, this integer value increases by 1.')
seller_response
class-attribute
instance-attribute
¶
seller_response = Field(None, alias='sellerResponse', description='The enumeration value returned in this field indicates how the seller has responded to the payment dispute. The seller has the option of accepting the payment dispute and agreeing to issue a refund, accepting the payment dispute and agreeing to issue a refund as long as the buyer returns the item, or contesting the payment dispute.')
PaymentSummary ¶
Bases: EbayModel
payments
class-attribute
instance-attribute
¶
payments = Field(None, description='This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made.')
refunds
class-attribute
instance-attribute
¶
refunds = Field(None, description='This array is always returned, but it is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.')
total_due_seller
class-attribute
instance-attribute
¶
total_due_seller = Field(None, alias='totalDueSeller', description='This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items.')
Order ¶
Bases: EbayModel
buyer
class-attribute
instance-attribute
¶
buyer = Field(None, description="This container consists of information about the order's buyer. At this time, only the buyer's eBay user ID is returned, but it's possible that more buyer information can be added to this container in the future. 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.")
buyer_checkout_notes
class-attribute
instance-attribute
¶
buyer_checkout_notes = Field(None, alias='buyerCheckoutNotes', description='This field contains any comments that the buyer left for the seller about the order during the checkout process. This field is only returned if a buyer left comments at checkout time.')
cancel_status
class-attribute
instance-attribute
¶
cancel_status = Field(None, alias='cancelStatus', description='This container consists of order cancellation information if a cancel request has been made. This container is always returned, and if no cancel request has been made, the cancelState field is returned with a value of NONE_REQUESTED , and an empty cancelRequests array is also returned.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
ebay_collect_and_remit_tax
class-attribute
instance-attribute
¶
ebay_collect_and_remit_tax = Field(None, alias='ebayCollectAndRemitTax', description="This field is only returned if true and indicates that eBay will collect tax (US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, 'Goods and Services' tax in Canada, Australia, and New Zealand, and VAT collected for UK and EU countries,) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence.")
fulfillment_hrefs
class-attribute
instance-attribute
¶
fulfillment_hrefs = Field(None, alias='fulfillmentHrefs', description='This array contains a list of one or more getShippingFulfillment call URIs that can be used to retrieve shipping fulfillments that have been set up for the order.')
fulfillment_start_instructions
class-attribute
instance-attribute
¶
fulfillment_start_instructions = Field(None, alias='fulfillmentStartInstructions', description="This container consists of a set of specifications for fulfilling the order, including the type of fulfillment, shipping carrier and service, shipping address, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections.")
last_modified_date
class-attribute
instance-attribute
¶
last_modified_date = Field(None, alias='lastModifiedDate', description='The date and time that the order was last modified. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array contains the details for all line items that comprise the order.')
order_fulfillment_status
class-attribute
instance-attribute
¶
order_fulfillment_status = Field(None, alias='orderFulfillmentStatus', description='The degree to which fulfillment of the order is complete. See the OrderFulfillmentStatus type definition for more information about each possible fulfillment state.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the order. This field is always returned.')
order_payment_status
class-attribute
instance-attribute
¶
order_payment_status = Field(None, alias='orderPaymentStatus', description='The enumeration value returned in this field indicates the current payment status of an order, or in case of a refund request, the current status of the refund. See the OrderPaymentStatusEnum type definition for more information about each possible payment/refund state.')
payment_summary
class-attribute
instance-attribute
¶
payment_summary = Field(None, alias='paymentSummary', description='This container consists of detailed payment information for the order, including buyer payment for the order, refund information (if applicable), and seller payment holds (if applicable).')
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='This container consists of a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts.')
program
class-attribute
instance-attribute
¶
program = Field(None, description="This container is returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. The authenticator address is found in the fulfillmentStartInstructions.shippingStep.shipTo container. If the item is successfully authenticated, the authenticator will ship the item to the buyer.")
sales_record_reference
class-attribute
instance-attribute
¶
sales_record_reference = Field(None, alias='salesRecordReference', description='An eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A salesRecordReference number is only generated and returned at the order level, and not at the order line item level.')
seller_id
class-attribute
instance-attribute
¶
seller_id = Field(None, alias='sellerId', description='The unique eBay user ID of the seller who sold the order. 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 .')
total_fee_basis_amount
class-attribute
instance-attribute
¶
total_fee_basis_amount = Field(None, alias='totalFeeBasisAmount', description='This is the cumulative base amount used to calculate the final value fees for each order. The final value fees are deducted from the seller payout associated with the order. Final value fees are calculated as a percentage of order cost (item cost + shipping cost) and the percentage rate can vary by eBay category.')
total_marketplace_fee
class-attribute
instance-attribute
¶
total_marketplace_fee = Field(None, alias='totalMarketplaceFee', description='This is the cumulative fees accrued for the order and deducted from the seller payout.')
OrderSearchPagedCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the getOrders call request that produced the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The maximum number of orders returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 50 . Note: If this is the last or only page of the result set, the page may contain fewer orders than the limit value.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The getOrders call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 41 through 50 from the collection of orders: path /order?limit=10&offset=40 This field is only returned if there is a next page of results to view based on the current input criteria.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
orders
class-attribute
instance-attribute
¶
orders = Field(None, description='This array contains one or more orders that are part of the current result set, that is controlled by the input criteria. The details of each order include information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The getOrders call URI for the previous result set. For example, the following URI returns orders 21 through 30 from the collection of orders: path /order?limit=10&offset=20 This field is only returned if there is a previous page of results to view based on the current input criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of orders in the results set based on the current input criteria. Note: If no orders are found, this field is returned with a value of 0 .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This array is returned if one or more errors or warnings occur with the call request.')