Account v2 API — client.sell.account_v2¶
Version 2.2.0 · base path /sell/account/v2 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_rate_table ¶
get_rate_table(rate_table_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v2_models.RateTableDetails
get_rate_table(rate_table_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_rate_table(rate_table_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v2_models.RateTableDetails | httpx.Response
Retrieves details of a specific shipping rate table.
update_shipping_cost ¶
update_shipping_cost(rate_table_id: str, *, body: RateTableUpdate | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_shipping_cost(rate_table_id: str, *, body: RateTableUpdate | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_shipping_cost(rate_table_id: str, *, body: RateTableUpdate | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates one or more shipping rates for a specific shipping rate table.
get_payout_settings ¶
get_payout_settings(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v2_models.PayoutSettingsResponse
get_payout_settings(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payout_settings(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v2_models.PayoutSettingsResponse | httpx.Response
Retrieves payout percentages and unique IDs for accounts configured to receive seller payouts.
update_payout_percentage ¶
update_payout_percentage(*, body: UpdatePayoutPercentageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_payout_percentage(*, body: UpdatePayoutPercentageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_payout_percentage(*, body: UpdatePayoutPercentageRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates the split-payout percentage for two payout instruments for sellers in mainland China.
create_calculated_shipping_rules ¶
create_calculated_shipping_rules(*, body: CreateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_calculated_shipping_rules(*, body: CreateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_calculated_shipping_rules(*, body: CreateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Creates calculated shipping rules that determine combined shipping costs based on item attributes, such as weight and dimensions, for the seller's account.
create_flat_shipping_rules ¶
create_flat_shipping_rules(*, body: CreateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_flat_shipping_rules(*, body: CreateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_flat_shipping_rules(*, body: CreateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Creates flat-rate rules that apply standard combined shipping costs for a seller's listings.
create_promotional_shipping_rule ¶
create_promotional_shipping_rule(*, body: CreatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_promotional_shipping_rule(*, body: CreatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_promotional_shipping_rule(*, body: CreatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Creates promotional shipping rules, such as discounts or free-shipping thresholds.
get_combined_shipping_rules ¶
get_combined_shipping_rules(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v2_models.GetCombinedShippingRulesPublicApiResponse
get_combined_shipping_rules(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_combined_shipping_rules(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v2_models.GetCombinedShippingRulesPublicApiResponse | httpx.Response
Retrieves all combined shipping rule configurations defined for the seller.
update_calculated_shipping_rules ¶
update_calculated_shipping_rules(*, body: UpdateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_calculated_shipping_rules(*, body: UpdateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_calculated_shipping_rules(*, body: UpdateCalculatedShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates previously defined calculated shipping rules.
update_combined_payments ¶
update_combined_payments(*, body: UpdateCombinedPaymentsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_combined_payments(*, body: UpdateCombinedPaymentsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_combined_payments(*, body: UpdateCombinedPaymentsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates combined payment settings that determine how unpaid orders can be merged.
update_flat_shipping_rules ¶
update_flat_shipping_rules(*, body: UpdateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_flat_shipping_rules(*, body: UpdateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_flat_shipping_rules(*, body: UpdateFlatShippingRulesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates existing flat-rate shipping rules.
update_promotional_shipping_rule ¶
update_promotional_shipping_rule(*, body: UpdatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_promotional_shipping_rule(*, body: UpdatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_promotional_shipping_rule(*, body: UpdatePromotionalShippingRuleRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Updates a promotional shipping rule to adjust discount thresholds, eligibility criteria, or duration for the seller.
get_user_preferences ¶
get_user_preferences(*, fieldgroups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v2_models.GetUserPreferencesResponse
get_user_preferences(*, fieldgroups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_user_preferences(*, fieldgroups: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v2_models.GetUserPreferencesResponse | httpx.Response
Retrieves the seller's preferences for a specific eBay marketplace.
set_user_preferences ¶
set_user_preferences(*, body: SetUserPreferencesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
set_user_preferences(*, body: SetUserPreferencesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
set_user_preferences(*, body: SetUserPreferencesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Modifies one or more preferences for a seller on a specific marketplace.
Models¶
DispatchCutoffTimePreferencesType ¶
Bases: EbayModel
cutoff_time
class-attribute
instance-attribute
¶
cutoff_time = Field(None, alias='cutoffTime', description='This field indicates the dispatch cut-off time in Zulu format ( HH:mm:ss. SSSZ ) - 24-hour format with milliseconds and Z timezone indicator. Note: Despite the Z that is returned in the timestamp, the cut-off time is actually based on the default timezone of the eBay marketplace for the seller.')
ErrorParameter ¶
GetItemsAwaitingPaymentPreferencesType ¶
Bases: EbayModel
auto_relist
class-attribute
instance-attribute
¶
auto_relist = Field(None, alias='autoRelist', description='This boolean indicates if the item should be automatically relisted.')
delay_before_cancelling_commitment
class-attribute
instance-attribute
¶
delay_before_cancelling_commitment = Field(None, alias='delayBeforeCancellingCommitment', description="This integer indicates the delay in days before cancelling the buyer's commitment.")
excluded_users
class-attribute
instance-attribute
¶
excluded_users = Field(None, alias='excludedUsers', description='This string returns the list of sellers excluded from unpaid item assistance.')
opt_in_status
class-attribute
instance-attribute
¶
opt_in_status = Field(None, alias='optInStatus', description='This boolean indicates if the unpaid item assistance is opted in.')
SellerExcludeShipToLocationPreferencesType ¶
Bases: EbayModel
exclude_ship_to_locations
class-attribute
instance-attribute
¶
exclude_ship_to_locations = Field(None, alias='excludeShipToLocations', description="This array shows the list of locations that the seller does not ship to. Excluded locations may include continents and large geographical areas. For example, 'Middle East', individual countries represented by two-letter codes, or special locations within a country such as 'Alaska/Hawaii' or 'PO Box'.")
SellerProfilePreferencesType ¶
Bases: EbayModel
seller_profile_opted_in
class-attribute
instance-attribute
¶
seller_profile_opted_in = Field(None, alias='sellerProfileOptedIn', description='This boolean indicates whether the seller has opted in to seller profiles.')
UpdatePayoutPercentage ¶
Bases: EbayModel
instrument_id
class-attribute
instance-attribute
¶
instrument_id = Field(None, alias='instrumentId', description='The unique reference identifier for a payout instrument. This value is returned in the getPayoutSettings response and is needed to change split-payout percentages through an updatePayoutPercentage request.')
payout_percentage
class-attribute
instance-attribute
¶
payout_percentage = Field(None, alias='payoutPercentage', description='The user-defined payout percentage allocated to this instrument. For example, 50 indicates that 50% of the payout goes to this instrument. The split-payout percentage must be a positive integer value from 0-100. The values of two instruments must always add up to 100%. If the values do not equal 100, the call will fail.')
UpdatePayoutPercentageRequest ¶
Bases: EbayModel
payout_instruments
class-attribute
instance-attribute
¶
payout_instruments = Field(None, alias='payoutInstruments', description='This array allows the seller to set the payout split percentages for two accounts enabled to receive payouts.')
CombinedPaymentOptionEnum ¶
CombinedPaymentPeriodEnum ¶
Bases: OpenStrEnum
CombinedShippingRuleTypeEnum ¶
Bases: OpenStrEnum
combined_item_weight
class-attribute
instance-attribute
¶
combined_item_weight = 'COMBINED_ITEM_WEIGHT'
each_additional_amount
class-attribute
instance-attribute
¶
each_additional_amount = 'EACH_ADDITIONAL_AMOUNT'
each_additional_amount_off
class-attribute
instance-attribute
¶
each_additional_amount_off = 'EACH_ADDITIONAL_AMOUNT_OFF'
each_additional_percent_off
class-attribute
instance-attribute
¶
each_additional_percent_off = 'EACH_ADDITIONAL_PERCENT_OFF'
individual_item_weight
class-attribute
instance-attribute
¶
individual_item_weight = 'INDIVIDUAL_ITEM_WEIGHT'
maximum_shipping_cost_per_order
class-attribute
instance-attribute
¶
maximum_shipping_cost_per_order = 'MAXIMUM_SHIPPING_COST_PER_ORDER'
shipping_cost_x_for_amount_y
class-attribute
instance-attribute
¶
shipping_cost_x_for_amount_y = 'SHIPPING_COST_X_FOR_AMOUNT_Y'
shipping_cost_x_for_item_count_n
class-attribute
instance-attribute
¶
shipping_cost_x_for_item_count_n = 'SHIPPING_COST_X_FOR_ITEM_COUNT_N'
CombinedShippingRuleTypeHandlingEnum ¶
Bases: OpenStrEnum
combined_handling_fee
class-attribute
instance-attribute
¶
combined_handling_fee = 'COMBINED_HANDLING_FEE'
each_additional_amount
class-attribute
instance-attribute
¶
each_additional_amount = 'EACH_ADDITIONAL_AMOUNT'
each_additional_amount_off
class-attribute
instance-attribute
¶
each_additional_amount_off = 'EACH_ADDITIONAL_AMOUNT_OFF'
each_additional_percent_off
class-attribute
instance-attribute
¶
each_additional_percent_off = 'EACH_ADDITIONAL_PERCENT_OFF'
individual_handling_fee
class-attribute
instance-attribute
¶
individual_handling_fee = 'INDIVIDUAL_HANDLING_FEE'
CurrencyCodeEnum ¶
Bases: OpenStrEnum
EndOfAuctionLogoTypeEnum ¶
Bases: OpenStrEnum
FedexRateOptionEnum ¶
InstrumentStatusEnum ¶
Bases: OpenStrEnum
MarketplaceIdEnum ¶
Bases: OpenStrEnum
ShippingCategoryEnum ¶
Bases: OpenStrEnum
ShippingOptionTypeEnum ¶
ShippingRateCalculationEnum ¶
UPSRateOptionEnum ¶
WeightUnitOfMeasureEnum ¶
SetItemsAwaitingPaymentPreferencesType ¶
Bases: EbayModel
auto_relist
class-attribute
instance-attribute
¶
auto_relist = Field(None, alias='autoRelist', description='This boolean field is included if the seller wishes to toggle the setting that controls whether or not the line item should be automatically relisted when cancelled. For this field to be set to true , the optInStatus field should also be true . Note : If the line item was part of an auction listing or a single-quantity fixed price listing, a new listing will actually be created.')
delay_before_cancelling_commitment
class-attribute
instance-attribute
¶
delay_before_cancelling_commitment = Field(None, alias='delayBeforeCancellingCommitment', description='This integer field is included if the seller wishes to set or change the number of business days without payment that must elapse before the line item is cancelled. This is a required field if the optInStatus field is true . Note : The supported integer values (representing business days) varies by eBay marketplace.')
excluded_users
class-attribute
instance-attribute
¶
excluded_users = Field(None, alias='excludedUsers', description='This array is used if the seller wishes to exclude one or more eBay users from the unpaid item assistance mechanism. The seller would need to manually cancel any unpaid line items for all users on this list. This array will not be returned if there are no users on the excluded users list.')
opt_in_status
class-attribute
instance-attribute
¶
opt_in_status = Field(None, alias='optInStatus', description='This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller is opted into the unpaid item assistance mechanism. If the seller is not opted in, no other fields under itemsAwaitingPaymentPreferences are applicable.')
remove_all_excluded_users
class-attribute
instance-attribute
¶
remove_all_excluded_users = Field(None, alias='removeAllExcludedUsers', description='This boolean field is included and set to true if the seller wishes to remove all eBay users from the current excluded users list. If this field is included and set to true , the excludedUsers array should not be included.')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the specified currency .')
CalculatedHandlingRuleType ¶
Bases: EbayModel
combined_shipping_rule_type
class-attribute
instance-attribute
¶
combined_shipping_rule_type = Field(None, alias='combinedShippingRuleType', description='This enumeration value specifies the type of combined-shipping rule applied to handling fees (for example, weight-based, flat-rate, or percentage-based calculation method).')
each_additional_amount
class-attribute
instance-attribute
¶
each_additional_amount = Field(None, alias='eachAdditionalAmount', description='This container specifies the additional monetary charge applied for each extra item included in a combined shipment.')
each_additional_amount_off_shipping_cost
class-attribute
instance-attribute
¶
each_additional_amount_off_shipping_cost = Field(None, alias='eachAdditionalAmountOffShippingCost', description='This container represents the fixed monetary discount deducted from the total shipping cost for each additional item in a combined shipment.')
each_additional_percent_off_shipping_cost
class-attribute
instance-attribute
¶
each_additional_percent_off_shipping_cost = Field(None, alias='eachAdditionalPercentOffShippingCost', description='This integer specifies the percentage discount applied to the total shipping cost for each additional item in a combined shipment.')
order_handling_amount
class-attribute
instance-attribute
¶
order_handling_amount = Field(None, alias='orderHandlingAmount', description='This container represents the handling fee charged for processing a combined order, if applicable.')
CombinedPaymentPreferencesType ¶
Bases: EbayModel
combined_payment_option
class-attribute
instance-attribute
¶
combined_payment_option = Field(None, alias='combinedPaymentOption', description='This enum type defines the available options for handling combined payments when a seller allows multiple line items from the same buyer to be paid for with a single payment. See CombinedPaymentOptionEnum for a description of each value.')
EndOfAuctionEmailPreferencesType ¶
Bases: EbayModel
email_customized
class-attribute
instance-attribute
¶
email_customized = Field(None, alias='emailCustomized', description='This boolean field indicates whether or not the seller is using a customized email to send to winning bidders.')
logo_customized
class-attribute
instance-attribute
¶
logo_customized = Field(None, alias='logoCustomized', description='This boolean field indicates whether or not the seller is using a customized logo in the emails that are sent to winning bidders.')
logo_type
class-attribute
instance-attribute
¶
logo_type = Field(None, alias='logoType', description='This enum indicates the type of logo that is used in the email that is sent to winning bidders. See EndOfAuctionLogoTypeEnum type for descriptions of the different logo types.')
logo_url
class-attribute
instance-attribute
¶
logo_url = Field(None, alias='logoUrl', description='This field shows the URL path to a seller’s custom logo image that is being used in the email sent to winning bidders. This field is only returned if the seller is using a customized logo in emails.')
template_text
class-attribute
instance-attribute
¶
template_text = Field(None, alias='templateText', description='This field shows the body text that is being used if the seller is sending customized emails to winning bidders. The template text has a maximum limit of 1000 characters.')
text_customized
class-attribute
instance-attribute
¶
text_customized = Field(None, alias='textCustomized', description='This boolean field indicates whether or not the seller is using customized text in the emails that are sent to winning bidders.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
MeasureType ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='This field defines the unit of measure (e.g., kilograms, pounds) associated with the value field.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This field defines the numeric value representing the measurement, weight, in the specified unit.')
PayoutInstrument ¶
Bases: EbayModel
account_last_four_digits
class-attribute
instance-attribute
¶
account_last_four_digits = Field(None, alias='accountLastFourDigits', description='The last four digits of the account that the seller uses to receive payouts. This may be the last four digits of a bank account or a payment processor account such as Payoneer.')
instrument_id
class-attribute
instance-attribute
¶
instrument_id = Field(None, alias='instrumentId', description='The unique reference identifier for a payout instrument. The instrumentId is needed to change the split-payout percentages through an updatePayoutPercentage request.')
instrument_status
class-attribute
instance-attribute
¶
instrument_status = Field(None, alias='instrumentStatus', description='The status of a payout instrument. Valid payout instrument statuses include: PENDING: This status indicates that the account must be verified before it can be used. ACTIVE: This status indicates that payouts are enabled on this account. VERIFICATION_FAILED: This status indicates that verification has failed for this account and payouts are disabled.')
instrument_type
class-attribute
instance-attribute
¶
instrument_type = Field(None, alias='instrumentType', description="The type of account that received payouts. The value returned in this field may be: BANK : Indicates that the payout was made to a seller's bank account. CARD ( Not Currently Available ): Indicates that the payout went to a seller's debit card. The name of a digital wallet provider or payment processor (e.g., PAYONEER ) Note: Only Payoneer is currently supported for sellers in mainland China.")
nickname
class-attribute
instance-attribute
¶
nickname = Field(None, description='When instrumentType returns BANK , this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout. When instrumentType returns CARD , this value is the debit card network for the debit card that receives the payout.')
payout_percentage
class-attribute
instance-attribute
¶
payout_percentage = Field(None, alias='payoutPercentage', description='The current payout percentage allocated to an instrument. For example, 50 indicates that 50% of the payout goes to the instrument.')
PayoutSettingsResponse ¶
Bases: EbayModel
payout_instruments
class-attribute
instance-attribute
¶
payout_instruments = Field(None, alias='payoutInstruments', description="This array provides details about the seller's accounts defined for the seller's account. Payment accounts can only receive payouts if the status of the payout instrument is ACTIVE .")
PromotionalShippingRuleType ¶
Bases: EbayModel
combined_shipping_rule_type
class-attribute
instance-attribute
¶
combined_shipping_rule_type = Field(None, alias='combinedShippingRuleType', description='This field specifies the type of combined-shipping rule applied, such as flat-rate or cost-based, as defined in the CombinedShippingRuleTypeEnum .')
item_count
class-attribute
instance-attribute
¶
item_count = Field(None, alias='itemCount', description='This integer indicates the quantity of items that must be purchased by the buyer in order for that buyer to qualify for the promotional discount.')
order_amount
class-attribute
instance-attribute
¶
order_amount = Field(None, alias='orderAmount', description='This container specifies the minimum order amount required to qualify for the associated discount or promotional rule.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='This container represents the total shipping cost or discounted shipping charge for the combined order.')
Rate ¶
Bases: EbayModel
additional_cost
class-attribute
instance-attribute
¶
additional_cost = Field(None, alias='additionalCost', description='An additional shipping cost added to the base shipping rate (i.e., shippingCost ). This amount applies only to the following rateTableBasis options: WEIGHT : This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. SURCHARGE : This is a flat amount that is added to the base shipping rate.')
rate_id
class-attribute
instance-attribute
¶
rate_id = Field(None, alias='rateId', description='The unique identifier for rate information. Note: This is a string that is automatically assigned by the system when a rate object is created.')
shipping_category
class-attribute
instance-attribute
¶
shipping_category = Field(None, alias='shippingCategory', description='Indicates the level of shipping service to which the shipping rate information applies. Available shipping categories are: ONE_DAY : This option is not supported when shippingOptionType is INTERNATIONAL. EXPEDITED STANDARD ECONOMY EXPRESS : This option is supported only when MarketplaceId is EBAY_DE (Germany)')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='Specifies the base shipping rate for an item. This amount applies only to the following rateTableBasis options: ITEM : This is a flat rate shipping cost per item being shipped. WEIGHT : This is a cost per unit weight and is calculated using the weight of the item(s) being shipped.')
shipping_region_names
class-attribute
instance-attribute
¶
shipping_region_names = Field(None, alias='shippingRegionNames', description='An array of Region names to which the shipping rate information applies.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='An enum value that indicates the shipping service used for the specified shipping rate. These enum values align with ShippingService metadata returned by a GeteBayDetails call with DetailName set to shippingServiceDetails .')
RateTableDetails ¶
Bases: EbayModel
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='Identifies the eBay marketplace to which the shipping rate table applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the shipping rate table. Names must be unique for each table assigned to the same seller, shippingOptionType, and eBay marketplace. Max length: 50')
rates
class-attribute
instance-attribute
¶
rates = Field(None, description='An array of rate objects associated with the specified shipping rate table. Each rate object is identified by a unique system-generated ID and defines specific shipping rate information.')
rate_table_basis
class-attribute
instance-attribute
¶
rate_table_basis = Field(None, alias='rateTableBasis', description="The rate calculation type provides three methods of calculating the shipping cost based on the seller's selection/input: ITEM : Specifies the flat rate shipping cost that buyers in the specified shipping region will pay. When this option is selected, information specified in the rate table overrides all shipping options/costs that are specified at the listing level.")
rate_table_id
class-attribute
instance-attribute
¶
rate_table_id = Field(None, alias='rateTableId', description='A unique, system-generated ID assigned to the shipping rate table when it is initially created.')
shipping_option_type
class-attribute
instance-attribute
¶
shipping_option_type = Field(None, alias='shippingOptionType', description='The region serviced by the shipping rate table. Valid values are: DOMESTIC : Indicates that the shipping rate table applies to shipping destinations within the country in which an item has been listed (i.e., the source country). INTERNATIONAL : Indicates that the shipping rate table applies to shipping destinations outside of the country in which an item has been listed.')
RateUpdate ¶
Bases: EbayModel
additional_cost
class-attribute
instance-attribute
¶
additional_cost = Field(None, alias='additionalCost', description='An additional shipping cost added to the base shipping rate (i.e., shippingCost ). This amount applies only to the following rateTableBasis options: WEIGHT : This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. SURCHARGE : This is a flat amount that is added to the base shipping rate.')
rate_id
class-attribute
instance-attribute
¶
rate_id = Field(None, alias='rateId', description='The identifier for the rate object. Note: This is a string automatically assigned by the system when the rate object is created. It cannot be changed or updated.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='This is the base shipping rate for an item. This amount applies only to the following rateTableBasis options: ITEM : This is a flat rate shipping cost per item being shipped. WEIGHT : This is a cost per unit weight and is calculated using the weight of the item(s) being shipped.')
ShippingCarrierRatePreferencesType ¶
Bases: EbayModel
fedex_rate_option
class-attribute
instance-attribute
¶
fedex_rate_option = Field(None, alias='fedexRateOption', description='This enum is included if the seller wishes to add or modify the FedEx shipping carrier rate. Note : This preference is only applicable to the eBay US marketplace.')
ups_rate_option
class-attribute
instance-attribute
¶
ups_rate_option = Field(None, alias='upsRateOption', description='This enum is included if the seller wishes to add or modify the UPS shipping carrier rate. Note : This preference is only applicable to the eBay US marketplace.')
UpdateCombinedPaymentsRequest ¶
Bases: EbayModel
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This field specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in CombinedPaymentPeriodEnum must be used in this field.')
UpdatePromotionalShippingRuleRequest ¶
Bases: EbayModel
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This container specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in CombinedPaymentPeriodEnum must be used in this field.')
promotional_shipping_rule
class-attribute
instance-attribute
¶
promotional_shipping_rule = Field(None, alias='promotionalShippingRule', description='This container specifies the promotional shipping rule that offers discounts or free-shipping options based on defined order thresholds, item counts, or marketplace conditions.')
SetUserPreferencesRequest ¶
Bases: EbayModel
combined_payment_preferences
class-attribute
instance-attribute
¶
combined_payment_preferences = Field(None, alias='combinedPaymentPreferences', description='This container is included if the seller wishes to allow combined invoices if the buyer has multiple unpaid orders from the same seller.')
dispatch_cutoff_time_preference
class-attribute
instance-attribute
¶
dispatch_cutoff_time_preference = Field(None, alias='dispatchCutoffTimePreference', description='This container is included if the seller wishes to set or modify the order cut-off time for same-day shipping.')
email_shipment_tracking_number_preference
class-attribute
instance-attribute
¶
email_shipment_tracking_number_preference = Field(None, alias='emailShipmentTrackingNumberPreference', description='This field is included if the seller wishes to enable or disable the setting that will automatically email the buyer with the tracking number when it becomes available.')
end_of_auction_email_preferences
class-attribute
instance-attribute
¶
end_of_auction_email_preferences = Field(None, alias='endOfAuctionEmailPreferences', description='This container is included if the seller wishes to change one or more of the end of auction email preferences.')
global_shipping_program_listing_preference
class-attribute
instance-attribute
¶
global_shipping_program_listing_preference = Field(None, alias='globalShippingProgramListingPreference', description='This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller’s new listings on the eBay UK marketplace will automatically use the Global Shipping Program for international shipping.')
items_awaiting_payment_preferences
class-attribute
instance-attribute
¶
items_awaiting_payment_preferences = Field(None, alias='itemsAwaitingPaymentPreferences', description='This container is included if the seller wishes to change one or more of the items awaiting payment preferences.')
out_of_stock_control_preference
class-attribute
instance-attribute
¶
out_of_stock_control_preference = Field(None, alias='outOfStockControlPreference', description='This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller is opted into the Out-of-Stock feature. With this feature, a multiple quantity fixed price listing that runs out of stock will be hidden from eBay search but kept alive. Once the sellers add quantity to the listing, the listing will become active and available again.')
purchase_reminder_email_preferences
class-attribute
instance-attribute
¶
purchase_reminder_email_preferences = Field(None, alias='purchaseReminderEmailPreferences', description="This boolean field is included if the seller wishes to toggle the setting that controls whether or not the buyer is expected to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number.")
required_ship_phone_number_preference
class-attribute
instance-attribute
¶
required_ship_phone_number_preference = Field(None, alias='requiredShipPhoneNumberPreference', description='This boolean indicates whether the seller wishes to require phone numbers for shipping or not.')
shipping_carrier_rate_preferences
class-attribute
instance-attribute
¶
shipping_carrier_rate_preferences = Field(None, alias='shippingCarrierRatePreferences', description='This container is included if the seller wishes to add or modify a FedEx, UPS, and/or US Post Office shipping rate type that is available to the seller. Note : This container is only applicable to the eBay US marketplace.')
CombinedShippingRule ¶
Bases: EbayModel
combined_shipping_rule_id
class-attribute
instance-attribute
¶
combined_shipping_rule_id = Field(None, alias='combinedShippingRuleId', description='This field represents the unique identifier for the combined-shipping discount profile, used to reference or update a specific rule configuration.')
combined_shipping_rule_name
class-attribute
instance-attribute
¶
combined_shipping_rule_name = Field(None, alias='combinedShippingRuleName', description='This field specifies the unique name identifying the combined shipping discount profile within the seller’s account. This name is configured by the seller and can have a maximum of XX characters.')
each_additional_amount
class-attribute
instance-attribute
¶
each_additional_amount = Field(None, alias='eachAdditionalAmount', description='This containter defines the additional monetary charge applied for each extra item when multiple items are shipped together.')
each_additional_amount_off_shipping_cost
class-attribute
instance-attribute
¶
each_additional_amount_off_shipping_cost = Field(None, alias='eachAdditionalAmountOffShippingCost', description='This container defines the fixed discount amount deducted from the total shipping cost for each additional item.')
each_additional_percent_off_shipping_cost
class-attribute
instance-attribute
¶
each_additional_percent_off_shipping_cost = Field(None, alias='eachAdditionalPercentOffShippingCost', description='This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order.')
mapped_combined_shipping_rule_id
class-attribute
instance-attribute
¶
mapped_combined_shipping_rule_id = Field(None, alias='mappedCombinedShippingRuleId', description='This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account.')
weight_off_total_weight
class-attribute
instance-attribute
¶
weight_off_total_weight = Field(None, alias='weightOffTotalWeight', description='This container specifies the total weight reduction applied when combining multiple items into one shipment.')
CreatePromotionalShippingRuleRequest ¶
Bases: EbayModel
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This container specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in CombinedPaymentPeriodEnum .')
promotional_shipping_rule
class-attribute
instance-attribute
¶
promotional_shipping_rule = Field(None, alias='promotionalShippingRule', description='This container defines the promotional combined-shipping rule that offers discounts or free shipping based on order value, item count, or other qualifying conditions.')
FlatShippingRuleType ¶
Bases: EbayModel
combined_shipping_rules
class-attribute
instance-attribute
¶
combined_shipping_rules = Field(None, alias='combinedShippingRules', description='This array specifies the type of combined-shipping rule applied, such as flat-rate or cost-based.')
combined_shipping_rule_type
class-attribute
instance-attribute
¶
combined_shipping_rule_type = Field(None, alias='combinedShippingRuleType', description='This container defines the type of discount rule applied (e.g., percentage-based, fixed-rate).')
GetUserPreferencesResponse ¶
Bases: EbayModel
combined_payment_preferences
class-attribute
instance-attribute
¶
combined_payment_preferences = Field(None, alias='combinedPaymentPreferences', description='This container returns the combined payment preferences when the COMBINED_PAYMENT value is included through the fieldgroups query parameter or when fieldgroups = ALL . It indicates if the seller allows multiple line items from the same buyer to be combined.')
dispatch_cutoff_time_preference
class-attribute
instance-attribute
¶
dispatch_cutoff_time_preference = Field(None, alias='dispatchCutoffTimePreference', description='This container is returned when the DISPATCH_CUTOFF_TIME value is included through the fieldgroups query parameter or when fieldgroups = ALL .')
email_shipment_tracking_number_preference
class-attribute
instance-attribute
¶
email_shipment_tracking_number_preference = Field(None, alias='emailShipmentTrackingNumberPreference', description='This boolean field indicates whether or not the seller’s account is configured to automatically send an email to buyers with the shipment tracking number for an order.')
end_of_auction_email_preferences
class-attribute
instance-attribute
¶
end_of_auction_email_preferences = Field(None, alias='endOfAuctionEmailPreferences', description='This container allows sellers to customize the email sent to buyers immediately after an auction listing is won.')
global_shipping_program_listing_preference
class-attribute
instance-attribute
¶
global_shipping_program_listing_preference = Field(None, alias='globalShippingProgramListingPreference', description='This boolean field indicates whether or not the seller’s new listings on the eBay marketplace will automatically use the Global Shipping Program for international shipping. This field is returned when the GLOBAL_SHIPPING_PROGRAM value is included through the fieldgroups query parameter or when fieldgroups = ALL .')
items_awaiting_payment_preferences
class-attribute
instance-attribute
¶
items_awaiting_payment_preferences = Field(None, alias='itemsAwaitingPaymentPreferences', description='This container shows the seller’s preferences for automatically handling unpaid line items.')
offer_global_shipping_program_preference
class-attribute
instance-attribute
¶
offer_global_shipping_program_preference = Field(None, alias='offerGlobalShippingProgramPreference', description='This boolean field indicates whether or not the seller is opted into the Global Shipping Program on the eBay marketplace. Note : The Global Shipping Program is only available for the eBay UK marketplace.')
out_of_stock_control_preference
class-attribute
instance-attribute
¶
out_of_stock_control_preference = Field(None, alias='outOfStockControlPreference', description='This boolean field indicates whether or not the seller is opted into the Out-of-Stock feature. With this feature, a multiple quantity fixed price listing that runs out of stock will be hidden from eBay search but kept alive. Once the sellers add quantity to the listing, the listing will become active and available again.')
override_gsp_service_with_intl_service_preference
class-attribute
instance-attribute
¶
override_gsp_service_with_intl_service_preference = Field(None, alias='overrideGspServiceWithIntlServicePreference', description="This boolean field indicates whether or not the seller specifies an international shipping service to a particular country for a given listing, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. Note : The Global Shipping Program is only available for the eBay UK marketplace.")
pickup_dropoff_seller_preference
class-attribute
instance-attribute
¶
pickup_dropoff_seller_preference = Field(None, alias='pickupDropoffSellerPreference', description='This boolean field indicates whether or not the seller is opted into the Click & Collect feature. Note : The Click & Collect feature is only available on the eBay UK, Australia, and Germany marketplaces.')
purchase_reminder_email_preferences
class-attribute
instance-attribute
¶
purchase_reminder_email_preferences = Field(None, alias='purchaseReminderEmailPreferences', description='This boolean field indicates whether or not the seller’s account is configured to have eBay send occasional purchase reminder emails for unpaid line items.')
required_ship_phone_number_preference
class-attribute
instance-attribute
¶
required_ship_phone_number_preference = Field(None, alias='requiredShipPhoneNumberPreference', description='This boolean field indicates whether or not the buyer is required to provide a shipping phone number during checkout.')
seller_exclude_ship_to_location_preferences
class-attribute
instance-attribute
¶
seller_exclude_ship_to_location_preferences = Field(None, alias='sellerExcludeShipToLocationPreferences', description='This container shows the list of locations that the seller does not ship to. This list of shipping locations can only be updated in My eBay through Shipping Preferences and not with the setUserPreferences method.')
seller_profile_preferences
class-attribute
instance-attribute
¶
seller_profile_preferences = Field(None, alias='sellerProfilePreferences', description='This container is returned when the SELLER_PROFILE value is included through the fieldgroups query parameter or when fieldgroups = ALL .')
shipping_carrier_rate_preferences
class-attribute
instance-attribute
¶
shipping_carrier_rate_preferences = Field(None, alias='shippingCarrierRatePreferences', description='This container indicates the FedEx, UPS, and US Post Office shipping rate types that are available to the seller. This container is returned when the SHIPPING_CARRIER_RATE value is included through the fieldgroups query parameter or when fieldgroups = ALL . Note : This container is only applicable to the eBay US marketplace.')
RateTableUpdate ¶
Bases: EbayModel
rates
class-attribute
instance-attribute
¶
rates = Field(None, description='An array of rate objects for which shippingCost and/or additionalCost are to be updated.')
UpdateFlatShippingRulesRequest ¶
Bases: EbayModel
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This field specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in CombinedPaymentPeriodEnum must be used in this field.')
flat_shipping_rule
class-attribute
instance-attribute
¶
flat_shipping_rule = Field(None, alias='flatShippingRule', description='This container defines the flat-rate combined-shipping rule, which applies a fixed shipping cost for multiple items shipped together.')
CalculatedShippingRuleType ¶
Bases: EbayModel
combined_shipping_rules
class-attribute
instance-attribute
¶
combined_shipping_rules = Field(None, alias='combinedShippingRules', description="This array lists the discount rules applied to combined shipments, detailing calculation methods and rule identifiers. When used by a create call, there won't be any rule ID.")
combined_shipping_rule_type
class-attribute
instance-attribute
¶
combined_shipping_rule_type = Field(None, alias='combinedShippingRuleType', description='This container defines the type of combined-shipping rule applied to calculate discounts, such as weight-based, percentage-based, or flat-rate models.')
CreateCalculatedShippingRulesRequest ¶
Bases: EbayModel
calculated_handling_rule
class-attribute
instance-attribute
¶
calculated_handling_rule = Field(None, alias='calculatedHandlingRule', description='This container defines the calculated handling fee rules applied to combined orders, specifying how handling costs are determined or discounted based on combined-shipping parameters.')
calculated_shipping_rule
class-attribute
instance-attribute
¶
calculated_shipping_rule = Field(None, alias='calculatedShippingRule', description='This container defines the calculated shipping rule applied to combined orders, detailing how shipping discounts or costs are computed based on item count, total weight, or order value.')
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This enumerated value specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in CombinedPaymentPeriodEnum .')
CreateFlatShippingRulesRequest ¶
Bases: EbayModel
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This enumerated value specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in CombinedPaymentPeriodEnum .')
flat_shipping_rule
class-attribute
instance-attribute
¶
flat_shipping_rule = Field(None, alias='flatShippingRule', description='This container defines the flat-rate combined-shipping rule, which applies a fixed shipping cost for multiple items shipped together.')
GetCombinedShippingRulesPublicApiResponse ¶
Bases: EbayModel
calculated_handling_rule
class-attribute
instance-attribute
¶
calculated_handling_rule = Field(None, alias='calculatedHandlingRule', description='This container will show one or more calculated shipping rules set up for that seller on that ebay marketplace. Note: This will not be returned if a calculated handling rule is not set up for that seller on that eBay marketplace')
calculated_shipping_rule
class-attribute
instance-attribute
¶
calculated_shipping_rule = Field(None, alias='calculatedShippingRule', description='This container specifies the type of combined-shipping rule applied, such as flat-rate, weight-based, or cost-based.')
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This field is represented by one of the values in the CombinedPaymentPeriodEnum .')
flat_shipping_rule
class-attribute
instance-attribute
¶
flat_shipping_rule = Field(None, alias='flatShippingRule', description='This container will show one or more flat shipping rules set up for that seller on that ebay marketplace.')
promotional_shipping_rule
class-attribute
instance-attribute
¶
promotional_shipping_rule = Field(None, alias='promotionalShippingRule', description="This container shows the promotional shipping rule that is currently set up on the seller's account for the eBay marketplace. This container will not be returned if no promotional shipping rule is currently set up on the seller's account for the eBay marketplace.")
UpdateCalculatedShippingRulesRequest ¶
Bases: EbayModel
calculated_handling_rule
class-attribute
instance-attribute
¶
calculated_handling_rule = Field(None, alias='calculatedHandlingRule', description='This container specifies the calculated handling rule that determines how handling fees are automatically computed based on order weight, quantity, or value in a combined shipment.')
calculated_shipping_rule
class-attribute
instance-attribute
¶
calculated_shipping_rule = Field(None, alias='calculatedShippingRule', description='This container defines the calculated shipping rule that determines shipping costs or discounts based on factors such as total weight, price, or item count in a combined order.')
combined_duration
class-attribute
instance-attribute
¶
combined_duration = Field(None, alias='combinedDuration', description='This enumerated value specifies the duration within which multiple unpaid orders may be combined into a single invoice, represented by one of the values in CombinedPaymentPeriodEnum .')