Order V2 API — client.buy.order¶
Version v2.1.4 · base path /buy/order/v2 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
apply_guest_coupon ¶
apply_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
apply_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
apply_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order.
get_guest_checkout_session ¶
get_guest_checkout_session(checkout_session_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
get_guest_checkout_session(checkout_session_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_guest_checkout_session(checkout_session_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method returns the details of the specified guest checkout session.
initiate_guest_checkout_session ¶
initiate_guest_checkout_session(*, body: CreateGuestCheckoutSessionRequestV2 | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
initiate_guest_checkout_session(*, body: CreateGuestCheckoutSessionRequestV2 | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
initiate_guest_checkout_session(*, body: CreateGuestCheckoutSessionRequestV2 | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method creates an eBay guest checkout session, which is the first step in performing a checkout.
remove_guest_coupon ¶
remove_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
remove_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
remove_guest_coupon(checkout_session_id: str, *, body: CouponRequest | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method removes a coupon from an eBay guest checkout session.
update_guest_quantity ¶
update_guest_quantity(checkout_session_id: str, *, body: UpdateQuantity | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
update_guest_quantity(checkout_session_id: str, *, body: UpdateQuantity | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_guest_quantity(checkout_session_id: str, *, body: UpdateQuantity | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the quantity of the specified line item in an eBay guest checkout session.
update_guest_shipping_address ¶
update_guest_shipping_address(checkout_session_id: str, *, body: ShippingAddressImpl | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
update_guest_shipping_address(checkout_session_id: str, *, body: ShippingAddressImpl | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_guest_shipping_address(checkout_session_id: str, *, body: ShippingAddressImpl | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the shipping address for the order in an eBay guest checkout session.
update_guest_shipping_option ¶
update_guest_shipping_option(checkout_session_id: str, *, body: UpdateShippingOption | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestCheckoutSessionResponseV2
update_guest_shipping_option(checkout_session_id: str, *, body: UpdateShippingOption | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_guest_shipping_option(checkout_session_id: str, *, body: UpdateShippingOption | None = None, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestCheckoutSessionResponseV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the shipping method for the specified line item in an eBay guest checkout session.
get_guest_purchase_order ¶
get_guest_purchase_order(purchase_order_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[False] = False) -> buy_order_models.GuestPurchaseOrderV2
get_guest_purchase_order(purchase_order_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_guest_purchase_order(purchase_order_id: str, *, x_ebay_c_marketplace_id: str | None = None, x_ebay_c_enduserctx: str | None = None, raw_response: bool = False) -> buy_order_models.GuestPurchaseOrderV2 | httpx.Response
Note: The Order V2 API supports guest checkout payment flows. If you need to support member checkout payment flows, please use the v1 version of the Order V2 API. Important! (Limited Release) This method is only available to select developers approved by business units. This method retrieves the details about a specific guest purchase order.
Models¶
ApplicableChargeTypeEnum ¶
Bases: OpenStrEnum
AuthenticityVerificationStatusEnum ¶
CountryCodeEnum ¶
Bases: OpenStrEnum
Coupon ¶
Bases: EbayModel
redemption_code
class-attribute
instance-attribute
¶
redemption_code = Field(None, alias='redemptionCode', description='The coupon redemption code.')
CouponRequest ¶
Bases: EbayModel
redemption_code
class-attribute
instance-attribute
¶
redemption_code = Field(None, alias='redemptionCode', description='The redemption code of the coupon. Maximum: One redemption code per order')
CurrencyCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
ErrorParameterV3 ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the input field that caused an issue with the method request.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The actual value that was passed in for the element specified in the name field.')
FeeEnum ¶
Bases: OpenStrEnum
battery_recycling_fee
class-attribute
instance-attribute
¶
battery_recycling_fee = 'BATTERY_RECYCLING_FEE'
electronic_recycling_fee
class-attribute
instance-attribute
¶
electronic_recycling_fee = 'ELECTRONIC_RECYCLING_FEE'
mattress_recycling_fee
class-attribute
instance-attribute
¶
mattress_recycling_fee = 'MATTRESS_RECYCLING_FEE'
white_goods_disposable_tax
class-attribute
instance-attribute
¶
white_goods_disposable_tax = 'WHITE_GOODS_DISPOSABLE_TAX'
Image ¶
Bases: EbayModel
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL for the image.')
LegacyReference ¶
Bases: EbayModel
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The legacy ID used to identify an item. This is used by the Post Order API Create Return Request method. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Create a return request in the Buy Integration Guide. Restriction: The Post Order API can be used only with eBay member checkouts.')
legacy_order_id
class-attribute
instance-attribute
¶
legacy_order_id = Field(None, alias='legacyOrderId', description='The legacy ID of the order. This is used by the Post Order API Submit Cancellation Request method. This method initiates the item cancellation process. For more information on how to use this field in the Post Order API, see Using the Post Order API . Restriction: The Post Order API can be used only with eBay member checkouts.')
legacy_transaction_id
class-attribute
instance-attribute
¶
legacy_transaction_id = Field(None, alias='legacyTransactionId', description='The legacy ID of the transaction. This is used by the Post Order API Create Return Request call. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Using the Post Order API in the Buy Integration Guide. Restriction: The Post Order API can be used only with eBay member checkouts.')
LineItemInput ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique eBay-assigned identifier of an item. This ID is returned by the Browse and Feed API methods. The ID must be in RESTful item ID format. For example: v1|2**********6|5**********4 or v1|1**********9|0 . For more information about item IDs for RESTful APIs, see Legacy API compatibility . Each itemId will become a single line item. Maximum: 10 per session')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The quantity ordered in this line item.')
LineItemPaymentStatusEnum ¶
LineItemStatusEnum ¶
Bases: OpenStrEnum
fulfillment_in_progress
class-attribute
instance-attribute
¶
fulfillment_in_progress = 'FULFILLMENT_IN_PROGRESS'
PurchaseOrderPaymentStatusEnum ¶
PurchaseOrderStatusEnum ¶
Bases: OpenStrEnum
fulfillment_in_progress
class-attribute
instance-attribute
¶
fulfillment_in_progress = 'FULFILLMENT_IN_PROGRESS'
Recipient ¶
Bases: EbayModel
first_name
class-attribute
instance-attribute
¶
first_name = Field(None, alias='firstName', description='The first name of the person receiving the purchase order.')
last_name
class-attribute
instance-attribute
¶
last_name = Field(None, alias='lastName', description='The last name of the person receiving the purchase order.')
RegionTypeEnum ¶
Bases: OpenStrEnum
Seller ¶
Bases: EbayModel
username
class-attribute
instance-attribute
¶
username = Field(None, description='The user name created by the seller for use on eBay.')
ServiceTypeEnum ¶
ShippingAddress ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address where the item is being shipped. Maximum: 40 characters for AU, CA, and US marketplaces 35 characters for DE and GB marketplaces 50 characters for all other marketplaces')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'. Maximum: 40 characters for AU, CA, and US marketplaces 35 characters for DE and GB marketplaces 50 characters for all other marketplaces")
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the address where the item is being shipped.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two letter code representing the country of the address.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county of the address where the item is being shipped.')
phone_number
class-attribute
instance-attribute
¶
phone_number = Field(None, alias='phoneNumber', description='The phone number of the person receiving the package. Note: It is highly recommended that when entering the phone number you include the country code. For example, if a US phone number is 4********4 , you would enter +14********4 . If you do not include this code, the service will use the country specified in the country field. You can find the country code at https://countrycode.org .')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the address where the item is being shipped. Note: This is optional when shipping to EBAY_HK (Hong Kong).')
recipient
class-attribute
instance-attribute
¶
recipient = Field(None, description='The name of the person receiving the package.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the address. Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes .')
ShippingAddressImpl ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address where the item is being shipped. Maximum: 40 characters for AU, CA, and US marketplaces 35 characters for DE and GB marketplaces 50 characters for all other marketplaces')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'. Maximum: 40 characters for AU, CA, and US marketplaces 35 characters for DE and GB marketplaces 50 characters for all other marketplaces")
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the address where the item is being shipped.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two letter code representing the country of the address.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county of the address where the item is being shipped.')
phone_number
class-attribute
instance-attribute
¶
phone_number = Field(None, alias='phoneNumber', description='The phone number of the person receiving the package. Note: It is highly recommended that when entering the phone number you include the country code. For example, if a US phone number is 4********4 , you would enter +14********4 . If you do not include this code, the service will use the country specified in the country field. You can find the country code at https://countrycode.org .')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the address where the item is being shipped. Note: This is optional when shipping to EBAY_HK (Hong Kong).')
recipient
class-attribute
instance-attribute
¶
recipient = Field(None, description='The name of the person receiving the package.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the address. Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes .')
ShippingDetail ¶
Bases: EbayModel
ebay_shipping
class-attribute
instance-attribute
¶
ebay_shipping = Field(None, alias='ebayShipping', description='This value indicates whether shipping for this order is managed by eBay ( true ) or by the seller (omitted if false or not applicable to the transaction). When true , the value in the pricingSummary.deliveryCost container indicates the shipping cost paid directly by the buyer to eBay.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='The end of the date range in which the purchase order is expected to be delivered to the shipping address (final destination).')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='The beginning of the date range in which the purchase order is expected to be delivered to the shipping address (final destination).')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='The shipping provider for the line item, such as FedEx or USPS.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='The name of the shipping service option. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx).')
TaxClassificationEnum ¶
TaxType ¶
Bases: OpenStrEnum
UpdateQuantity ¶
Bases: EbayModel
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='A unique eBay-assigned ID value that identifies a line item in a purchase order. For example: v1|2**********6|5**********4 or v1|1**********9|0 . For more information about item IDs for RESTful APIs, see Legacy API compatibility .')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The quantity of the line item that you wish to update.')
UpdateShippingOption ¶
Bases: EbayModel
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='A unique eBay-assigned ID value that identifies the line item in a checkout session. For example: v1|2**********6|5**********4 or v1|1**********9|0 . For more information about item IDs for RESTful APIs, see Legacy API compatibility')
shipping_option_id
class-attribute
instance-attribute
¶
shipping_option_id = Field(None, alias='shippingOptionId', description='A unique identifier of the selected shipping option/method.')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item.')
AuthenticityVerificationProgram ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='An informational message that applies to the Authenticity Guarantee program.')
outcome_reason
class-attribute
instance-attribute
¶
outcome_reason = Field(None, alias='outcomeReason', description='An informational message regarding the authentication outcome of an Authenticity Guarantee verification inspection. Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='An enumerated value that indicates whether the order line item has passed or failed the Authenticity Guarantee verification inspection, or whether the inspection and/or results are still pending. Note: This field is conditionally returned when the purchase is complete. Valid Values: PENDING PASSED FAILED INELIGIBLE')
terms_web_url
class-attribute
instance-attribute
¶
terms_web_url = Field(None, alias='termsWebUrl', description='The terms and conditions that apply to the Authenticity Guarantee program.')
CheckoutAddonService ¶
Bases: EbayModel
selected
class-attribute
instance-attribute
¶
selected = Field(None, description='This boolean indicates whether the service is selected or not.')
service_fee
class-attribute
instance-attribute
¶
service_fee = Field(None, alias='serviceFee', description='The container that returns the amount and currency of the fee for an add-on service.')
service_id
class-attribute
instance-attribute
¶
service_id = Field(None, alias='serviceId', description='The unique identifier of the add-on service.')
service_tax
class-attribute
instance-attribute
¶
service_tax = Field(None, alias='serviceTax', description='The container that returns the amount and currency of the sales tax applied against the add-on service fee. This tax is based on the state or territory in which the buyer is located.')
service_type
class-attribute
instance-attribute
¶
service_type = Field(None, alias='serviceType', description='The type of add-on service, such as AUTHENTICITY_GUARANTEE .')
CreateGuestCheckoutSessionRequestV2 ¶
Bases: EbayModel
contact_email
class-attribute
instance-attribute
¶
contact_email = Field(None, alias='contactEmail', description="The buyer's email address.")
line_item_inputs
class-attribute
instance-attribute
¶
line_item_inputs = Field(None, alias='lineItemInputs', description='An array used to define the line item(s) and desired quantity for an eBay guest checkout session. Maximum: 10 line items')
shipping_address
class-attribute
instance-attribute
¶
shipping_address = Field(None, alias='shippingAddress', description='A container that defines the shipping address for an eBay guest checkout session. Note: If the address cannot be validated, a warning message is returned along with the response.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='The name of 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 code that identifies the particular error or warning 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='An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A detailed description of the condition that caused the error or warning, and information on what what must be done to correct the problem.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A description of the condition that caused the error or warning.')
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='The name of the subdomain in which the error or warning occurred.')
Fee ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='A container for the currency type and monetary amount of the fee associated with the line item.')
fee_type
class-attribute
instance-attribute
¶
fee_type = Field(None, alias='feeType', description='The type of fee associated with the line item.')
ImportChargesV2 ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The amount of the import charge.')
applicable_charge_type
class-attribute
instance-attribute
¶
applicable_charge_type = Field(None, alias='applicableChargeType', description='The type of charge to apply to the order, such as import duties.')
ImportTax ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The total amount of import tax for all line items of an order.')
import_tax_type
class-attribute
instance-attribute
¶
import_tax_type = Field(None, alias='importTaxType', description='An enumeration value that indicates the type of import tax applicable to the order. Currently, the only applicable import tax is the Goods and Services tax (indicated with GST ). The Goods and Services tax is only applicable to orders for the eBay Australia marketplace.')
Promotion ¶
Bases: EbayModel
discount
class-attribute
instance-attribute
¶
discount = Field(None, description='The details regarding the monetary value of the promotional discount. Note: eBay Bucks are not supported.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='The text for the promotion title, which describes the promotion.')
promotion_type
class-attribute
instance-attribute
¶
promotion_type = Field(None, alias='promotionType', description='The kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON .')
Region ¶
Bases: EbayModel
region_name
class-attribute
instance-attribute
¶
region_name = Field(None, alias='regionName', description='A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level, or at the country level in the case of VAT tax.')
region_type
class-attribute
instance-attribute
¶
region_type = Field(None, alias='regionType', description='An enumeration value that indicates the type of region for the tax jurisdiction. Valid Values: STATE_OR_PROVINCE COUNTRY')
ShippingOption ¶
Bases: EbayModel
base_delivery_cost
class-attribute
instance-attribute
¶
base_delivery_cost = Field(None, alias='baseDeliveryCost', description='The delivery cost using this shipping option, for this line item, before any delivery discounts are applied. Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see VAT-inclusive pricing.')
delivery_discount
class-attribute
instance-attribute
¶
delivery_discount = Field(None, alias='deliveryDiscount', description='The monetary value of any delivery discounts.')
ebay_shipping
class-attribute
instance-attribute
¶
ebay_shipping = Field(None, alias='ebayShipping', description='This value indicates whether shipping for this order is managed by eBay ( true ) or by the seller ( false ).')
import_charges
class-attribute
instance-attribute
¶
import_charges = Field(None, alias='importCharges', description='The Global Shipping Program import charges for this line item.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='The end of the date range in which the purchase order is expected to be delivered to the shipping address.')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='The beginning of the date range in which the purchase order is expected to be delivered to the shipping address.')
selected
class-attribute
instance-attribute
¶
selected = Field(None, description='A field that indicates whether the shipping method is selected.')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='The shipping provider for the line item, such as FedEx or USPS.')
shipping_option_id
class-attribute
instance-attribute
¶
shipping_option_id = Field(None, alias='shippingOptionId', description='A unique ID for the selected shipping option/method.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='The name of the shipping service code. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx).')
TaxClassificationDetail ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='A container for the currency type and monetary amount of the tax collected for an item.')
tax_type
class-attribute
instance-attribute
¶
tax_type = Field(None, alias='taxType', description='Indicates the type of tax that has been collected for the item.')
TaxDetails ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='A container for the currency type and monetary amount of the tax item.')
tax_classification
class-attribute
instance-attribute
¶
tax_classification = Field(None, alias='taxClassification', description='Specifies what the tax item pertains to, such as a tangible object ( ITEM_TAX ), a service ( SERVICE_TAX ), or shipping fees ( SHIPPING_TAX ).')
tax_classification_details
class-attribute
instance-attribute
¶
tax_classification_details = Field(None, alias='taxClassificationDetails', description='Provides a detailed accounting, by TaxType , of taxes collected for each item within an order.')
TaxJurisdiction ¶
Bases: EbayModel
AddonService ¶
Bases: EbayModel
service_fee
class-attribute
instance-attribute
¶
service_fee = Field(None, alias='serviceFee', description='The container that returns the amount and currency of the fee for an add-on service.')
service_tax
class-attribute
instance-attribute
¶
service_tax = Field(None, alias='serviceTax', description='The container that returns the amount and currency of the sales tax applied against the add-on service fee. This tax is based on the state or territory in which the buyer is located.')
service_type
class-attribute
instance-attribute
¶
service_type = Field(None, alias='serviceType', description='An enumerated value that defines the type of add-on service.')
Adjustment ¶
PricingSummaryV2 ¶
Bases: EbayModel
additional_savings
class-attribute
instance-attribute
¶
additional_savings = Field(None, alias='additionalSavings', description='The total amount of the coupon discounts in the purchase order.')
addon_services_fee
class-attribute
instance-attribute
¶
addon_services_fee = Field(None, alias='addonServicesFee', description='The total fee for add-on services among all line items. Note: This field is only used by the getGuestPurchaseOrder method, and is not used by any of the guest_checkout_session methods.')
adjustment
class-attribute
instance-attribute
¶
adjustment = Field(None, description='The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields.')
delivery_cost
class-attribute
instance-attribute
¶
delivery_cost = Field(None, alias='deliveryCost', description='The delivery cost for all of the line items, after any delivery discounts are applied. For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.')
delivery_discount
class-attribute
instance-attribute
¶
delivery_discount = Field(None, alias='deliveryDiscount', description='The total amount of the order delivery discounts for all of the line items, such as free shipping. Note: This field is only used by the getGuestPurchaseOrder method, and is not used by any of the guest_checkout_session methods.')
fee
class-attribute
instance-attribute
¶
fee = Field(None, description='The total amount of any fees for all the line items in the order, such as a recycling fee.')
import_charges
class-attribute
instance-attribute
¶
import_charges = Field(None, alias='importCharges', description='The sum of all Global Shipping Program import charges, for all the line items in the order.')
import_duties
class-attribute
instance-attribute
¶
import_duties = Field(None, alias='importDuties', description='The total sum of cross-border import duties calculated for all line items in the order, which is paid by the buyer at checkout. Note: This field is only used by the getGuestPurchaseOrder method, and is not used by any of the guest_checkout_session methods.')
import_tax
class-attribute
instance-attribute
¶
import_tax = Field(None, alias='importTax', description='The type of import tax applicable to the order, and the total amount of tax for all line items in the order.')
price_discount
class-attribute
instance-attribute
¶
price_discount = Field(None, alias='priceDiscount', description='The total discount amount for all line items in the order. For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts. Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field.')
price_subtotal
class-attribute
instance-attribute
¶
price_subtotal = Field(None, alias='priceSubtotal', description='The total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments. Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
tax
class-attribute
instance-attribute
¶
tax = Field(None, description='The total amount of taxes for all line items in the order.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total cost of the order, which includes: ( priceSubtotal - priceDiscount ) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings .')
TaxDetail ¶
Bases: EbayModel
included_in_price
class-attribute
instance-attribute
¶
included_in_price = Field(None, alias='includedInPrice', description='A field that indicates whether tax was applied for the cost of the item and its shipping.')
tax_jurisdiction
class-attribute
instance-attribute
¶
tax_jurisdiction = Field(None, alias='taxJurisdiction', description='A container that returns the tax jurisdiction information.')
tax_type
class-attribute
instance-attribute
¶
tax_type = Field(None, alias='taxType', description='A field that indicates the type of tax that may be collected for the item.')
LineItem ¶
Bases: EbayModel
addon_services
class-attribute
instance-attribute
¶
addon_services = Field(None, alias='addonServices', description='An array of add-on services for the line item.')
authenticity_verification
class-attribute
instance-attribute
¶
authenticity_verification = Field(None, alias='authenticityVerification', description="A container returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.")
base_unit_price
class-attribute
instance-attribute
¶
base_unit_price = Field(None, alias='baseUnitPrice', description='The cost of a single quantity of the line item. This is the starting point for computing the price during the checkout session. Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
fees
class-attribute
instance-attribute
¶
fees = Field(None, description='A breakdown of the fees applicable to the line item.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='An eBay-assigned URL of the item image.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID is in RESTful item ID format. For example: v1|2**********6|5**********4 or v1|1**********9|0 . For more information about item IDs for RESTful APIs, see Legacy API compatibility .')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='A unique eBay-assigned ID value that identifies a line item in a checkout session.')
net_price
class-attribute
instance-attribute
¶
net_price = Field(None, alias='netPrice', description='The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies. Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments.')
promotions
class-attribute
instance-attribute
¶
promotions = Field(None, description='An array of promotions applied to the line item.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The quantity ordered for the line item.')
seller
class-attribute
instance-attribute
¶
seller = Field(None, description='A container that returns the information about the seller, such as their eBay user name.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='An array of shipping options that are available for the line item. By default, the first one will be selected. Note: The updateGuestShippingOption method can be used to change the shipping option.')
tax_details
class-attribute
instance-attribute
¶
tax_details = Field(None, alias='taxDetails', description='A container that returns the tax information for the line item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-created title of the item.')
OrderLineItemV2 ¶
Bases: EbayModel
addon_services
class-attribute
instance-attribute
¶
addon_services = Field(None, alias='addonServices', description='An array of add-on services that apply to the order line item.')
authenticity_verification
class-attribute
instance-attribute
¶
authenticity_verification = Field(None, alias='authenticityVerification', description="A container that is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.")
base_unit_price
class-attribute
instance-attribute
¶
base_unit_price = Field(None, alias='baseUnitPrice', description='The cost of a single quantity of the line item. Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU .')
fees
class-attribute
instance-attribute
¶
fees = Field(None, description='A breakdown of the fees applicable to the line item.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='An eBay-assigned URL of the item image.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The eBay identifier of an item. This ID is returned by the Browse and Feed API methods.')
item_on_hold
class-attribute
instance-attribute
¶
item_on_hold = Field(None, alias='itemOnHold', description='When this value is true it indicates that the item has been put on hold due to a violation of eBay Policy.')
legacy_reference
class-attribute
instance-attribute
¶
legacy_reference = Field(None, alias='legacyReference', description='A container that returns fields to support using the Post Order API for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see Using the Post Order API . Note: The Post Order API can be used only with eBay member checkouts.')
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='A unique eBay-assigned ID value that identifies a line item in a checkout session. This is created by the initiateGuestCheckoutSession .')
line_item_payment_status
class-attribute
instance-attribute
¶
line_item_payment_status = Field(None, alias='lineItemPaymentStatus', description='An enumeration value that indicates the payment status of the line item.')
line_item_status
class-attribute
instance-attribute
¶
line_item_status = Field(None, alias='lineItemStatus', description='An enumeration value that indicates the fulfillment state of this line item. Note: When there is no tracking information, the status will never change from FULFILLMENT_IN_PROGRESS ; without tracking information, eBay has no way of knowing whether the order was delivered.')
net_price
class-attribute
instance-attribute
¶
net_price = Field(None, alias='netPrice', description='The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies. Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique order ID for the line item. Maximum Length: 40 characters')
promotions
class-attribute
instance-attribute
¶
promotions = Field(None, description='An array of promotions applied to the line item.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The quantity ordered for the line item.')
seller
class-attribute
instance-attribute
¶
seller = Field(None, description="A container for information about the seller offering this item, such as the seller's user name.")
shipping_detail
class-attribute
instance-attribute
¶
shipping_detail = Field(None, alias='shippingDetail', description='A container for information about the shipping details of the order.')
tax_details
class-attribute
instance-attribute
¶
tax_details = Field(None, alias='taxDetails', description='A container for the tax information for the line item. Note: The information in this container is only returned when requested from the GB marketplace, when applicable.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-created title of the item.')
GuestCheckoutSessionResponseV2 ¶
Bases: EbayModel
applied_coupons
class-attribute
instance-attribute
¶
applied_coupons = Field(None, alias='appliedCoupons', description='A container that returns the information for the coupons that were applied in the guest checkout session.')
checkout_session_id
class-attribute
instance-attribute
¶
checkout_session_id = Field(None, alias='checkoutSessionId', description='The eBay-assigned guest checkout session ID. This ID is created after a successful initiateGuestCheckoutSession call.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='An array of line items associated with the guest checkout session.')
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts.')
shipping_address
class-attribute
instance-attribute
¶
shipping_address = Field(None, alias='shippingAddress', description='A container that returns the address to which the purchase order will be shipped.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of errors or warnings that were generated during the method processing.')
GuestPurchaseOrderV2 ¶
Bases: EbayModel
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='An array of line items in the order.')
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts.')
purchase_order_creation_date
class-attribute
instance-attribute
¶
purchase_order_creation_date = Field(None, alias='purchaseOrderCreationDate', description='The creation date of the purchase order.')
purchase_order_id
class-attribute
instance-attribute
¶
purchase_order_id = Field(None, alias='purchaseOrderId', description='The unique identifier of the purchase order.')
purchase_order_payment_status
class-attribute
instance-attribute
¶
purchase_order_payment_status = Field(None, alias='purchaseOrderPaymentStatus', description='A container that returns the payment status for the purchase order.')
purchase_order_status
class-attribute
instance-attribute
¶
purchase_order_status = Field(None, alias='purchaseOrderStatus', description="An enumeration value that indicates the current status of the buyer's payment and any refund that applies to the purchase order.")
refunded_amount
class-attribute
instance-attribute
¶
refunded_amount = Field(None, alias='refundedAmount', description='The total amount of any refunds for the purchase order.')
tax_details
class-attribute
instance-attribute
¶
tax_details = Field(None, alias='taxDetails', description='Detailed tax information for items included in this order.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A container for any warning messages.')