Account v1 API — client.sell.account_v1¶
Version v1.9.3 · base path /sell/account/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_custom_policies ¶
get_custom_policies(*, policy_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.CustomPolicyResponse
get_custom_policies(*, policy_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_custom_policies(*, policy_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.CustomPolicyResponse | httpx.Response
This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policy_types query parameter.
create_custom_policy ¶
create_custom_policy(*, body: CustomPolicyCreateRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_custom_policy(*, body: CustomPolicyCreateRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_custom_policy(*, body: CustomPolicyCreateRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a policyType . Multiple policies may be created as using the following custom policy types: PRODUCT_COMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance.
get_custom_policy ¶
get_custom_policy(custom_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.CustomPolicy
get_custom_policy(custom_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_custom_policy(custom_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.CustomPolicy | httpx.Response
This method retrieves the custom policy specified by the custom_policy_id path parameter.
update_custom_policy ¶
update_custom_policy(custom_policy_id: str, *, body: CustomPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
update_custom_policy(custom_policy_id: str, *, body: CustomPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_custom_policy(custom_policy_id: str, *, body: CustomPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This method updates an existing custom policy specified by the custom_policy_id path parameter. Since this method overwrites the policy's name , label , and description fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being updated.
create_fulfillment_policy ¶
create_fulfillment_policy(*, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetFulfillmentPolicyResponse
create_fulfillment_policy(*, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_fulfillment_policy(*, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetFulfillmentPolicyResponse | httpx.Response
This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers.
get_fulfillment_policy ¶
get_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.FulfillmentPolicy
get_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.FulfillmentPolicy | httpx.Response
This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
update_fulfillment_policy ¶
update_fulfillment_policy(fulfillment_policy_id: str, *, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetFulfillmentPolicyResponse
update_fulfillment_policy(fulfillment_policy_id: str, *, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_fulfillment_policy(fulfillment_policy_id: str, *, body: FulfillmentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetFulfillmentPolicyResponse | httpx.Response
This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
delete_fulfillment_policy ¶
delete_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
delete_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_fulfillment_policy(fulfillment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.
get_fulfillment_policies ¶
get_fulfillment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.FulfillmentPolicyResponse
get_fulfillment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_fulfillment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.FulfillmentPolicyResponse | httpx.Response
This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.
get_fulfillment_policy_by_name ¶
get_fulfillment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.FulfillmentPolicy
get_fulfillment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_fulfillment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.FulfillmentPolicy | httpx.Response
This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters.
get_payment_policies ¶
get_payment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.PaymentPolicyResponse
get_payment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payment_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.PaymentPolicyResponse | httpx.Response
This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace_id query parameter.
create_payment_policy ¶
create_payment_policy(*, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetPaymentPolicyResponse
create_payment_policy(*, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_payment_policy(*, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetPaymentPolicyResponse | httpx.Response
This method creates a new payment policy where the policy encapsulates seller's terms for order payments. A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies .
get_payment_policy ¶
get_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.PaymentPolicy
get_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.PaymentPolicy | httpx.Response
This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.
update_payment_policy ¶
update_payment_policy(payment_policy_id: str, *, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetPaymentPolicyResponse
update_payment_policy(payment_policy_id: str, *, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_payment_policy(payment_policy_id: str, *, body: PaymentPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetPaymentPolicyResponse | httpx.Response
This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
delete_payment_policy ¶
delete_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
delete_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_payment_policy(payment_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter.
get_payment_policy_by_name ¶
get_payment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.PaymentPolicy
get_payment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payment_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.PaymentPolicy | httpx.Response
This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters.
get_payments_program ¶
get_payments_program(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.PaymentsProgramResponse
get_payments_program(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payments_program(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.PaymentsProgramResponse | httpx.Response
Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.
get_payments_program_onboarding ¶
get_payments_program_onboarding(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.PaymentsProgramOnboardingResponse
get_payments_program_onboarding(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payments_program_onboarding(marketplace_id: str, payments_program_type: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.PaymentsProgramOnboardingResponse | httpx.Response
Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.
get_privileges ¶
get_privileges(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SellingPrivileges
get_privileges(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_privileges(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SellingPrivileges | httpx.Response
This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimit (the amount and quantity they can sell on a given day).
get_opted_in_programs ¶
get_opted_in_programs(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Programs
get_opted_in_programs(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_opted_in_programs(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Programs | httpx.Response
This method gets a list of the seller programs that the seller has opted-in to.
opt_in_to_program ¶
opt_in_to_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
opt_in_to_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
opt_in_to_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method opts the seller in to an eBay seller program. Refer to the ProgramTypeEnum for information about available eBay seller programs. Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.
opt_out_of_program ¶
opt_out_of_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
opt_out_of_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
opt_out_of_program(*, body: Program, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the getOptedInPrograms method.
get_rate_tables ¶
get_rate_tables(*, country_code: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.RateTableResponse
get_rate_tables(*, country_code: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_rate_tables(*, country_code: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.RateTableResponse | httpx.Response
This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables. The method's response includes a rateTableId for each table defined by the seller.
get_return_policies ¶
get_return_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.ReturnPolicyResponse
get_return_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_return_policies(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.ReturnPolicyResponse | httpx.Response
This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.
create_return_policy ¶
create_return_policy(*, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetReturnPolicyResponse
create_return_policy(*, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_return_policy(*, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetReturnPolicyResponse | httpx.Response
This method creates a new return policy where the policy encapsulates seller's terms for returning items. Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.
get_return_policy ¶
get_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.ReturnPolicy
get_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.ReturnPolicy | httpx.Response
This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
update_return_policy ¶
update_return_policy(return_policy_id: str, *, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SetReturnPolicyResponse
update_return_policy(return_policy_id: str, *, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_return_policy(return_policy_id: str, *, body: ReturnPolicyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SetReturnPolicyResponse | httpx.Response
This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
delete_return_policy ¶
delete_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
delete_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_return_policy(return_policy_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.
get_return_policy_by_name ¶
get_return_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.ReturnPolicy
get_return_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_return_policy_by_name(*, marketplace_id: str, name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.ReturnPolicy | httpx.Response
This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters.
bulk_create_or_replace_sales_tax ¶
bulk_create_or_replace_sales_tax(*, body: BulkSalesTaxInput, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.UpdatedSalesTaxResponse
bulk_create_or_replace_sales_tax(*, body: BulkSalesTaxInput, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_or_replace_sales_tax(*, body: BulkSalesTaxInput, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.UpdatedSalesTaxResponse | httpx.Response
This method creates or updates multiple sales-tax table entries. Sales-tax tables can be set up for countries that support different tax jurisdictions . Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
get_sales_tax ¶
get_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SalesTax
get_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SalesTax | httpx.Response
This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters. All four response fields will be returned if a sales-tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.
create_or_replace_sales_tax ¶
create_or_replace_sales_tax(country_code: str, jurisdiction_id: str, *, body: SalesTaxBase, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
create_or_replace_sales_tax(country_code: str, jurisdiction_id: str, *, body: SalesTaxBase, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_or_replace_sales_tax(country_code: str, jurisdiction_id: str, *, body: SalesTaxBase, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId .
delete_sales_tax ¶
delete_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.Error
delete_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_sales_tax(country_code: str, jurisdiction_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.Error | httpx.Response
This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters. Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
get_sales_taxes ¶
get_sales_taxes(*, country_code: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SalesTaxes
get_sales_taxes(*, country_code: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_sales_taxes(*, country_code: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SalesTaxes | httpx.Response
Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria. If no sales tax rates are defined for the specified, a 204 No Content status code is returned with no response payload.
get_subscription ¶
get_subscription(*, limit: int | str | None = None, continuation_token: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SubscriptionResponse
get_subscription(*, limit: int | str | None = None, continuation_token: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_subscription(*, limit: int | str | None = None, continuation_token: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SubscriptionResponse | httpx.Response
This method retrieves a list of subscriptions associated with the seller account.
get_kyc ¶
get_kyc(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.KycResponse
get_kyc(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_kyc(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.KycResponse | httpx.Response
Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a 204 No Content HTTP status code.
get_advertising_eligibility ¶
get_advertising_eligibility(*, program_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_account_v1_models.SellerEligibilityMultiProgramResponse
get_advertising_eligibility(*, program_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_advertising_eligibility(*, program_types: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_account_v1_models.SellerEligibilityMultiProgramResponse | httpx.Response
This method allows developers to check the seller eligibility status for eBay advertising programs.
Models¶
AdvertisingProgramEnum ¶
CategoryTypeEnum ¶
CountryCodeEnum ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
CustomPolicyRequest ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='Contains the seller specified policy and policy terms. Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy. Max length: 15,000')
label
class-attribute
instance-attribute
¶
label = Field(None, description='Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to seller specified policy information. Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy. Max length: 65')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type. Note: This field is visible only to the seller. Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy. Max length: 65')
CustomPolicyTypeEnum ¶
DetailsType ¶
ErrorParameter ¶
ErrorParameterV3 ¶
KycCheck ¶
Bases: EbayModel
data_required
class-attribute
instance-attribute
¶
data_required = Field(None, alias='dataRequired', description='The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the detailMessage and other applicable, corresponding fields.')
due_date
class-attribute
instance-attribute
¶
due_date = Field(None, alias='dueDate', description='The timestamp in this field indicates the date by which the seller should resolve the KYC requirement. The timestamp in this field uses the UTC date and time format described in the ISO 8601 Standard . See below for this format and an example: MM-DD-YYYY HH:MM:SS 06-05-2020 10:34:18')
remedy_url
class-attribute
instance-attribute
¶
remedy_url = Field(None, alias='remedyUrl', description='If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information.')
alert
class-attribute
instance-attribute
¶
alert = Field(None, description="This field gives a short summary of what is required from the seller. An example might be, ' Upload bank document now. '. The detailMessage field will often provide more details on what is required of the seller.")
detail_message
class-attribute
instance-attribute
¶
detail_message = Field(None, alias='detailMessage', description="This field gives a detailed message about what is required from the seller. An example might be, ' Please upload a bank document by 2020-08-01 to get your account back in good standing. '.")
KycResponse ¶
Bases: EbayModel
kyc_checks
class-attribute
instance-attribute
¶
kyc_checks = Field(None, alias='kycChecks', description='This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts. If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a 204 No Content HTTP status code.')
MarketplaceIdEnum ¶
Bases: OpenStrEnum
PaymentInstrumentBrandEnum ¶
Bases: OpenStrEnum
PaymentMethodTypeEnum ¶
PaymentsProgramOnboardingStatus ¶
Bases: OpenStrEnum
eligible_to_onboard
class-attribute
instance-attribute
¶
eligible_to_onboard = 'ELIGIBLE_TO_ONBOARD'
PaymentsProgramOnboardingStepStatus ¶
PaymentsProgramOnboardingSteps ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='This enumeration value indicates the status of the associated step. Note: Only one step can be IN_PROGRESS at a time.')
web_url
class-attribute
instance-attribute
¶
web_url = Field(None, alias='webUrl', description='This URL provides access to the IN_PROGRESS step.')
PaymentsProgramStatus ¶
PaymentsProgramType ¶
Bases: OpenStrEnum
ProgramTypeEnum ¶
Bases: OpenStrEnum
out_of_stock_control
class-attribute
instance-attribute
¶
out_of_stock_control = 'OUT_OF_STOCK_CONTROL'
partner_motors_dealer
class-attribute
instance-attribute
¶
partner_motors_dealer = 'PARTNER_MOTORS_DEALER'
selling_policy_management
class-attribute
instance-attribute
¶
selling_policy_management = 'SELLING_POLICY_MANAGEMENT'
RecipientAccountReferenceTypeEnum ¶
Bases: OpenStrEnum
RefundMethodEnum ¶
RegionTypeEnum ¶
Bases: OpenStrEnum
ReturnMethodEnum ¶
ReturnShippingCostPayerEnum ¶
SalesTax ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The country code enumeration value identifies the country to which this sales tax rate applies. Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are: US CA')
sales_tax_jurisdiction_id
class-attribute
instance-attribute
¶
sales_tax_jurisdiction_id = Field(None, alias='salesTaxJurisdictionId', description='A unique ID that identifies the sales tax jurisdiction to which the sales tax rate applies. Note: When the returned countryCode is US , the only supported return values for salesTaxJurisdictionId are: AS (American Samoa) GU (Guam MP Northern Mariana Islands PW (Palau) VI (US Virgin Islands)')
sales_tax_percentage
class-attribute
instance-attribute
¶
sales_tax_percentage = Field(None, alias='salesTaxPercentage', description='The sales tax rate that will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges Although it is a string, a percentage value is returned here, such as 7.75')
shipping_and_handling_taxed
class-attribute
instance-attribute
¶
shipping_and_handling_taxed = Field(None, alias='shippingAndHandlingTaxed', description='If returned as true , sales tax is also applied to shipping and handling charges, and not just the total sales price of the order.')
SalesTaxBase ¶
Bases: EbayModel
sales_tax_percentage
class-attribute
instance-attribute
¶
sales_tax_percentage = Field(None, alias='salesTaxPercentage', description='This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges Although it is a string, a percentage value is set here, such as 7.75 .')
shipping_and_handling_taxed
class-attribute
instance-attribute
¶
shipping_and_handling_taxed = Field(None, alias='shippingAndHandlingTaxed', description="This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false .")
SalesTaxInput ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='This parameter specifies the two-letter ISO 3166 code of the country for which a sales-tax table entry is to be created or updated. Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are: US CA')
sales_tax_jurisdiction_id
class-attribute
instance-attribute
¶
sales_tax_jurisdiction_id = Field(None, alias='salesTaxJurisdictionId', description='This parameter specifies the ID of the tax jurisdiction for which a sales-tax table entry is to be created or updated. Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.')
sales_tax_percentage
class-attribute
instance-attribute
¶
sales_tax_percentage = Field(None, alias='salesTaxPercentage', description='This parameter specifies the sales tax rate for the specified salesTaxJurisdictionId . When applicable to an order, this sales tax rate will be applied to the sales price. The shippingAndHandlingTaxed value indicates whether or not sales tax is also applied to shipping and handling charges Although it is a string, a percentage value is set here, such as 7.75 .')
shipping_and_handling_taxed
class-attribute
instance-attribute
¶
shipping_and_handling_taxed = Field(None, alias='shippingAndHandlingTaxed', description="This parameter is set to true if the seller wishes to apply sales tax to shipping and handling charges and not just the total sales price of an order. Otherwise, this parameter's value should be set to false .")
SalesTaxes ¶
Bases: EbayModel
sales_taxes
class-attribute
instance-attribute
¶
sales_taxes = Field(None, alias='salesTaxes', description='An array of one or more sales-tax rate entries for a specified country. If no sales-tax rate entries are set up, no response payload is returned, but an HTTP status code of 204 No Content is returned.')
SellerEligibilityEnum ¶
SellerIneligibleReasonEnum ¶
ShippingCostTypeEnum ¶
ShippingOptionTypeEnum ¶
SubscriptionTypeEnum ¶
Bases: OpenStrEnum
TimeDurationUnitEnum ¶
Bases: OpenStrEnum
UpdatedSalesTaxEntry ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='The two-letter ISO 3166 code of the country associated with the sales-tax table entry.')
jurisdiction_id
class-attribute
instance-attribute
¶
jurisdiction_id = Field(None, alias='jurisdictionId', description='The ID of the tax jurisdiction associated with the sales-tax table entry.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The HTTP status code for the call. Note: The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP statusCode will be listed for all sales-tax table entries returned in the payload.')
UpdatedSalesTaxResponse ¶
Bases: EbayModel
updated_sales_tax_entries
class-attribute
instance-attribute
¶
updated_sales_tax_entries = Field(None, alias='updatedSalesTaxEntries', description='The array of new and updated sales-tax table entries.')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD . Default: The default currency of the eBay marketplace that hosts the listing.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the specified currency .')
BulkSalesTaxInput ¶
Bases: EbayModel
sales_tax_input_list
class-attribute
instance-attribute
¶
sales_tax_input_list = Field(None, alias='salesTaxInputList', description='The array of sales-tax table entries to be created or updated.')
CategoryType ¶
Bases: EbayModel
default
class-attribute
instance-attribute
¶
default = Field(None, description='Note: This field has been deprecated and is no longer used. Do not include this field in any create or update method. This field may be returned within the payload of a get method, but it can be ignored.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The category type to which the policy applies (motor vehicles or non-motor vehicles). Note: The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles.')
CompactCustomPolicyResponse ¶
Bases: EbayModel
custom_policy_id
class-attribute
instance-attribute
¶
custom_policy_id = Field(None, alias='customPolicyId', description='The unique custom policy identifier for the policy being returned. Note: This value is automatically assigned by the system when the policy is created.')
label
class-attribute
instance-attribute
¶
label = Field(None, description="Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information. Max length: 65")
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type. Note: This field is visible only to the seller. Max length: 65')
policy_type
class-attribute
instance-attribute
¶
policy_type = Field(None, alias='policyType', description='Specifies the type of Custom Policy being returned.')
CustomPolicy ¶
Bases: EbayModel
custom_policy_id
class-attribute
instance-attribute
¶
custom_policy_id = Field(None, alias='customPolicyId', description='The unique custom policy identifier for a policy.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="Contains the seller's policy and policy terms. Buyers access this information from the View Item page for items to which the policy has been applied. Max length: 15,000")
label
class-attribute
instance-attribute
¶
label = Field(None, description="Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information. Max length: 65")
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type. Note: This field is visible only to the seller. Max length: 65')
policy_type
class-attribute
instance-attribute
¶
policy_type = Field(None, alias='policyType', description='Specifies the type of Custom Policy being returned.')
CustomPolicyCreateRequest ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description="Contains the seller's policy and policy terms. Max length: 15,000")
label
class-attribute
instance-attribute
¶
label = Field(None, description="Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information. Max length: 65")
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type. Note: This field is visible only to the seller. Max length: 65')
policy_type
class-attribute
instance-attribute
¶
policy_type = Field(None, alias='policyType', description='Specifies the type of custom policy being created. Two Custom Policy types are supported: Product Compliance (PRODUCT_COMPLIANCE) Takeback (TAKE_BACK)')
CustomPolicyResponse ¶
Bases: EbayModel
custom_policies
class-attribute
instance-attribute
¶
custom_policies = Field(None, alias='customPolicies', description='This array contains the custom policies that match the input criteria.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is for future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This field is for future use.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is for future use.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This field is for future use.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This field is for future use.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This field is for future use.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description="The category type for this error or warning. It is a string that can have one of three values: Application : Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.")
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name of the domain ,or primary system, of the service or application where the error occurred.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.")
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error than given in the message error field.')
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. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value .')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='If present, indicates the subsystem in which the error occurred.')
PaymentsProgramOnboardingResponse ¶
Bases: EbayModel
onboarding_status
class-attribute
instance-attribute
¶
onboarding_status = Field(None, alias='onboardingStatus', description='This enumeration value indicates the eligibility of payment onboarding for the registered site.')
steps
class-attribute
instance-attribute
¶
steps = Field(None, description='An array of the active process steps for payment onboarding and the status of each step. This array includes the step name , step status , and a webUrl to the IN_PROGRESS step. The step names are returned in sequential order.')
PaymentsProgramResponse ¶
Bases: EbayModel
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which the payment program applies.')
payments_program_type
class-attribute
instance-attribute
¶
payments_program_type = Field(None, alias='paymentsProgramType', description='This parameter specifies the payment program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS .')
status
class-attribute
instance-attribute
¶
status = Field(None, description="The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program.")
was_previously_opted_in
class-attribute
instance-attribute
¶
was_previously_opted_in = Field(None, alias='wasPreviouslyOptedIn', description="If returned as true , the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of false indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it. It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program.")
Program ¶
Bases: EbayModel
program_type
class-attribute
instance-attribute
¶
program_type = Field(None, alias='programType', description='The seller program to opt in to when part of an optInToProgram request, or out of when part of an optOutOfProgram request. When returned in an getOptedInPrograms response, a separate programType field is returned for each seller program that the seller is opted in to.')
Programs ¶
Bases: EbayModel
programs
class-attribute
instance-attribute
¶
programs = Field(None, description="An array of seller programs that the seller's account is opted in to. An empty array is returned if the seller is not opted in to any of the seller programs.")
RateTable ¶
Bases: EbayModel
country_code
class-attribute
instance-attribute
¶
country_code = Field(None, alias='countryCode', description='A two-letter ISO 3166 country code representing the eBay marketplace where the shipping rate table is defined.')
locality
class-attribute
instance-attribute
¶
locality = Field(None, description='This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name for the shipping rate table.')
rate_table_id
class-attribute
instance-attribute
¶
rate_table_id = Field(None, alias='rateTableId', description="A unique eBay-assigned ID for a seller's shipping rate table. These rateTableId values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API.")
RateTableResponse ¶
Bases: EbayModel
rate_tables
class-attribute
instance-attribute
¶
rate_tables = Field(None, alias='rateTables', description='An array of all shipping rate tables defined for a marketplace (or all marketplaces if no country_code query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.')
RecipientAccountReference ¶
Bases: EbayModel
reference_id
class-attribute
instance-attribute
¶
reference_id = Field(None, alias='referenceId', description='Note : DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.')
reference_type
class-attribute
instance-attribute
¶
reference_type = Field(None, alias='referenceType', description='Note : DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.')
Region ¶
Bases: EbayModel
region_name
class-attribute
instance-attribute
¶
region_name = Field(None, alias='regionName', description='A string that indicates the name of a region, as defined by eBay. A "region" can be either a \'world region\' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.')
region_type
class-attribute
instance-attribute
¶
region_type = Field(None, alias='regionType', description='Reserved for future use.')
RegionSet ¶
Bases: EbayModel
region_excluded
class-attribute
instance-attribute
¶
region_excluded = Field(None, alias='regionExcluded', description='An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations container and not within the shippingServices.shipToLocations container used to specify which shipping regions are serviced by each available shipping service option.')
region_included
class-attribute
instance-attribute
¶
region_included = Field(None, alias='regionIncluded', description='An array of one or more regionName fields that specify the areas to where a seller ships. Each eBay marketplace supports its own set of allowable shipping locations. Note: The regionIncluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.')
SellerEligibilityResponse ¶
Bases: EbayModel
program_type
class-attribute
instance-attribute
¶
program_type = Field(None, alias='programType', description='The eBay advertising program for which a seller may be eligible.')
reason
class-attribute
instance-attribute
¶
reason = Field(None, description='The reason why a seller is ineligible for the specified eBay advertising program. This field is only returned if the seller is ineligible for the eBay advertising program.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The seller eligibility status for the specified eBay advertising program.')
SellingLimit ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description="This container shows the monthly cap for total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total sales amount.")
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description="This field shows the monthly cap for total quantity sold allowed for the seller's account. This field may not be returned if a seller does not have a monthly cap for total quantity sold.")
SellingPrivileges ¶
Bases: EbayModel
seller_registration_completed
class-attribute
instance-attribute
¶
seller_registration_completed = Field(None, alias='sellerRegistrationCompleted', description="If this field is returned as true , the seller's registration is completed. If this field is returned as false , the registration process is not complete.")
selling_limit
class-attribute
instance-attribute
¶
selling_limit = Field(None, alias='sellingLimit', description="This container lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold and total sales amount. Note: The selling limit value returned in getPrivileges may vary slightly from the value displayed in Seller Hub.")
ShippingService ¶
Bases: EbayModel
additional_shipping_cost
class-attribute
instance-attribute
¶
additional_shipping_cost = Field(None, alias='additionalShippingCost', description='This container is used by the seller to cover the use case when a single buyer purchases multiple quantities of the same line item. This cost cannot exceed the corresponding shippingCost value. A seller will generally set this field when he/she wants to pass on a shipping discount to the buyer if that buyer purchases multiple quantities of a line item.')
buyer_responsible_for_pickup
class-attribute
instance-attribute
¶
buyer_responsible_for_pickup = Field(None, alias='buyerResponsibleForPickup', description="This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made. This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. This field is returned if set.")
buyer_responsible_for_shipping
class-attribute
instance-attribute
¶
buyer_responsible_for_shipping = Field(None, alias='buyerResponsibleForShipping', description="This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a motor vehicle. This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. This field is returned if set. Default : false")
free_shipping
class-attribute
instance-attribute
¶
free_shipping = Field(None, alias='freeShipping', description='This field is included and set to true if the seller offers a free domestic shipping option to the buyer. This field can only be included and set to true for the first domestic shipping service option specified in the shippingServices array (it is ignored if set for subsequent shipping services or for any international shipping service option).')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description="This field sets/indicates the shipping carrier, such as USPS , FedEx , or UPS . Although this field uses the string type, the seller must pass in a pre-defined enumeration value here. For a full list of shipping carrier enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingCarrierDetails .")
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='This container is used to set the shipping cost to ship one item using the corresponding shipping service option. This container is conditionally required if the seller is using flat-rate shipping and is not using a domestic or international shipping rate table.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='This field sets/indicates the domestic or international shipping service option, such as USPSPriority , FedEx2Day , or UPS3rdDay . Although this field uses the string type, the seller must pass in a pre-defined enumeration value here.')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description='This container is used to set the ship-to locations applicable to the corresponding shipping service option. Although the regionExcluded container is defined for RegionSet type and could technically be used here, it is recommened that only the regionIncluded container be used at the shipping service level.')
sort_order
class-attribute
instance-attribute
¶
sort_order = Field(None, alias='sortOrder', description='The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages. If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call.')
surcharge
class-attribute
instance-attribute
¶
surcharge = Field(None, description='Note: DO NOT USE THIS FIELD. Shipping surcharges for domestic shipping service options can no longer be set with fulfillment business policies, except through shipping rate tables. To do this, a seller would set up a surcharge-based shipping rate table and specify the surcharge in that table.')
TimeDuration ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='These enum values represent the time measurement unit, such as DAY . A span of time is defined when you apply the value specified in the value field to the value specified for unit . See TimeDurationUnitEnum for a complete list of possible time-measurement units.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.')
InternationalReturnOverrideType ¶
Bases: EbayModel
return_method
class-attribute
instance-attribute
¶
return_method = Field(None, alias='returnMethod', description='This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return.')
return_period
class-attribute
instance-attribute
¶
return_period = Field(None, alias='returnPeriod', description='This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer\'s specified ship-to location. You must set the value to one that\'s accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='If set to true , the seller accepts international returns. If set to false , the seller does not accept international returns. This field is conditionally required if the seller chooses to have a separate international return policy.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER . Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs.')
PaymentMethod ¶
Bases: EbayModel
brands
class-attribute
instance-attribute
¶
brands = Field(None, description='Note : This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted.')
payment_method_type
class-attribute
instance-attribute
¶
payment_method_type = Field(None, alias='paymentMethodType', description='This array is only applicable for listings supporting offline payment methods. See the PaymentMethodTypeEnum type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method.')
recipient_account_reference
class-attribute
instance-attribute
¶
recipient_account_reference = Field(None, alias='recipientAccountReference', description='Note : This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal.')
ReturnPolicy ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates which category group that the return policy applies to. Note : Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length : 250")
extended_holiday_returns_offered
class-attribute
instance-attribute
¶
extended_holiday_returns_offered = Field(None, alias='extendedHolidayReturnsOffered', description='Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.')
international_override
class-attribute
instance-attribute
¶
international_override = Field(None, alias='internationalOverride', description="This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policy. International return policies are optional, even if the seller ships to international locations.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this return business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64')
refund_method
class-attribute
instance-attribute
¶
refund_method = Field(None, alias='refundMethod', description='This field indicates the refund method offered by the seller. Its value will be MONEY_BACK unless the seller is enabled for Buy online, Pickup in Store or Click and Collect , and then it might be MERCHANDISE_CREDIT . Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.')
restocking_fee_percentage
class-attribute
instance-attribute
¶
restocking_fee_percentage = Field(None, alias='restockingFeePercentage', description='Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.')
return_instructions
class-attribute
instance-attribute
¶
return_instructions = Field(None, alias='returnInstructions', description='This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API .')
return_method
class-attribute
instance-attribute
¶
return_method = Field(None, alias='returnMethod', description="This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'.")
return_period
class-attribute
instance-attribute
¶
return_period = Field(None, alias='returnPeriod', description='This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer\'s specified ship-to location. Most categories support 30-day and 60-day return periods.')
return_policy_id
class-attribute
instance-attribute
¶
return_policy_id = Field(None, alias='returnPolicyId', description='A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='If this field is returned as true , the seller accepts returns. If set to false , the seller does not accept returns. Note: Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER . Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.')
ReturnPolicyRequest ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates which category group that the return policy applies to. Note : Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length : 250")
extended_holiday_returns_offered
class-attribute
instance-attribute
¶
extended_holiday_returns_offered = Field(None, alias='extendedHolidayReturnsOffered', description='Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.')
international_override
class-attribute
instance-attribute
¶
international_override = Field(None, alias='internationalOverride', description='This container is used by the seller to specify a separate international return policy. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this return business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length : 64')
refund_method
class-attribute
instance-attribute
¶
refund_method = Field(None, alias='refundMethod', description='This field sets the refund method to use for returned items. Its value defaults to MONEY_BACK if omitted, so this field is only needed for Buy online, Pickup in Store or Click and Collect items where the seller is willing to offer merchandise credit as an additional refund method to buyers.')
restocking_fee_percentage
class-attribute
instance-attribute
¶
restocking_fee_percentage = Field(None, alias='restockingFeePercentage', description='Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.')
return_instructions
class-attribute
instance-attribute
¶
return_instructions = Field(None, alias='returnInstructions', description='This text-based field provides more details on seller-specified return instructions. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API . Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.')
return_method
class-attribute
instance-attribute
¶
return_method = Field(None, alias='returnMethod', description="This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'.")
return_period
class-attribute
instance-attribute
¶
return_period = Field(None, alias='returnPeriod', description='This container is used to specify the number of days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer\'s specified ship-to location. You must set the value to one that\'s accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='If set to true , the seller accepts returns. If set to false , the seller does not accept returns. Note: Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER . Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.')
ReturnPolicyResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is for future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This field is for future use.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is for future use.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This field is for future use.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This field is for future use.')
return_policies
class-attribute
instance-attribute
¶
return_policies = Field(None, alias='returnPolicies', description="A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace.")
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of return business policies retrieved in the result set. If no return business policies are defined for the specified marketplace, this field is returned with a value of 0 .')
SellerEligibilityMultiProgramResponse ¶
Bases: EbayModel
advertising_eligibility
class-attribute
instance-attribute
¶
advertising_eligibility = Field(None, alias='advertisingEligibility', description='An array of response fields that define the seller eligibility for eBay advertising programs.')
SetReturnPolicyResponse ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This field always returns ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. Max length : 250")
extended_holiday_returns_offered
class-attribute
instance-attribute
¶
extended_holiday_returns_offered = Field(None, alias='extendedHolidayReturnsOffered', description='Important! This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.')
international_override
class-attribute
instance-attribute
¶
international_override = Field(None, alias='internationalOverride', description='This container is used by the seller to specify a separate international return policy, and will only be returned if the seller has set a separate return policy for international orders. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this return business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64')
refund_method
class-attribute
instance-attribute
¶
refund_method = Field(None, alias='refundMethod', description='If a seller indicates that they will accept buyer returns, this value will be MONEY_BACK .')
restocking_fee_percentage
class-attribute
instance-attribute
¶
restocking_fee_percentage = Field(None, alias='restockingFeePercentage', description='Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.')
return_instructions
class-attribute
instance-attribute
¶
return_instructions = Field(None, alias='returnInstructions', description='This text-based field provides more details on seller-specified return instructions. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API . Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.')
return_method
class-attribute
instance-attribute
¶
return_method = Field(None, alias='returnMethod', description="This field will be returned if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'.")
return_period
class-attribute
instance-attribute
¶
return_period = Field(None, alias='returnPeriod', description='This container specifies the amount of days that the buyer has to return the item after receiving it. The return period begins when the item is marked "delivered" at the buyer\'s specified ship-to location. This container will be returned unless the business policy states that the seller does not accept returns.')
return_policy_id
class-attribute
instance-attribute
¶
return_policy_id = Field(None, alias='returnPolicyId', description='A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='If set to true , the seller accepts returns. If set to false , this field indicates that the seller does not accept returns.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER . Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.')
ShippingOption ¶
Bases: EbayModel
cost_type
class-attribute
instance-attribute
¶
cost_type = Field(None, alias='costType', description='This field defines whether the shipping cost model is FLAT_RATE (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package). This field is conditionally required if any shipping service options are specified (domestic and/or international).')
insurance_fee
class-attribute
instance-attribute
¶
insurance_fee = Field(None, alias='insuranceFee', description="This field has been deprecated. Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.")
insurance_offered
class-attribute
instance-attribute
¶
insurance_offered = Field(None, alias='insuranceOffered', description="This field has been deprecated. Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.")
option_type
class-attribute
instance-attribute
¶
option_type = Field(None, alias='optionType', description='This field is used to indicate if the corresponding shipping service options (under shippingServices array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international).')
package_handling_cost
class-attribute
instance-attribute
¶
package_handling_cost = Field(None, alias='packageHandlingCost', description="This container is used if the seller adds handling charges to domestic and/or international shipments. Sellers can not specify any domestic handling charges if they offered 'free shipping' in the policy. This container will only be returned if set for the policy.")
rate_table_id
class-attribute
instance-attribute
¶
rate_table_id = Field(None, alias='rateTableId', description='This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The getRateTables method can be used to retrieve shipping rate table IDs.')
shipping_discount_profile_id
class-attribute
instance-attribute
¶
shipping_discount_profile_id = Field(None, alias='shippingDiscountProfileId', description="This field is the unique identifier of a seller's domestic or international shipping discount profile. If a buyer satisfies the requirements of the discount rule, this buyer will receive a shipping discount for the order. The seller can create and manage shipping discount profiles using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay .")
shipping_promotion_offered
class-attribute
instance-attribute
¶
shipping_promotion_offered = Field(None, alias='shippingPromotionOffered', description='This boolean indicates whether or not the seller has set up a promotional shipping discount that will be available to buyers who satisfy the requirements of the shipping discount rule. The seller can create and manage shipping promotional discounts using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay .')
shipping_services
class-attribute
instance-attribute
¶
shipping_services = Field(None, alias='shippingServices', description='This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding shippingOptions.optionType field (which controls whether domestic or international shipping service options are being defined).')
Subscription ¶
Bases: EbayModel
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The marketplace with which the subscription is associated.')
subscription_id
class-attribute
instance-attribute
¶
subscription_id = Field(None, alias='subscriptionId', description='The subscription ID.')
subscription_level
class-attribute
instance-attribute
¶
subscription_level = Field(None, alias='subscriptionLevel', description='The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels.')
subscription_type
class-attribute
instance-attribute
¶
subscription_type = Field(None, alias='subscriptionType', description='The kind of entity with which the subscription is associated, such as an eBay store.')
term
class-attribute
instance-attribute
¶
term = Field(None, description='The term of the subscription plan (typically in months).')
SubscriptionResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is for future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This field is for future use.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is for future use.')
subscriptions
class-attribute
instance-attribute
¶
subscriptions = Field(None, description='An array of subscriptions associated with the seller account.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of subscriptions displayed on the current page of results.')
Deposit ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. Max : 2000.0')
due_in
class-attribute
instance-attribute
¶
due_in = Field(None, alias='dueIn', description='This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid dueIn times are 24, 48, and 72 hours. HOUR is set as the unit value, and 24 , 48 or 72 are set in the value field. Note : The dueIn value is overridden if the seller has set the motor vehicle listing to require immediate payment.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit.')
FulfillmentPolicy ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. Max length : 250")
freight_shipping
class-attribute
instance-attribute
¶
freight_shipping = Field(None, alias='freightShipping', description='If returned as true , the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.')
fulfillment_policy_id
class-attribute
instance-attribute
¶
fulfillment_policy_id = Field(None, alias='fulfillmentPolicyId', description='A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.')
global_shipping
class-attribute
instance-attribute
¶
global_shipping = Field(None, alias='globalShipping', description="Note : This field is only applicable for the eBay United Kingdom marketplace ( EBAY_GB ). If returned as true , eBay's Global Shipping Program will be used by the seller to ship items to international locations. eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping.")
handling_time
class-attribute
instance-attribute
¶
handling_time = Field(None, alias='handlingTime', description='Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order. If only local pickup or freight shipping is available for the item, this container may not get returned.')
local_pickup
class-attribute
instance-attribute
¶
local_pickup = Field(None, alias='localPickup', description='If returned as true , local pickup is available for this policy.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this fulfillment policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length : 64')
pickup_drop_off
class-attribute
instance-attribute
¶
pickup_drop_off = Field(None, alias='pickupDropOff', description='If returned as true , the seller offers the "Click and Collect" option. Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations).')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description="This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.")
FulfillmentPolicyRequest ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length : 250")
freight_shipping
class-attribute
instance-attribute
¶
freight_shipping = Field(None, alias='freightShipping', description='This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs. Default : false')
global_shipping
class-attribute
instance-attribute
¶
global_shipping = Field(None, alias='globalShipping', description='Note : This field is only applicable for the eBay United Kingdom marketplace ( EBAY_GB ). This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.')
handling_time
class-attribute
instance-attribute
¶
handling_time = Field(None, alias='handlingTime', description='This container is used to specify the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order. Valid values can vary by site and by category.')
local_pickup
class-attribute
instance-attribute
¶
local_pickup = Field(None, alias='localPickup', description='This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer. With local pickup, the buyer and seller make arrangements for pickup time and location. Default : false')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this fulfillment policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length : 64')
pickup_drop_off
class-attribute
instance-attribute
¶
pickup_drop_off = Field(None, alias='pickupDropOff', description='This field should be included and set to true if the seller offers the "Click and Collect" feature for an item. To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations).')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description='This container consists of the regionIncluded and regionExcluded arrays, which are used to define the geographical regions/countries/states or provinces/domestic regions that a seller does and does not ship to for the associated fulfillment policy.')
FulfillmentPolicyResponse ¶
Bases: EbayModel
fulfillment_policies
class-attribute
instance-attribute
¶
fulfillment_policies = Field(None, alias='fulfillmentPolicies', description="A list of all of the seller's fulfillment policies defined for the specified marketplace. This array will be returned as empty if no fulfillment policies are defined for the specified marketplace.")
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is for future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This field is for future use.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is for future use.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This field is for future use.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This field is for future use.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of fulfillment policies retrieved in the result set. If no fulfillment policies are defined for the specified marketplace, this field is returned with a value of 0 .')
PaymentPolicy ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates whether the payment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
deposit
class-attribute
instance-attribute
¶
deposit = Field(None, description='This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES , and is only returned if the seller requires an initial deposit on motor vehicles. The container shows the amount due for the deposit and when it is due (within 1-3 days after commitment to purchase, unless the listing requires immediate payment).')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length : 250")
full_payment_due_in
class-attribute
instance-attribute
¶
full_payment_due_in = Field(None, alias='fullPaymentDueIn', description='This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. This value is always returned if categoryTypes is set to MOTORS_VEHICLES . This container indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction.')
immediate_pay
class-attribute
instance-attribute
¶
immediate_pay = Field(None, alias='immediatePay', description="If this field is returned as true , immediate payment is required from the buyer for: A fixed-price item An auction item where the buyer uses the 'Buy it Now' option A deposit for a motor vehicle listing It is possible for the seller to set this field as true in the payment business policy, but it will not apply in some scenarios.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which the payment business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Max length : 64')
payment_instructions
class-attribute
instance-attribute
¶
payment_instructions = Field(None, alias='paymentInstructions', description='Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy. Max length : 1000')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='This container is returned to show the payment methods that are accepted for the payment business policy. Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported.')
payment_policy_id
class-attribute
instance-attribute
¶
payment_policy_id = Field(None, alias='paymentPolicyId', description='A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created.')
PaymentPolicyRequest ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
deposit
class-attribute
instance-attribute
¶
deposit = Field(None, description='This container is used if the seller wants to require an initial deposit on a motor vehicle listing. In this container, the seller sets the deposit amount and the due date for the deposit. Because eBay controls all electronic payment methods, sellers do not need to specify a payment method and the deposit.paymentMethods array is not needed.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. Max length : 250")
full_payment_due_in
class-attribute
instance-attribute
¶
full_payment_due_in = Field(None, alias='fullPaymentDueIn', description='This container is used to specify the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. The period starts when the buyer commits to buy.')
immediate_pay
class-attribute
instance-attribute
¶
immediate_pay = Field(None, alias='immediatePay', description="This field should be included and set to true if the seller wants to require immediate payment from the buyer for: A fixed-price item An auction item where the buyer is using the 'Buy it Now' option A deposit for a motor vehicle listing Default: False")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this payment business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64')
payment_instructions
class-attribute
instance-attribute
¶
payment_instructions = Field(None, alias='paymentInstructions', description='Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies. A free-form string field that allows sellers to add detailed payment instructions to their listings.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description="Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.")
PaymentPolicyResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is for future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This field is for future use.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is for future use.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This field is for future use.')
payment_policies
class-attribute
instance-attribute
¶
payment_policies = Field(None, alias='paymentPolicies', description="A list of all of the seller's payment business policies defined for the specified marketplace. This array will be returned as empty if no payment business policies are defined for the specified marketplace.")
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This field is for future use.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of payment business policies retrieved in the result set. If no payment business policies are defined for the specified marketplace, this field is returned with a value of 0 .')
SetFulfillmentPolicyResponse ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. Max length : 250")
freight_shipping
class-attribute
instance-attribute
¶
freight_shipping = Field(None, alias='freightShipping', description='If returned as true , the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.')
fulfillment_policy_id
class-attribute
instance-attribute
¶
fulfillment_policy_id = Field(None, alias='fulfillmentPolicyId', description='A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created.')
global_shipping
class-attribute
instance-attribute
¶
global_shipping = Field(None, alias='globalShipping', description='Note : This field is only applicable for the eBay United Kingdom marketplace ( EBAY_GB ). This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.')
handling_time
class-attribute
instance-attribute
¶
handling_time = Field(None, alias='handlingTime', description='Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order. If only local pickup or freight shipping is available for the item, this container may not get returned.')
local_pickup
class-attribute
instance-attribute
¶
local_pickup = Field(None, alias='localPickup', description='If returned as true , local pickup is available for items using this policy.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this fulfillment business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this fulfillment business policy. Max length : 64')
pickup_drop_off
class-attribute
instance-attribute
¶
pickup_drop_off = Field(None, alias='pickupDropOff', description='If returned as true , the seller offers the "Click and Collect" option. Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations).')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description="This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.")
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.')
SetPaymentPolicyResponse ¶
Bases: EbayModel
category_types
class-attribute
instance-attribute
¶
category_types = Field(None, alias='categoryTypes', description='This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.')
deposit
class-attribute
instance-attribute
¶
deposit = Field(None, description='This container is only returned if the seller just created or updated a motor vehicles payment business policy and requires buyers to pay an initial deposit after they commit to buying a motor vehicle.')
description
class-attribute
instance-attribute
¶
description = Field(None, description="A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. Max length : 250")
full_payment_due_in
class-attribute
instance-attribute
¶
full_payment_due_in = Field(None, alias='fullPaymentDueIn', description='The number of days (after the buyer commits to buy) that a buyer has to pay the remaining balance of a motor vehicle transaction. Sellers can set this value to 3, 7, 10, or 14 days. Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES .')
immediate_pay
class-attribute
instance-attribute
¶
immediate_pay = Field(None, alias='immediatePay', description='The value returned in this field will reflect the value set by the seller in the immediatePay request field.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which this payment business policy applies.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64')
payment_instructions
class-attribute
instance-attribute
¶
payment_instructions = Field(None, alias='paymentInstructions', description='Note: NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='This array shows the available payment methods that the seller has set for the payment business policy. Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported.')
payment_policy_id
class-attribute
instance-attribute
¶
payment_policy_id = Field(None, alias='paymentPolicyId', description='A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.')