Inventory API — client.sell.inventory¶
Version 1.18.5 · base path /sell/inventory/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
bulk_create_or_replace_inventory_item ¶
bulk_create_or_replace_inventory_item(*, body: BulkInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkInventoryItemResponse
bulk_create_or_replace_inventory_item(*, body: BulkInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_or_replace_inventory_item(*, body: BulkInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkInventoryItemResponse | httpx.Response
Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.
bulk_get_inventory_item ¶
bulk_get_inventory_item(*, body: BulkGetInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkGetInventoryItemResponse
bulk_get_inventory_item(*, body: BulkGetInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_get_inventory_item(*, body: BulkGetInventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkGetInventoryItemResponse | httpx.Response
This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is specified in the request payload. Note: In addition to the authorization header, which is required for all Inventory API calls, this call also requires the Content-Type header.
bulk_update_price_quantity ¶
bulk_update_price_quantity(*, body: BulkPriceQuantity, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkPriceQuantityResponse
bulk_update_price_quantity(*, body: BulkPriceQuantity, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_price_quantity(*, body: BulkPriceQuantity, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkPriceQuantityResponse | httpx.Response
This call is used by the seller to update the total ship-to-home quantity of one inventory item, and/or to update the price and/or quantity of one or more offers associated with one inventory item. Up to 25 offers associated with an inventory item may be updated with one bulkUpdatePriceQuantity call. Only one SKU (one product) can be updated per call.
get_inventory_item ¶
get_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.InventoryItemWithSkuLocaleGroupid
get_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.InventoryItemWithSkuLocaleGroupid | httpx.Response
This call retrieves the inventory item record for a given SKU. The SKU value is passed in at the end of the call URI. There is no request payload for this call. The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.
create_or_replace_inventory_item ¶
create_or_replace_inventory_item(sku: str, *, body: InventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BaseResponse
create_or_replace_inventory_item(sku: str, *, body: InventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_or_replace_inventory_item(sku: str, *, body: InventoryItem, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BaseResponse | httpx.Response
Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.
delete_inventory_item ¶
delete_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_inventory_item(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call is used to delete an inventory item record associated with a specified SKU.
get_inventory_items ¶
get_inventory_items(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.InventoryItems
get_inventory_items(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_items(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.InventoryItems | httpx.Response
This call retrieves all inventory item records defined for the seller's account. The limit query parameter allows the seller to control how many records are returned per page, and the offset query parameter is used to retrieve a specific page of records. The seller can make multiple calls to scan through multiple pages of records. There is no request payload for this call.
get_product_compatibility ¶
get_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.Compatibility
get_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.Compatibility | httpx.Response
This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call with return the compatible vehicle list associated with this inventory item.
create_or_replace_product_compatibility ¶
create_or_replace_product_compatibility(sku: str, *, body: Compatibility, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BaseResponse
create_or_replace_product_compatibility(sku: str, *, body: Compatibility, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_or_replace_product_compatibility(sku: str, *, body: Compatibility, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BaseResponse | httpx.Response
This call is used by the seller to create or replace a list of products that are compatible with the inventory item. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.
delete_product_compatibility ¶
delete_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_product_compatibility(sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call is used by the seller to delete the list of products that are compatible with the inventory item that is associated with the compatible product list. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.
get_inventory_item_group ¶
get_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.InventoryItemGroup
get_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.InventoryItemGroup | httpx.Response
This call retrieves the inventory item group for a given inventoryItemGroupKey value. The inventoryItemGroupKey value is passed in at the end of the call URI.
create_or_replace_inventory_item_group ¶
create_or_replace_inventory_item_group(inventory_item_group_key: str, *, body: InventoryItemGroup, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BaseResponse
create_or_replace_inventory_item_group(inventory_item_group_key: str, *, body: InventoryItemGroup, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_or_replace_inventory_item_group(inventory_item_group_key: str, *, body: InventoryItemGroup, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BaseResponse | httpx.Response
Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day. This call creates a new inventory item group or updates an existing inventory item group.
delete_inventory_item_group ¶
delete_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_inventory_item_group(inventory_item_group_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call deletes the inventory item group for a given inventoryItemGroupKey value.
bulk_migrate_listing ¶
bulk_migrate_listing(*, body: BulkMigrateListing, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkMigrateListingResponse
bulk_migrate_listing(*, body: BulkMigrateListing, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_migrate_listing(*, body: BulkMigrateListing, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkMigrateListingResponse | httpx.Response
This call is used to convert existing eBay Listings to the corresponding Inventory API objects. If an eBay listing is successfully migrated to the Inventory API model, new Inventory Location, Inventory Item, and Offer objects are created.
get_sku_location_mapping ¶
get_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.LocationMapping
get_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.LocationMapping | httpx.Response
This method allows sellers to retrieve the locations mapped to a specific SKU within a listing. The listingId and sku of the listing are passed in as path parameters. This method only retrieves location mappings for a single SKU value; if a seller wishes to retrieve the location mappings for all items in a multiple-variation listing, this method must be called for each variation in the listing.
create_or_replace_sku_location_mapping ¶
create_or_replace_sku_location_mapping(listing_id: str, sku: str, *, body: LocationMapping, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_or_replace_sku_location_mapping(listing_id: str, sku: str, *, body: LocationMapping, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_or_replace_sku_location_mapping(listing_id: str, sku: str, *, body: LocationMapping, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method allows sellers to map multiple fulfillment center locations to single-SKU listing, or to a single SKU within a multiple-variation listing. This allows eBay to leverage the location metadata associated with a seller’s fulfillment centers to calculate more accurate estimated delivery dates on their listing.
delete_sku_location_mapping ¶
delete_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_sku_location_mapping(listing_id: str, sku: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method allows sellers to remove all location mappings associated with a specific SKU within a listing. The listingId and sku of the listing are passed in as path parameters. Important! To remove all location mappings from a multiple-variation listing, this method must be used for each individual SKU in the listing.
bulk_create_offer ¶
bulk_create_offer(*, body: BulkEbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkOfferResponse
bulk_create_offer(*, body: BulkEbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_offer(*, body: BulkEbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkOfferResponse | httpx.Response
This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace.
bulk_publish_offer ¶
bulk_publish_offer(*, body: BulkOffer, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.BulkPublishResponse
bulk_publish_offer(*, body: BulkOffer, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_publish_offer(*, body: BulkOffer, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.BulkPublishResponse | httpx.Response
Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day. This call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings. The unique identifier ( offerId ) of each offer to publish is passed into the request payload.
get_offers ¶
get_offers(*, sku: str, format: str | None = None, limit: int | str | None = None, marketplace_id: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.Offers
get_offers(*, sku: str, format: str | None = None, limit: int | str | None = None, marketplace_id: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_offers(*, sku: str, format: str | None = None, limit: int | str | None = None, marketplace_id: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.Offers | httpx.Response
This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format. Note: At this time, the same SKU value can not be offered across multiple eBay marketplaces, so the marketplace_id query parameter currently does not have any practical use for this call.
create_offer ¶
create_offer(*, body: EbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.OfferResponse
create_offer(*, body: EbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_offer(*, body: EbayOfferDetailsWithKeys, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.OfferResponse | httpx.Response
This call creates an offer for a specific inventory item on a specific eBay marketplace. It is up to the sellers whether they want to create a complete offer (with all necessary details) right from the start, or sellers can provide only some information with the initial createOffer call, and then make one or more subsequent updateOffer calls to complete the offer and prepare to publish the offer.
get_offer ¶
get_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.EbayOfferDetailsWithAll
get_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.EbayOfferDetailsWithAll | httpx.Response
This call retrieves a specific published or unpublished offer. The unique identifier of the offer ( offerId ) is passed in at the end of the call URI. The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.
update_offer ¶
update_offer(offer_id: str, *, body: EbayOfferDetailsWithId, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.OfferResponse
update_offer(offer_id: str, *, body: EbayOfferDetailsWithId, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_offer(offer_id: str, *, body: EbayOfferDetailsWithId, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.OfferResponse | httpx.Response
This call updates an existing offer. An existing offer may be in published state (active eBay listing), or in an unpublished state and yet to be published with the publishOffer call. The unique identifier ( offerId ) for the offer to update is passed in at the end of the call URI.
delete_offer ¶
delete_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
If used against an unpublished offer, this call will permanently delete that offer. In the case of a published offer (or live eBay listing), a successful call will either end the single-variation listing associated with the offer, or it will remove that product variation from the eBay listing and also automatically remove that product variation from the inventory item group.
get_listing_fees ¶
get_listing_fees(*, body: OfferKeysWithId | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.FeesSummaryResponse
get_listing_fees(*, body: OfferKeysWithId | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_fees(*, body: OfferKeysWithId | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.FeesSummaryResponse | httpx.Response
This call is used to retrieve the expected listing fees for up to 250 unpublished offers. An array of one or more >offerId values are passed in under the offers container. In the response payload, all listing fees are grouped by eBay marketplace, and listing fees per offer are not shown.
publish_offer ¶
publish_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.PublishResponse
publish_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
publish_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.PublishResponse | httpx.Response
Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day. This call is used to convert an unpublished offer into a published offer, or live eBay listing. The unique identifier of the offer ( offerId ) is passed in at the end of the call URI.
publish_offer_by_inventory_item_group ¶
publish_offer_by_inventory_item_group(*, body: PublishByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.PublishResponse
publish_offer_by_inventory_item_group(*, body: PublishByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
publish_offer_by_inventory_item_group(*, body: PublishByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.PublishResponse | httpx.Response
Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.
withdraw_offer ¶
withdraw_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.WithdrawResponse
withdraw_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
withdraw_offer(offer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.WithdrawResponse | httpx.Response
This call is used to end a single-variation listing that is associated with the specified offer. This call is used in place of the deleteOffer call if the seller only wants to end the listing associated with the offer but does not want to delete the offer object.
withdraw_offer_by_inventory_item_group ¶
withdraw_offer_by_inventory_item_group(*, body: WithdrawByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
withdraw_offer_by_inventory_item_group(*, body: WithdrawByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
withdraw_offer_by_inventory_item_group(*, body: WithdrawByInventoryItemGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. This call only ends multiple-variation eBay listing associated with the inventory item group but does not delete the inventory item group object.
get_inventory_location ¶
get_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.InventoryLocationResponse
get_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.InventoryLocationResponse | httpx.Response
This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter. A successful call will return an HTTP status value of 200 OK .
create_inventory_location ¶
create_inventory_location(merchant_location_key: str, *, body: InventoryLocationFull, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_inventory_location(merchant_location_key: str, *, body: InventoryLocationFull, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_inventory_location(merchant_location_key: str, *, body: InventoryLocationFull, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one location, as every offer must be associated with at least one location.
delete_inventory_location ¶
delete_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call deletes the inventory location that is specified in the merchantLocationKey path parameter. Note that deleting a location will not affect any active eBay listings associated with the deleted location, but the seller will not be able modify the offers associated with the location once it is deleted.
disable_inventory_location ¶
disable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
disable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
disable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This call disables the inventory location that is specified in the merchantLocationKey path parameter. Sellers can not load/modify inventory to disabled locations. Note that disabling a location will not affect any active eBay listings associated with the disabled location, but the seller will not be able modify the offers associated with a disabled location.
enable_inventory_location ¶
enable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
enable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
enable_inventory_location(merchant_location_key: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This call enables a disabled inventory location that is specified in the merchantLocationKey path parameter. Once a disabled location is enabled, sellers can start loading/modifying inventory to that location. A successful call will return an HTTP status value of 200 OK .
get_inventory_locations ¶
get_inventory_locations(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_inventory_models.LocationResponse
get_inventory_locations(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_locations(*, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_inventory_models.LocationResponse | httpx.Response
This call retrieves all defined details for every inventory location associated with the seller's account. There are no required parameters for this call and no request payload. However, there are two optional query parameters, limit and offset .
update_inventory_location ¶
update_inventory_location(merchant_location_key: str, *, body: InventoryLocation, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_inventory_location(merchant_location_key: str, *, body: InventoryLocation, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_inventory_location(merchant_location_key: str, *, body: InventoryLocation, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Use this call to update location details for an existing inventory location. Specify the inventory location you want to update using the merchantLocationKey path parameter.
Models¶
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='A three-letter string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. See ISO 4217 for more information and links to the full list of currencies and their corresponding three-letter string values.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='A string representation of a dollar value expressed in the currency specified in the currency field. Both the value and currency fields are required/always returned when expressing prices.')
AvailabilityTypeEnum ¶
BestOffer ¶
Bases: EbayModel
auto_accept_price
class-attribute
instance-attribute
¶
auto_accept_price = Field(None, alias='autoAcceptPrice', description="This is the price at which Best Offers are automatically accepted. If a buyer submits a Best Offer that is equal to or above this value, the offer is automatically accepted on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to true . The price set here must be lower than the current 'Buy it Now' price.")
auto_decline_price
class-attribute
instance-attribute
¶
auto_decline_price = Field(None, alias='autoDeclinePrice', description='This is the price at which Best Offers are automatically declined. If a buyer submits a Best Offer that is equal to or below this value, the offer is automatically declined on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to true .')
best_offer_enabled
class-attribute
instance-attribute
¶
best_offer_enabled = Field(None, alias='bestOfferEnabled', description='This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature. The seller includes this field and sets its value to true to enable Best Offer feature. Note: Best Offer is not available for multi-variation listings.')
Charity ¶
Bases: EbayModel
charity_id
class-attribute
instance-attribute
¶
charity_id = Field(None, alias='charityId', description='The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds. The charitable organization must be reqistered with the PayPal Giving Fund in order to receive sales proceeds through eBay listings. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.')
donation_percentage
class-attribute
instance-attribute
¶
donation_percentage = Field(None, alias='donationPercentage', description='This field is the percentage of the purchase price that the charitable organization (identified in the charityId field) will receive for each sale that the listing generates. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.')
ConditionDescriptor ¶
Bases: EbayModel
additional_info
class-attribute
instance-attribute
¶
additional_info = Field(None, alias='additionalInfo', description='This string provides additional information about a condition descriptor. Open text is passed in this field. In the case of trading cards and coins, this field houses the optional Certification Number condition descriptor for graded items. For salvage, this field houses the optional Damage Code condition descriptor for graded items.')
name
class-attribute
instance-attribute
¶
name = Field(None, description="This string provides the name of a condition descriptor. A numeric ID is passed in this field. This numeric ID maps to the name of a condition descriptor. Condition descriptor name-value pairs provide more information about an item's condition in a structured way.")
values
class-attribute
instance-attribute
¶
values = Field(None, description="This array provides the value(s) associated with a condition descriptor. One or more numeric IDs is passed in this field. Commas are used as delimiters between successive name/value pairs. These numeric IDs map to the values associated with a condition descriptor name. Condition descriptor name-value pairs provide more information about an item's condition in a structured way.")
ConditionEnum ¶
Bases: OpenStrEnum
manufacturer_refurbished
class-attribute
instance-attribute
¶
manufacturer_refurbished = 'MANUFACTURER_REFURBISHED'
certified_refurbished
class-attribute
instance-attribute
¶
certified_refurbished = 'CERTIFIED_REFURBISHED'
excellent_refurbished
class-attribute
instance-attribute
¶
excellent_refurbished = 'EXCELLENT_REFURBISHED'
very_good_refurbished
class-attribute
instance-attribute
¶
very_good_refurbished = 'VERY_GOOD_REFURBISHED'
for_parts_or_not_working
class-attribute
instance-attribute
¶
for_parts_or_not_working = 'FOR_PARTS_OR_NOT_WORKING'
pre_owned_excellent
class-attribute
instance-attribute
¶
pre_owned_excellent = 'PRE_OWNED_EXCELLENT'
CountryCodeEnum ¶
Bases: OpenStrEnum
CountryPolicy ¶
Bases: EbayModel
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166-1 country code identifying the country to which the policy or policies specified in the corresponding policyIds array will apply.')
policy_ids
class-attribute
instance-attribute
¶
policy_ids = Field(None, alias='policyIds', description='An array of custom policy identifiers that apply to the country specified by listingPolicies.regionalTakeBackPolicies.countryPolicies.country .')
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DayOfWeekEnum ¶
Bases: OpenStrEnum
Document ¶
Bases: EbayModel
document_id
class-attribute
instance-attribute
¶
document_id = Field(None, alias='documentId', description='The unique identifier of a regulatory document associated with the listing. This value can be found in the response of the createDocument method of the Media API.')
EnergyEfficiencyLabel ¶
Bases: EbayModel
image_description
class-attribute
instance-attribute
¶
image_description = Field(None, alias='imageDescription', description='A brief verbal summary of the information included on the Energy Efficiency Label for an item. For example, On a scale of A to G the rating is E.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageURL', description='The URL to the Energy Efficiency Label image that is applicable to an item.')
product_information_sheet
class-attribute
instance-attribute
¶
product_information_sheet = Field(None, alias='productInformationSheet', description='The URL to the Product Information Sheet that provides complete manufacturer-provided efficiency information about an item.')
ErrorParameter ¶
ErrorParameterV3 ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This type contains the name and value of an input parameter that contributed to a specific error or warning condition.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This is the actual value that was passed in for the element specified in the name field.')
ExtendedProducerResponsibility ¶
Bases: EbayModel
eco_participation_fee
class-attribute
instance-attribute
¶
eco_participation_fee = Field(None, alias='ecoParticipationFee', description='This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly. Note: 0 should not be used as a default value. Minimum: 0.0')
producer_product_id
class-attribute
instance-attribute
¶
producer_product_id = Field(None, alias='producerProductId', description='Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts.')
product_documentation_id
class-attribute
instance-attribute
¶
product_documentation_id = Field(None, alias='productDocumentationId', description='Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts.')
product_package_id
class-attribute
instance-attribute
¶
product_package_id = Field(None, alias='productPackageId', description='Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts.')
shipment_package_id
class-attribute
instance-attribute
¶
shipment_package_id = Field(None, alias='shipmentPackageId', description='Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts.')
Fee ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This dollar value in this container is the actual dollar value of the listing fee type specified in the feeType field.')
fee_type
class-attribute
instance-attribute
¶
fee_type = Field(None, alias='feeType', description='The value returned in this field indicates the type of listing fee that the seller may incur if one or more unpublished offers (offers are specified in the call request) are published on the marketplace specified in the marketplaceId field. Applicable listing fees will often include things such as InsertionFee or SubtitleFee , but many fee types will get returned even when they are 0.0 .')
promotional_discount
class-attribute
instance-attribute
¶
promotional_discount = Field(None, alias='promotionalDiscount', description='The dollar value in this container indicates any eBay promotional discount applied toward the listing fee type specified in the feeType field. If there was no discount applied toward the fee, this container is still returned but its value is 0.0 .')
FormatAllocation ¶
Bases: EbayModel
auction
class-attribute
instance-attribute
¶
auction = Field(None, description='This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU.')
fixed_price
class-attribute
instance-attribute
¶
fixed_price = Field(None, alias='fixedPrice', description='This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU.')
FormatTypeEnum ¶
GeoCoordinates ¶
Bases: EbayModel
latitude
class-attribute
instance-attribute
¶
latitude = Field(None, description='The latitude (North-South) component of the geographic coordinate. This field is required if a geoCoordinates container is used. This field is returned if geographical coordinates are set for the location. Example: 33.089805')
longitude
class-attribute
instance-attribute
¶
longitude = Field(None, description='The longitude (East-West) component of the geographic coordinate. This field is required if a geoCoordinates container is used. This field is returned if geographical coordinates are set for the location. Example: -88.709822')
GetInventoryItem ¶
Bases: EbayModel
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='An array of SKU values are passed in under the sku container to retrieve up to 25 inventory item records. Use the getInventoryItems method to retrieve SKU values.')
Hazmat ¶
Bases: EbayModel
component
class-attribute
instance-attribute
¶
component = Field(None, description='This field is used by the seller to provide component information for the listing. For example, component information can provide the specific material of Hazmat concern. Maximum length: 120')
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description="An array of comma-separated string values listing applicable pictogram code(s) for Hazard Pictogram(s). If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard pictograms that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.")
signal_word
class-attribute
instance-attribute
¶
signal_word = Field(None, alias='signalWord', description="This field sets the signal word for hazardous materials in the listing. If your product contains hazardous substances or mixtures, please select a value corresponding to the signal word that is stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.")
statements
class-attribute
instance-attribute
¶
statements = Field(None, description="An array of comma-separated string values specifying applicable statement code(s) for hazard statement(s) for the listing. If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard statements that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.")
Interval ¶
Bases: EbayModel
close
class-attribute
instance-attribute
¶
close = Field(None, description='The close value is actually the time that the store location closes. Local time (in Military format) is used. So, if a store closed at 8 PM local time, the close time would look like the following: 20:00:00 . This field is conditionally required if the intervals container is used to specify working hours or special hours for a store. This field is returned if set for the store location.')
open
class-attribute
instance-attribute
¶
open = Field(None, description='The open value is actually the time that the store opens. Local time (in Military format) is used. So, if a store opens at 9 AM local time, the open time would look like the following: 09:00:00 . This field is conditionally required if the intervals container is used to specify working hours or special hours for a store. This field is returned if set for the store location.')
InventoryItemListing ¶
Bases: EbayModel
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='Upon a successful migration of a listing, eBay auto-generates this unique identifier, and this offer ID value will be used to retrieve and manage the newly-created offer object. This value will only be generated and returned if the eBay listing is migrated successfully.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='This is the seller-defined SKU value associated with the item(s) in a listing. This same SKU value will be used to retrieve and manage the newly-created inventory item object if the listing migration is successful. This SKU value will get returned even if the migration is not successful.')
LengthUnitOfMeasureEnum ¶
ListingDurationEnum ¶
Bases: OpenStrEnum
ListingStatusEnum ¶
Bases: OpenStrEnum
LocaleEnum ¶
Bases: OpenStrEnum
LocationAvailabilityDetails ¶
Bases: EbayModel
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description='The unique identifier of a seller’s fulfillment center location where inventory is available for the item or item variation. Note: When creating a location mapping using the createOrReplaceSkuLocationMapping method, the value entered in this field must be associated with a location with the FULFILLMENT_CENTER location type, or an error will occur.')
LocationMapping ¶
Bases: EbayModel
locations
class-attribute
instance-attribute
¶
locations = Field(None, description='This array represents a collection of fulfillment center locations mapped to a SKU. Note: Only the first 50 locations mapped to a SKU will be considered when calculating estimated delivery dates. Sellers can set up more than 50 locations using this method, but only the first 50 locations will be considered for calculating the estimates.')
Manufacturer ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description="The first line of the product manufacturer's street address. Maximum length : 180 characters")
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Maximum length : 180 characters")
city
class-attribute
instance-attribute
¶
city = Field(None, description="The city of the product manufacturer's street address. Maximum length : 64 characters")
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The company name of the product manufacturer. Maximum length : 100 characters')
contact_url
class-attribute
instance-attribute
¶
contact_url = Field(None, alias='contactUrl', description='The contact URL of the product manufacturer. Maximum length : 250 characters')
country
class-attribute
instance-attribute
¶
country = Field(None, description='This defines the list of valid country codes, adapted from ISO 3166-1 country codes. List elements take the form of a two-letter code (Alpha-2), a three-letter code (Alpha-3), and a three-digit code (Numeric). For example, the entry for Japan includes JP, JPN, 392. Short codes provide uniform recognition, avoiding language-dependent country names.')
email
class-attribute
instance-attribute
¶
email = Field(None, description="The product manufacturer's business email address. Maximum length : 180 characters")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The product manufacturer's business phone number. Maximum length : 64 characters")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal code of the product manufacturer's street address. Maximum length : 9 characters")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description="The state or province of the product manufacturer's street address. Maximum length : 64 characters")
MarketplaceEnum ¶
Bases: OpenStrEnum
MigrateListing ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing to migrate to the new Inventory model. In the Trading API, this field is known as the ItemID . Up to five unique eBay listings may be specified here in separate listingId fields. The seller should make sure that each of these listings meet the requirements that are stated at the top of this Call Reference page.')
MinimumAdvertisedPriceHandlingEnum ¶
NameValueList ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description="This string value identifies the motor vehicle aspect, such as 'make', 'model', 'year', 'trim', and 'engine'. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.")
value
class-attribute
instance-attribute
¶
value = Field(None, description="This string value identifies the motor vehicle aspect specified in the corresponding name field. For example, if the name field is 'make', this field may be 'Toyota', or if the name field is 'model', this field may be 'Camry'. The getCompatibilityPropertyValues method of the Taxonomy API can be used to retrieve possible values for vehicle aspect names.")
OfferKeyWithId ¶
Bases: EbayModel
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='The unique identifier of an unpublished offer for which expected listing fees will be retrieved. One to 250 offerId values can be passed in to the offers container for one getListingFees call. Use the getOffers method to retrieve offer IDs. Note: Errors will occur if offerId values representing published offers are passed in.')
OfferKeysWithId ¶
Bases: EbayModel
offers
class-attribute
instance-attribute
¶
offers = Field(None, description='This container is used to identify one or more (up to 250) unpublished offers for which expected listing fees will be retrieved. The user passes one or more offerId values (maximum of 250) in to this container to identify the unpublished offers in which to retrieve expected listing fees. This call is only applicable for offers in the unpublished state.')
OfferPriceQuantity ¶
Bases: EbayModel
available_quantity
class-attribute
instance-attribute
¶
available_quantity = Field(None, alias='availableQuantity', description='This field is used if the seller wants to modify the current quantity of the inventory item that will be available for purchase in the offer (identified by the corresponding offerId value). This value represents the quantity of the item that is available in the marketplace specified within the offer, not the total quantity available.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='This field is the unique identifier of the offer. If an offers container is used to update one or more offers associated to a specific inventory item, the offerId value is required in order to identify the offer to update with a modified price and/or quantity.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='This container is used if the seller wants to modify the current price of the inventory item. The dollar value set here will be the new price of the inventory item in the offer (identified by the corresponding offerId value). Either the availableQuantity field or the price container is required, but not necessarily both.')
OfferStatusEnum ¶
OperatingHours ¶
Bases: EbayModel
day_of_week_enum
class-attribute
instance-attribute
¶
day_of_week_enum = Field(None, alias='dayOfWeekEnum', description='A dayOfWeekEnum value is required for each day of the week that the store location has regular operating hours. This field is returned if operating hours are defined for the store location.')
intervals
class-attribute
instance-attribute
¶
intervals = Field(None, description="This container is used to define the opening and closing times of a store location's working day (defined in the dayOfWeekEnum field). An intervals container is needed for each day of the week that the store location is open.")
Overrides ¶
Bases: EbayModel
cut_off_time
class-attribute
instance-attribute
¶
cut_off_time = Field(None, alias='cutOffTime', description='This field is used to override the cut-off time(s) specified in the weeklySchedule container. If an order is placed after this time in the specified date or date range, it will be handled by the seller on the following day. Format: 00:00')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The end date of the cut-off time override in ISO 8601 format, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Note: If the cut-off time override is only for a single day, input the same date in the startDate and endDate fields. Format: [YYYY]-[MM]-[DD] Example: 2024-08-06 Note: The time zone for this date is specified from the timeZoneId field.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The start date of the cut-off time override in ISO 8601 format, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Note: If the cut-off time override is only for a single day, input the same date in the startDate and endDate fields. Format: [YYYY]-[MM]-[DD] Example: 2024-08-04 Note: The time zone for this date is specified from the timeZoneId field.')
PackageTypeEnum ¶
Bases: OpenStrEnum
expandable_tough_bags
class-attribute
instance-attribute
¶
expandable_tough_bags = 'EXPANDABLE_TOUGH_BAGS'
large_canada_postbox
class-attribute
instance-attribute
¶
large_canada_postbox = 'LARGE_CANADA_POSTBOX'
large_canada_post_bubble_mailer
class-attribute
instance-attribute
¶
large_canada_post_bubble_mailer = 'LARGE_CANADA_POST_BUBBLE_MAILER'
medium_canada_post_box
class-attribute
instance-attribute
¶
medium_canada_post_box = 'MEDIUM_CANADA_POST_BOX'
medium_canada_post_bubble_mailer
class-attribute
instance-attribute
¶
medium_canada_post_bubble_mailer = 'MEDIUM_CANADA_POST_BUBBLE_MAILER'
package_thick_envelope
class-attribute
instance-attribute
¶
package_thick_envelope = 'PACKAGE_THICK_ENVELOPE'
parcel_or_padded_envelope
class-attribute
instance-attribute
¶
parcel_or_padded_envelope = 'PARCEL_OR_PADDED_ENVELOPE'
small_canada_post_box
class-attribute
instance-attribute
¶
small_canada_post_box = 'SMALL_CANADA_POST_BOX'
small_canada_post_bubble_mailer
class-attribute
instance-attribute
¶
small_canada_post_bubble_mailer = 'SMALL_CANADA_POST_BUBBLE_MAILER'
usps_flat_rate_envelope
class-attribute
instance-attribute
¶
usps_flat_rate_envelope = 'USPS_FLAT_RATE_ENVELOPE'
Product ¶
Bases: EbayModel
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='This is a collection of item specifics (aka product aspects) name-value pairs that provide more information about the product and might make it easier for buyers to find. To view required/recommended product aspects/item specifics names (and corresponding values) for a specific eBay category, sellers can use the getItemAspectsForCategory method of the Taxonomy API.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The brand of the product. This field is often paired with the mpn field to identify a specific product by Manufacturer Part Number. This field is conditionally required if the eBay category requires a Manufacturer Part Number (MPN) value.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the product. The description of an existing inventory item can be added or modified with a createOrReplaceInventoryItem call. The description of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.')
ean
class-attribute
instance-attribute
¶
ean = Field(None, description='The European Article Number/International Article Number (EAN) for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='The eBay Product Identifier (ePID) for the product. This field can be used to directly identify an eBay Catalog product.')
image_urls
class-attribute
instance-attribute
¶
image_urls = Field(None, alias='imageUrls', description='An array of one or more links to images for the product. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures call will contain a full URL to the image on an eBay Picture Server.')
isbn
class-attribute
instance-attribute
¶
isbn = Field(None, description='The International Standard Book Number (ISBN) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog.')
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description='The Manufacturer Part Number (MPN) of a product. This field is paired with the brand field to identify a product. Some eBay categories require MPN values. The getItemAspectsForCategory method in the Taxonomy API can be used to see if a category requires an MPN.')
subtitle
class-attribute
instance-attribute
¶
subtitle = Field(None, description='A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the Adding a subtitle to your listings help page.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of an inventory item can be added or modified with a createOrReplaceInventoryItem call. Although not immediately required, a title will be needed before an offer with the inventory item is published.')
upc
class-attribute
instance-attribute
¶
upc = Field(None, description='The Universal Product Code (UPC) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog.')
video_ids
class-attribute
instance-attribute
¶
video_ids = Field(None, alias='videoIds', description='An array of one or more videoId values for the product. A video ID is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API . For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to Managing videos .')
ProductFamilyProperties ¶
Bases: EbayModel
engine
class-attribute
instance-attribute
¶
engine = Field(None, description='Important! The productFamilyProperties container is no longer supported.')
make
class-attribute
instance-attribute
¶
make = Field(None, description='Important! The productFamilyProperties container is no longer supported.')
model
class-attribute
instance-attribute
¶
model = Field(None, description='Important! The productFamilyProperties container is no longer supported.')
trim
class-attribute
instance-attribute
¶
trim = Field(None, description='Important! The productFamilyProperties container is no longer supported.')
year
class-attribute
instance-attribute
¶
year = Field(None, description='Important! The productFamilyProperties container is no longer supported.')
ProductIdentifier ¶
Bases: EbayModel
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='This field can be used if the seller already knows the eBay catalog product ID (ePID) associated with the motor vehicle that is to be added to the compatible product list. If this eBay catalog product ID is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle.')
gtin
class-attribute
instance-attribute
¶
gtin = Field(None, description='This field can be used if the seller knows the Global Trade Item Number for the motor vehicle that is to be added to the compatible product list. If this GTIN value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim will automatically get picked up for that motor vehicle. Note: This field is for future use.')
ktype
class-attribute
instance-attribute
¶
ktype = Field(None, description='This field can be used if the seller knows the K Type Number for the motor vehicle that is to be added to the compatible product list. If this K Type value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle.')
ProductSafety ¶
Bases: EbayModel
component
class-attribute
instance-attribute
¶
component = Field(None, description="This field is used by the seller to provide product safety component information for the listing. For example, component information can include specific warnings related to product safety, such as 'Tipping hazard'.")
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description='An array of comma-separated string values used to provide product safety pictogram(s) for the listing. If your product shows universal product safety or compliance symbols, please select the values corresponding to the product safety pictograms for display in the product safety section of the listing. The seller specifies the identifier of each pictogram in this field.')
statements
class-attribute
instance-attribute
¶
statements = Field(None, description='An array of comma-separated string values used to provide product safety statement(s) for the listing. If your product shows universal product safety or compliance warnings, please select the values corresponding to the product safety statements for display in the product safety section of the listing. The seller specifies the identifier of each statement in this field.')
PublishByInventoryItemGroupRequest ¶
Bases: EbayModel
inventory_item_group_key
class-attribute
instance-attribute
¶
inventory_item_group_key = Field(None, alias='inventoryItemGroupKey', description='This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the publishByInventoryItemGroup call is successful. The inventoryItemGroupKey identifier is automatically generated by eBay once an inventory item group is created.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The marketplaceId enumeration values are found in MarketplaceEnum .')
RegionalProductCompliancePolicies ¶
Bases: EbayModel
country_policies
class-attribute
instance-attribute
¶
country_policies = Field(None, alias='countryPolicies', description='The array of country-specific product compliance policies to be used by an offer when it is published and converted to a listing.')
RegionalTakeBackPolicies ¶
Bases: EbayModel
country_policies
class-attribute
instance-attribute
¶
country_policies = Field(None, alias='countryPolicies', description='The array of country-specific take-back policies to be used by an offer when it is published and converted to a listing.')
ResponsiblePersonTypeEnum ¶
Bases: OpenStrEnum
eu_responsible_person
class-attribute
instance-attribute
¶
eu_responsible_person = 'EU_RESPONSIBLE_PERSON'
ShippingServiceTypeEnum ¶
SoldOnEnum ¶
SpecialHours ¶
Bases: EbayModel
date
class-attribute
instance-attribute
¶
date = Field(None, description='A date value is required for each specific date that the store location has special operating hours or is closed for that date. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2025-08-04T00:00:00.000Z This field is returned if set for the store location.')
intervals
class-attribute
instance-attribute
¶
intervals = Field(None, description='This array is used to set the operating hours for the date specified in the corresponding date field. These special operating hours on this specific date will override the normal operating hours for that day of the week that is specified through the operatingHours array. To specify a location as closed on the corresponding date , include the intervals array as empty.')
Specification ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This is the name of product variation aspect. Typically, for clothing, typical aspect names are "Size" and "Color" . Product variation aspects are not required immediately upon creating an inventory item group, but these aspects will be required before a multiple-variation listing containing this inventory item group is published.')
values
class-attribute
instance-attribute
¶
values = Field(None, description='This is an array of values pertaining to the corresponding product variation aspect (specified in the name field).')
StatusEnum ¶
StoreTypeEnum ¶
Tax ¶
Bases: EbayModel
apply_tax
class-attribute
instance-attribute
¶
apply_tax = Field(None, alias='applyTax', description="When set to true , the seller's account-level sales-tax table will be used to calculate sales tax for an order. Note: Sales-tax tables are available only for the US and Canada marketplaces. Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC.")
third_party_tax_category
class-attribute
instance-attribute
¶
third_party_tax_category = Field(None, alias='thirdPartyTaxCategory', description='The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com .')
vat_percentage
class-attribute
instance-attribute
¶
vat_percentage = Field(None, alias='vatPercentage', description="This value is the Value Add Tax (VAT) rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price.")
TimeDurationUnitEnum ¶
Bases: OpenStrEnum
VariesBy ¶
Bases: EbayModel
aspects_image_varies_by
class-attribute
instance-attribute
¶
aspects_image_varies_by = Field(None, alias='aspectsImageVariesBy', description='This container is used if the seller wants to include multiple images to demonstrate how variations within a multiple-variation listing differ. In this string field, the seller will specify the product aspect where the variations of the inventory item group vary, such as color.')
specifications
class-attribute
instance-attribute
¶
specifications = Field(None, description='This container consists of an array of one or more product aspects where each variation differs, and values for each of those product aspects. This container is not immediately required, but will be required before the first offer of the inventory item group is published.')
Version ¶
WeeklySchedule ¶
Bases: EbayModel
cut_off_time
class-attribute
instance-attribute
¶
cut_off_time = Field(None, alias='cutOffTime', description='This field specifies the cut-off times (in 24-hour format) for the business day(s) specified in the dayOfWeekEnum array. Cut-off times default to the time zone of the specified address if the timeZoneId is not provided. Note: If cut-off hours are not specified for a particular day, the fulfillment center is considered to be on holiday for that day. Format: 00:00')
day_of_week_enum
class-attribute
instance-attribute
¶
day_of_week_enum = Field(None, alias='dayOfWeekEnum', description='This comma-separated array defines the days of week for which the specified cutOffTime is used.')
WeightUnitOfMeasureEnum ¶
WithdrawByInventoryItemGroupRequest ¶
Bases: EbayModel
inventory_item_group_key
class-attribute
instance-attribute
¶
inventory_item_group_key = Field(None, alias='inventoryItemGroupKey', description='This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for supported values.')
Address ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of a street address. This field is required for store and fulfillment center locations. A street address is not required for warehouse locations. This field will be returned if defined for an inventory location. Maximum length : 128')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of a street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for an inventory location. Maximum length : 128')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city in which the inventory location resides. This field is required for store and fulfillment center locations. For warehouse locations, this field is conditionally required as part of a city and stateOrProvince pair if a postalCode is not provided. If a postalCode is provided, the city is derived from the provided postal code and this field is technically optional.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The country in which the address resides, represented as two-letter ISO 3166 country code. For example, US represents the United States, and DE represents Germany.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county in which the address resides. This field is returned if defined for an inventory location.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal/zip code of the address. eBay uses postal codes to surface In-Store Pickup items within the vicinity of a buyer's location, and it also uses postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. This field is required for store and fulfillment center locations.")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state/province in which the inventory location resides. This field is required for store and fulfillment center locations. For warehouse locations, this field is conditionally required as part of a city and stateOrProvince pair if a postalCode is not provided. If a postalCode is provided, the state or province is derived from the provided zip code and this field is technically optional.')
BulkGetInventoryItem ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='The seller passes in multiple SKU values under this container to retrieve multiple inventory item records. Up to 25 inventory item records can be retrieved at one time.')
BulkMigrateListing ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This is the base container of the bulkMigrateListings request payload. One to five eBay listings will be included under this container.')
BulkOffer ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This container is used to pass in an array of offers to publish. Up to 25 offers can be published with one bulkPublishOffer method.')
CompatibleProduct ¶
Bases: EbayModel
compatibility_properties
class-attribute
instance-attribute
¶
compatibility_properties = Field(None, alias='compatibilityProperties', description='This container consists of an array of motor vehicles that are compatible with the motor vehicle part or accessory specified by the SKU value in the call URI. Each motor vehicle is defined through a separate set of name/value pairs.')
notes
class-attribute
instance-attribute
¶
notes = Field(None, description='This field is used by the seller to input any notes pertaining to the compatible vehicle list being defined. The seller might use this field to specify the placement of the part on a vehicle or other applicable information. This field will only be returned if specified by the seller. Maximum length : 500')
product_family_properties
class-attribute
instance-attribute
¶
product_family_properties = Field(None, alias='productFamilyProperties', description='Important! The productFamilyProperties container is deprecated and should no longer be used. The compatibilityProperties container should be used instead.')
product_identifier
class-attribute
instance-attribute
¶
product_identifier = Field(None, alias='productIdentifier', description='This container is used in a createOrReplaceProductCompatibility call to identify a motor vehicle that is compatible with the inventory item.')
Dimension ¶
Bases: EbayModel
height
class-attribute
instance-attribute
¶
height = Field(None, description='The actual height (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.')
length
class-attribute
instance-attribute
¶
length = Field(None, description='The actual length (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.')
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='The unit of measurement used to specify the dimensions of a shipping package. All fields of the dimensions container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are FEET and INCH . If the metric system of measurement is being used, the applicable values for weight units are METER and CENTIMETER .')
width
class-attribute
instance-attribute
¶
width = Field(None, description='The actual width (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.')
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 domain in which the error or warning occurred.')
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 one or more reference IDs which identify the specific request element(s) 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 to do 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 one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='Various warning and error messages return one or more variables that contain 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.')
FeeSummary ¶
Bases: EbayModel
fees
class-attribute
instance-attribute
¶
fees = Field(None, description='This container is an array of listing fees that can be expected to be applied to an offer on the specified eBay marketplace ( marketplaceId value). Many fee types will get returned even when they are 0.0 . See the Standard selling fees help page for more information on listing fees.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This is the unique identifier of the eBay site for which listing fees for the offer are applicable.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.')
FeesSummaryResponse ¶
Bases: EbayModel
fee_summaries
class-attribute
instance-attribute
¶
fee_summaries = Field(None, alias='feeSummaries', description='This container consists of an array of one or more listing fees that the seller can expect to pay for unpublished offers specified in the call request. Many fee types will get returned even when they are 0.0 .')
InventoryItemGroup ¶
Bases: EbayModel
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='This is a collection of item specifics (aka product aspects) name-value pairs that are shared by all product variations within the inventory item group. Common aspects for the inventory item group are not immediately required upon creating an inventory item group, but these aspects will be required before the first offer of the group is published.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the inventory item group. This description should fully describe the product and the variations of the product that are available in the inventory item group, since this description will ultimately become the listing description once the first offer of the group is published.')
image_urls
class-attribute
instance-attribute
¶
image_urls = Field(None, alias='imageUrls', description='An array of one or more links to images for the inventory item group. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures call will contain a full URL to the image on an eBay Picture Server.')
inventory_item_group_key
class-attribute
instance-attribute
¶
inventory_item_group_key = Field(None, alias='inventoryItemGroupKey', description='This is the unique identifier of the inventory item group. This identifier is created by the seller when an inventory item group is created. Note: This field is only applicable to the getInventoryItemGroup call and not to the createOrReplaceInventoryItemGroup call. In the createOrReplaceInventoryItemGroup call, the inventoryItemGroupKey value is passed into the end of the call URI instead.')
subtitle
class-attribute
instance-attribute
¶
subtitle = Field(None, description='A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the Adding a subtitle to your listings help page.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of the inventory item group. This title will ultimately become the listing title once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published.')
variant_sk_us
class-attribute
instance-attribute
¶
variant_sk_us = Field(None, alias='variantSKUs', description='This required container is used to assign individual inventory items to the inventory item group. Multiple SKU values are passed in to this container. If updating an existing inventory item group, the seller should make sure that all member SKU values are passed in, as long as the seller wants that SKU to remain in the group.')
varies_by
class-attribute
instance-attribute
¶
varies_by = Field(None, alias='variesBy', description='This container is used to specify product aspects for which variations within an inventory item group vary, and a complete list of all those variances. For example, t-shirts in an inventory item group may be available in multiple sizes and colors.')
video_ids
class-attribute
instance-attribute
¶
video_ids = Field(None, alias='videoIds', description='An array of one or more videoId values for the inventory item group. A video ID is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API . For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to Managing videos .')
InventoryItemResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there were one or more errors associated with the creation or update to the inventory item record.')
locale
class-attribute
instance-attribute
¶
locale = Field(None, description='This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE).')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The HTTP status code returned in this field indicates the success or failure of creating or updating the inventory item record for the inventory item indicated in the sku field. See the HTTP status codes table to see which each status code indicates.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned if there were one or more warnings associated with the creation or update to the inventory item record.')
ListingDetails ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing that is associated with the published offer.')
listing_on_hold
class-attribute
instance-attribute
¶
listing_on_hold = Field(None, alias='listingOnHold', description='Indicates if a listing is on hold due to an eBay policy violation. If a listing is put on hold, users are unable to view the listing details, the listing is hidden from search, and all attempted purchases, offers, and bids for the listing are blocked. eBay, however, gives sellers the opportunity to address violations and get listings fully reinstated.')
listing_status
class-attribute
instance-attribute
¶
listing_status = Field(None, alias='listingStatus', description='The enumeration value returned in this field indicates the status of the listing that is associated with the published offer.')
sold_quantity
class-attribute
instance-attribute
¶
sold_quantity = Field(None, alias='soldQuantity', description='This integer value indicates the quantity of the product that has been sold for the published offer.')
Location ¶
Bases: EbayModel
address
class-attribute
instance-attribute
¶
address = Field(None, description='The address container is always returned in getInventoryLocation / getInventoryLocations calls. Except in the case of a store or fulfillment center location, a full address is not a requirement when setting up an inventory location.')
geo_coordinates
class-attribute
instance-attribute
¶
geo_coordinates = Field(None, alias='geoCoordinates', description='This container displays the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. This container is only returned if the geo-coordinates are set for an inventory location.')
location_id
class-attribute
instance-attribute
¶
location_id = Field(None, alias='locationId', description='A unique eBay-assigned ID for the location. Note: This field should not be confused with the seller-defined merchantLocationKey value. It is the merchantLocationKey value which is used to identify an inventory location when working with inventory location API calls. The locationId value is only used internally by eBay.')
LocationDetails ¶
Bases: EbayModel
address
class-attribute
instance-attribute
¶
address = Field(None, description='This required container sets the physical address of an inventory location. Except in the case store or fulfillment center location, a full address is not a requirement when setting up a location. For warehouse locations, the fields required in this container are either of the following sets: city , stateOrProvince , and country postalCode and country')
geo_coordinates
class-attribute
instance-attribute
¶
geo_coordinates = Field(None, alias='geoCoordinates', description='This container is used to set the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. Geographical coordinates are required for the location of In-Store Pickup inventory.')
MigrateListingResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='If one or more errors occur with the attempt to migrate the listing, this container will be returned with detailed information on each error.')
inventory_item_group_key
class-attribute
instance-attribute
¶
inventory_item_group_key = Field(None, alias='inventoryItemGroupKey', description='This field will only be returned for a multiple-variation listing that the seller attempted to migrate. Its value is auto-generated by eBay.')
inventory_items
class-attribute
instance-attribute
¶
inventory_items = Field(None, alias='inventoryItems', description='This container exists of an array of SKU values and offer IDs. For single-variation listings, this will only be one SKU value and one offer ID (if listing was successfully migrated), but multiple SKU values and offer IDs will be returned for multiple-variation listings.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing that the seller attempted to migrate.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This is the unique identifier of the eBay Marketplace where the listing resides. The value fo the eBay US site will be EBAY_US .')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='This field is returned for each listing that the seller attempted to migrate. See the HTTP status codes table to see which each status code indicates.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='If one or more warnings occur with the attempt to migrate the listing, this container will be returned with detailed information on each warning. It is possible that a listing can be successfully migrated even if a warning occurs.')
OfferResponse ¶
Bases: EbayModel
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='The unique identifier of the offer that was just created with a createOffer call. It is not returned if the createOffer call fails to create an offer. This identifier will be needed for many offer-related calls. Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.')
OfferResponseWithListingId ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there were one or more errors associated with publishing the offer.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the newly-created eBay listing. This field is only returned if the seller successfully published the offer and created the new eBay listing.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='The unique identifier of the offer that the seller published (or attempted to publish).')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The HTTP status code returned in this field indicates the success or failure of publishing the offer specified in the offerId field. See the HTTP status codes table to see which each status code indicates.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned if there were one or more warnings associated with publishing the offer.')
OfferSkuResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned at the offer level, and will contain one or more errors if any occurred with the attempted creation of the corresponding offer.')
format
class-attribute
instance-attribute
¶
format = Field(None, description='This enumeration value indicates the listing format of the offer.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This enumeration value is the unique identifier of the eBay marketplace for which the offer will be made available. This enumeration value should be the same for all offers since the bulkCreateOffer method can only be used to create offers for one eBay marketplace at a time.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='The unique identifier of the newly-created offer. This identifier should be automatically created by eBay if the creation of the offer was successful. It is not returned if the creation of the offer was not successful. In which case, the user may want to scan the corresponding errors and/or warnings container to see what the issue may be.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The sku value is required for each product offer that the seller is trying to create, and it is always returned to identified the product that is associated with the offer.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The integer value returned in this field is the http status code. If an offer is created successfully, the value returned in this field should be 200 . A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkCreateOffer method.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned at the offer level, and will contain one or more warnings if any occurred with the attempted creation of the corresponding offer. Note that it is possible that an offer can be created successfully even if one or more warnings are triggered.')
PriceQuantityResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This array will be returned if there were one or more errors associated with the update to the offer or inventory item record.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description="The unique identifier of the offer that was updated. This field will not be returned in situations where the seller is only updating the total 'ship-to-home' quantity of an inventory item record.")
sku
class-attribute
instance-attribute
¶
sku = Field(None, description="This is the seller-defined SKU value of the product. This field is returned whether the seller attempted to update an offer with the SKU value or just attempted to update the total 'ship-to-home' quantity of an inventory item record. Maximum length : 50")
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description="The value returned in this container will indicate the status of the attempt to update the price and/or quantity of the offer (specified in the corresponding offerId field) or the attempt to update the total 'ship-to-home' quantity of an inventory item (specified in the corresponding sku field).")
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This array will be returned if there were one or more warnings associated with the update to the offer or inventory item record.')
PricingSummary ¶
Bases: EbayModel
auction_reserve_price
class-attribute
instance-attribute
¶
auction_reserve_price = Field(None, alias='auctionReservePrice', description='This field indicates the lowest price at which the seller is willing to sell an item through an auction listing. Note that setting a Reserve Price will incur a listing fee of $5 or 7.5% of the Reserve Price, whichever is greater. The minimum fee is $5. Important: This fee is charged regardless of whether or not the item is sold.')
auction_start_price
class-attribute
instance-attribute
¶
auction_start_price = Field(None, alias='auctionStartPrice', description='This field indicates the minimum bidding price for the auction. The bidding starts at this price. Note: If the auctionReservePrice is also specified, the value of auctionStartPrice must be lower than the value of auctionReservePrice .')
minimum_advertised_price
class-attribute
instance-attribute
¶
minimum_advertised_price = Field(None, alias='minimumAdvertisedPrice', description='This container is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can only offer prices below this price through the use of other discounts.')
originally_sold_for_retail_price_on
class-attribute
instance-attribute
¶
originally_sold_for_retail_price_on = Field(None, alias='originallySoldForRetailPriceOn', description='This field is needed if the Strikethrough Pricing (STP) feature will be used in the offer. This field indicates that the product was sold for the price in the originalRetailPrice field on an eBay site, or sold for that price by a third-party retailer.')
original_retail_price
class-attribute
instance-attribute
¶
original_retail_price = Field(None, alias='originalRetailPrice', description='This container is needed if the Strikethrough Pricing (STP) feature will be used in the offer. The dollar value passed into this field indicates the original retail price set by the manufacturer (OEM). eBay does not maintain or validate the value supplied here by the seller. The dollar value in this field should always be more than the dollar value in the price container.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='This is the listing price of the product. A listing price must be specified before publishing an offer, but it is possible to create an offer without a price. For published offers, this container will always be returned, but for unpublished offers, this container will only be returned if set for the offer.')
pricing_visibility
class-attribute
instance-attribute
¶
pricing_visibility = Field(None, alias='pricingVisibility', description='This field is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. This field is only applicable if an eligible US seller is using the Minimum Advertised Price (MAP) feature and a minimumAdvertisedPrice has been specified.')
PublishResponse ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the newly created eBay listing. This field is returned if the single offer (if publishOffer call was used) or group of offers in an inventory item group (if publishOfferByInventoryItemGroup call was used) was successfully converted into an eBay listing.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will contain an array of errors and/or warnings if any occur when a publishOffer or publishOfferByInventoryItemGroup call is made.')
ResponsiblePerson ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description="The first line of the Responsible Person's street address. Maximum length : 180 characters")
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Maximum length : 180 characters")
city
class-attribute
instance-attribute
¶
city = Field(None, description="The city of the Responsible Person's street address. Maximum length : 64 characters")
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The name of the Responsible Person or entity. Maximum length : 100 characters')
contact_url
class-attribute
instance-attribute
¶
contact_url = Field(None, alias='contactUrl', description='The contact URL of the Responsible Person or entity. Maximum length : 250 characters')
country
class-attribute
instance-attribute
¶
country = Field(None, description='This defines the list of valid country codes, adapted from ISO 3166-1 country codes. List elements take the form of a two-letter code (Alpha-2), a three-letter code (Alpha-3), and a three-digit code (Numeric). For example, the entry for Japan includes JP, JPN, 392. Short codes provide uniform recognition, avoiding language-dependent country names.')
email
class-attribute
instance-attribute
¶
email = Field(None, description="The Responsible Person's email address. Maximum length : 180 characters")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The Responsible Person's business phone number. Maximum length : 64 characters")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal code of the Responsible Person's street address. Maximum length : 9 characters")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description="The state of province of the Responsible Person's street address. Maximum length : 64 characters")
types
class-attribute
instance-attribute
¶
types = Field(None, description='The type(s) associated with the Responsible Person or entity. Note: Currently, the only supported value is EUResponsiblePerson .')
SameDayShippingCutOffTimes ¶
Bases: EbayModel
overrides
class-attribute
instance-attribute
¶
overrides = Field(None, description='This container can be used to override the existing cut-off time(s), specified in the weeklySchedule container, for a specific date or date range.')
weekly_schedule
class-attribute
instance-attribute
¶
weekly_schedule = Field(None, alias='weeklySchedule', description='This container is used to specify the weekly schedule for shipping and handling cut-off times. A cut-off time is required for each business day that the fulfillment center operates. Any orders made after the specified cutOffTime on the specified day(s) of the week will be handled on the next day.')
ShippingCostOverride ¶
Bases: EbayModel
additional_shipping_cost
class-attribute
instance-attribute
¶
additional_shipping_cost = Field(None, alias='additionalShippingCost', description='The dollar value passed into this field will override the additional shipping cost that is currently set for the applicable shipping service option. The "Additional shipping cost" is the cost to ship each additional identical product to the buyer using the corresponding shipping service.')
priority
class-attribute
instance-attribute
¶
priority = Field(None, description='The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='The dollar value passed into this field will override the shipping cost that is currently set for the applicable shipping service option. This value will be the cost to ship one item to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values.')
shipping_service_type
class-attribute
instance-attribute
¶
shipping_service_type = Field(None, alias='shippingServiceType', description='This enumerated value indicates whether the shipping service specified in the priority field is a domestic or an international shipping service option.')
surcharge
class-attribute
instance-attribute
¶
surcharge = Field(None, description='Note: DO NOT USE THIS FIELD. Shipping surcharges for shipping service options can no longer be set with fulfillment business policies. To set a shipping surcharge for a shipping service option, only the Shipping rate tables tool in My eBay can be used. The dollar value passed into this field will override the shipping surcharge that is currently set for the applicable shipping service option.')
TimeDuration ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='This enumeration value indicates the time unit used to specify the fulfillment time, such as BUSINESS_DAY .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time. For standard orders that will be shipped, this value will indicate the expected fulfillment time if the inventory item is shipped from the inventory location.')
Weight ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE . If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The actual weight (in the measurement unit specified in the unit field) of the shipping package. Both the unit and value fields are required if the weight container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: "weight": { "value": 20.5, "unit": "OUNCE" }')
WithdrawResponse ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing associated with the offer that was withdrawn. This field will not be returned if the eBay listing was not successfully ended.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer.')
AvailabilityDistribution ¶
Bases: EbayModel
fulfillment_time
class-attribute
instance-attribute
¶
fulfillment_time = Field(None, alias='fulfillmentTime', description='This container is used to indicate the expected fulfillment time if the inventory item is shipped from the warehouse location identified in the corresponding merchantLocationKey field. The fulfillment time is the estimated number of business days after purchase that the buyer can expect the item to be delivered.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description='The unique identifier of an inventory location where quantity is available for the inventory item. This field is conditionally required to identify the inventory location that has quantity of the inventory item. Use the getInventoryLocations method to retrieve merchant location keys.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The integer value passed into this field indicates the quantity of the inventory item that is available at this inventory location. This field is conditionally required.')
BaseResponse ¶
Bases: EbayModel
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned in a call response payload if one or more warnings or errors are triggered when an Inventory API call is made. This container will contain detailed information about the error or warning.')
BulkInventoryItemResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This is the base container of the bulkCreateOrReplaceInventoryItem response. The results of each attempted inventory item creation/update is captured under this container.')
BulkMigrateListingResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This is the base container of the response payload of the bulkMigrateListings call. The results of each attempted listing migration is captured under this container.')
BulkOfferResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This object contains the responses that show the status of each offer that the seller attempted to create with the method call.')
BulkPriceQuantityResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This container will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an errors and/or warnings container if any errors or warnings are triggered while trying to update those offers/inventory items.')
BulkPublishResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A node is returned under the responses container to indicate the success or failure of each offer that the seller was attempting to publish.')
Compatibility ¶
Bases: EbayModel
compatible_products
class-attribute
instance-attribute
¶
compatible_products = Field(None, alias='compatibleProducts', description='This container consists of an array of motor vehicles (make, model, year, trim, engine) that are compatible with the motor vehicle part or accessory specified by the sku value.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined SKU value of the inventory item that will be associated with the compatible vehicles. Note: This field is not applicable to the createOrReplaceProductCompatibility method, as the SKU value for the inventory item is passed in as part of the call URI and not in the request payload. It is always returned with the getProductCompatibility method.')
FulfillmentCenterSpecifications ¶
Bases: EbayModel
same_day_shipping_cut_off_times
class-attribute
instance-attribute
¶
same_day_shipping_cut_off_times = Field(None, alias='sameDayShippingCutOffTimes', description='Note: This container only applies to listings with same-day handling. This container specifies cut-off time(s) for order handling (and optionally cut-off overrides) at a fulfillment center location. For example, if the cut-off time for order handling is 14:00 , any orders made after this time will be handled on the next available business day.')
InventoryLocation ¶
Bases: EbayModel
location
class-attribute
instance-attribute
¶
location = Field(None, description='This container is used to add any addition physical address and geographical coordinate information for a warehouse, store, or fulfillment center inventory location. Note: For warehouse and store inventory locations, address fields can be updated any number of times. For fulfilment center locations, address fields cannot be updated.')
location_additional_information
class-attribute
instance-attribute
¶
location_additional_information = Field(None, alias='locationAdditionalInformation', description='This text field is used by the merchant to provide/update additional information about an inventory location. Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again. Maximum length : 256')
location_instructions
class-attribute
instance-attribute
¶
location_instructions = Field(None, alias='locationInstructions', description='This text field is generally used by the merchant to provide/update special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders.')
location_types
class-attribute
instance-attribute
¶
location_types = Field(None, alias='locationTypes', description='This container is used to update the location type(s) associated with an inventory location.')
location_web_url
class-attribute
instance-attribute
¶
location_web_url = Field(None, alias='locationWebUrl', description='This text field is used by the merchant to provide/update the Website address (URL) associated with the inventory location. The URL that is passed in this field will replace any other URL that may be defined for this field. Maximum length : 512')
name
class-attribute
instance-attribute
¶
name = Field(None, description='This text field is used by the merchant to update the name of the inventory location. This name should be a human-friendly name as it will be in In-Store Pickup and Click and Collect listings. A name is not required for warehouse locations.')
operating_hours
class-attribute
instance-attribute
¶
operating_hours = Field(None, alias='operatingHours', description='This container is used to provide/update the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the location is open.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='This text field is used by the merchant to provide/update the phone number for the inventory location. The phone number that is passed in this field will replace any other phone number that may be defined for this field. Maximum length : 36')
special_hours
class-attribute
instance-attribute
¶
special_hours = Field(None, alias='specialHours', description='This container is used to provide/update the special operating hours for a store location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week.')
time_zone_id
class-attribute
instance-attribute
¶
time_zone_id = Field(None, alias='timeZoneId', description='This field is used to provide/update the time zone of the inventory location being created. This value should be in Olson format (for example America/Vancouver ). For supported values, see Java Supported Zone Ids and Offsets . Note: If specified, this time zone will be used for all hour related fields.')
fulfillment_center_specifications
class-attribute
instance-attribute
¶
fulfillment_center_specifications = Field(None, alias='fulfillmentCenterSpecifications', description="This container is used to update information about a fulfillment center's shipping specifications, such as the weekly cut-off time schedule for order handling and any cut-off overrides.")
InventoryLocationFull ¶
Bases: EbayModel
location
class-attribute
instance-attribute
¶
location = Field(None, description='This required container is used to set the physical address and geographical coordinates of a warehouse, store, or fulfillment center inventory location. A warehouse location only requires the postal code and country OR city, province/state, and country, and does not require a full street address. However, the seller may still supply a full street address for a warehouse location.')
location_additional_information
class-attribute
instance-attribute
¶
location_additional_information = Field(None, alias='locationAdditionalInformation', description='This text field is used by the merchant to provide additional information about an inventory location. Maximum length : 256')
location_instructions
class-attribute
instance-attribute
¶
location_instructions = Field(None, alias='locationInstructions', description='This text field is generally used by the merchant to provide special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders.')
location_types
class-attribute
instance-attribute
¶
location_types = Field(None, alias='locationTypes', description='This container is used to define the function of the inventory location. Typically, an inventory location will serve as a store, warehouse, or fulfillment center, but in some cases, an inventory location may be more than one type. For In-Store Pickup inventory, set StoreTypeEnum to STORE . To utilize the Multi-warehouse program, set StoreTypeEnum to FULFILLMENT_CENTER .')
location_web_url
class-attribute
instance-attribute
¶
location_web_url = Field(None, alias='locationWebUrl', description='This text field is used by the merchant to provide the Website address (URL) associated with the inventory location. Maximum length : 512')
merchant_location_status
class-attribute
instance-attribute
¶
merchant_location_status = Field(None, alias='merchantLocationStatus', description='This field is used to indicate whether the inventory location will be enabled (inventory can be loaded to location) or disabled (inventory cannot be loaded to location). If this field is omitted, a successful createInventoryLocation call will automatically enable the location.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. A name is not required for warehouse locations. For store locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published.')
operating_hours
class-attribute
instance-attribute
¶
operating_hours = Field(None, alias='operatingHours', description='This container is used to express the regular operating hours for a store location during each day of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the store location is open. Although not technically required, this container is highly recommended to be used to specify operating hours for a store location.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='This field is used to specify the phone number for an inventory location. Maximum length : 36')
special_hours
class-attribute
instance-attribute
¶
special_hours = Field(None, alias='specialHours', description='This container is used to express the special operating hours for a store inventory location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week.')
time_zone_id
class-attribute
instance-attribute
¶
time_zone_id = Field(None, alias='timeZoneId', description='This field specifies the time zone of the inventory location being created. This value should be in Olson format (for example America/Vancouver ). For supported values, see Java Supported Zone Ids and Offsets . Note: If specified, this time zone will be used for all hour related fields.')
fulfillment_center_specifications
class-attribute
instance-attribute
¶
fulfillment_center_specifications = Field(None, alias='fulfillmentCenterSpecifications', description="This container is used to specify information about a fulfillment center's shipping specifications, such as the weekly cut-off time schedule for order handling and any cut-off time overrides. Note: This container is required if one of the locationTypes of the inventory location is FULFILLMENT_CENTER , and is not applicable to other location types.")
InventoryLocationResponse ¶
Bases: EbayModel
location
class-attribute
instance-attribute
¶
location = Field(None, description='This container provides location details of an inventory location. The address container will always be returned, but it will not always have a complete street address. Except in the case of a store or fulfillment center location, a full address is not a requirement when setting up an inventory location.')
location_additional_information
class-attribute
instance-attribute
¶
location_additional_information = Field(None, alias='locationAdditionalInformation', description='This text field provides additional information about an inventory location. This field is returned if it is set for the location.')
location_instructions
class-attribute
instance-attribute
¶
location_instructions = Field(None, alias='locationInstructions', description="This text field is used by the merchant to provide special pickup instructions for the store location. This field can help create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field was not set up through a createInventoryLocation or a updateInventoryLocation call, eBay will use the default pickup instructions contained in the merchant's profile.")
location_types
class-attribute
instance-attribute
¶
location_types = Field(None, alias='locationTypes', description='This container defines the function of the inventory location. Typically, a location will serve as a store, warehouse, or fulfillment center, but in some cases, an inventory location may be more than one type.')
location_web_url
class-attribute
instance-attribute
¶
location_web_url = Field(None, alias='locationWebUrl', description='This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the location.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description='The unique identifier of the inventory location. This identifier is set up by the merchant when the location is first created with the createInventoryLocation call.')
merchant_location_status
class-attribute
instance-attribute
¶
merchant_location_status = Field(None, alias='merchantLocationStatus', description='This field indicates whether the inventory location is enabled (inventory can be loaded to location) or disabled (inventory cannot be loaded to location). The merchant can use the enableInventoryLocation call to enable a location in disabled status, or the disableInventoryLocation call to disable a location in enabled status.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. For store inventory locations, this field is not required for the createInventoryLocation call, but a store inventory location must have a defined name value before an In-Store Pickup and Click and Collect enabled offer is published.')
operating_hours
class-attribute
instance-attribute
¶
operating_hours = Field(None, alias='operatingHours', description='This container shows the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container is shown for each day of the week that the location is open.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description='The phone number for an inventory location. This field will typically only be returned for store locations.')
special_hours
class-attribute
instance-attribute
¶
special_hours = Field(None, alias='specialHours', description='This container shows the special operating hours for a store or fulfillment center location on a specific date or dates.')
time_zone_id
class-attribute
instance-attribute
¶
time_zone_id = Field(None, alias='timeZoneId', description='This field specifies the time zone of the inventory location being created. This value should be in Olson format (for example America/Vancouver ). For supported values, see Java Supported Zone Ids and Offsets .')
fulfillment_center_specifications
class-attribute
instance-attribute
¶
fulfillment_center_specifications = Field(None, alias='fulfillmentCenterSpecifications', description="This container provides information about a fulfillment center's shipping specifications, such as the weekly cut-off time schedule for order handling and any cut-off time overrides. Note: This field is only returned for fulfillment center locations.")
ListingPolicies ¶
Bases: EbayModel
best_offer_terms
class-attribute
instance-attribute
¶
best_offer_terms = Field(None, alias='bestOfferTerms', description="This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the bestOfferEnabled field to true , and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds. Note: Best Offer is unavailable for multi-variation listings.")
e_bay_plus_if_eligible
class-attribute
instance-attribute
¶
e_bay_plus_if_eligible = Field(None, alias='eBayPlusIfEligible', description='This field is included in an offer and set to true if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delivery of the item, and the buyers must have an eBay Plus subscription to be eligible to receive the benefits of this program, which are free, next-day delivery, as well as free returns.')
fulfillment_policy_id
class-attribute
instance-attribute
¶
fulfillment_policy_id = Field(None, alias='fulfillmentPolicyId', description='This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillment-related settings for the eBay listing. Business policies are not immediately required for offers, but are required before an offer can be published.')
payment_policy_id
class-attribute
instance-attribute
¶
payment_policy_id = Field(None, alias='paymentPolicyId', description='This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related settings for the eBay listing. Business policies are not immediately required for offers, but are required before an offer can be published.')
product_compliance_policy_ids
class-attribute
instance-attribute
¶
product_compliance_policy_ids = Field(None, alias='productCompliancePolicyIds', description='This field contains the array of unique identifiers indicating the seller-created global product compliance policies that will be used once an offer is published and converted to a listing. Product compliance policies provide buyers with important information and disclosures about products.')
regional_product_compliance_policies
class-attribute
instance-attribute
¶
regional_product_compliance_policies = Field(None, alias='regionalProductCompliancePolicies', description='A comma-delimited list of unique identifiers indicating the seller-created country-specific product compliance policies that that will be used once an offer is published and converted to a listing. Product compliance policies provide buyers with important information and disclosures about products.')
regional_take_back_policies
class-attribute
instance-attribute
¶
regional_take_back_policies = Field(None, alias='regionalTakeBackPolicies', description='The list of unique identifiers indicating the seller-created country-specific take-back policies that will be used once an offer is published and converted to a listing. The law in some countries may require sellers to take back a used product when the buyer buys a new product.')
return_policy_id
class-attribute
instance-attribute
¶
return_policy_id = Field(None, alias='returnPolicyId', description='This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settings for the eBay listing.')
shipping_cost_overrides
class-attribute
instance-attribute
¶
shipping_cost_overrides = Field(None, alias='shippingCostOverrides', description='This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To override the costs of a specific domestic or international shipping service option, the seller must know the priority/order of that shipping service in the fulfillment listing policy.')
take_back_policy_id
class-attribute
instance-attribute
¶
take_back_policy_id = Field(None, alias='takeBackPolicyId', description='This unique identifier indicates the seller-created global take-back policy that will be used once an offer is published and converted to a listing. One (1) global take-back policy may be specified per offer . Note: For countries that support country-specific policies, use regionalTakeBackPolicies to apply them to an offer.')
LocationResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the current page of results from the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of items returned on a single page from the result set.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Maximum length : 2048')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value is set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Maximum length : 2048')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0 .')
locations
class-attribute
instance-attribute
¶
locations = Field(None, description="An array of one or more of the merchant's inventory locations.")
PackageWeightAndSize ¶
Bases: EbayModel
dimensions
class-attribute
instance-attribute
¶
dimensions = Field(None, description='This container is used to indicate the length, width, and height of the shipping package that will be used to ship the inventory item. The dimensions of a shipping package are needed when calculated shipping is used. This container will be returned if package dimensions are set for the inventory item.')
package_type
class-attribute
instance-attribute
¶
package_type = Field(None, alias='packageType', description='This enumeration value indicates the type of shipping package used to ship the inventory item. The supported values for this field can be found in the PackageTypeEnum type. This field will be returned if the package type is set for the inventory item. Note: You can use the GeteBayDetails Trading API call to retrieve a list of supported package types for a specific marketplace.')
shipping_irregular
class-attribute
instance-attribute
¶
shipping_irregular = Field(None, alias='shippingIrregular', description='A value of true indicates that the package is irregular and cannot go through the stamping machine at the shipping service office. This field applies to calculated shipping only. Irregular packages require special or fragile handling.')
weight
class-attribute
instance-attribute
¶
weight = Field(None, description='This container is used to specify the weight of the shipping package that will be used to ship the inventory item. The weight of a shipping package are needed when calculated shipping is used, or if flat-rate shipping rates are used, but with a weight surcharge. This field will be returned if package weight is set for the inventory item.')
PickupAtLocationAvailability ¶
Bases: EbayModel
availability_type
class-attribute
instance-attribute
¶
availability_type = Field(None, alias='availabilityType', description="The enumeration value in this field indicates the availability status of the inventory item at the merchant's physical store specified by the pickupAtLocationAvailability.merchantLocationKey field. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.")
fulfillment_time
class-attribute
instance-attribute
¶
fulfillment_time = Field(None, alias='fulfillmentTime', description='This container is used to indicate how soon an In-Store Pickup order will be available for pickup by the buyer after the order takes place. This container is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description="The unique identifier of a merchant's store where the In-Store Pickup inventory item is currently located, or where inventory will be sent to. If the merchant's store is currently awaiting for inventory, the availabilityType value should be SHIP_TO_STORE .")
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='This integer value indicates the quantity of the inventory item that is available for In-Store Pickup at the store identified by the merchantLocationKey value. The value of quantity should be an integer value greater than 0 , unless the inventory item is out of stock.')
Regulatory ¶
Bases: EbayModel
documents
class-attribute
instance-attribute
¶
documents = Field(None, description='This container provides a collection of regulatory documents associated with the listing. For information on removing one or more files from a listing using the updateOffer method, see Remove documents from listings. .')
energy_efficiency_label
class-attribute
instance-attribute
¶
energy_efficiency_label = Field(None, alias='energyEfficiencyLabel', description='This container provides information about the energy efficiency for certain durable goods. Note: This container can be used to provide European energy efficiency (EEK) information for listings in the Tyres and Appliance categories for sellers in the EU and UK, and Smartphones and Tablets categories for sellers in the US, AU, CA, EU, and UK.')
hazmat
class-attribute
instance-attribute
¶
hazmat = Field(None, description='This container is used by the seller to provide hazardous material information for the listing. The statements element is required to complete the Hazmat section of a listing. The following elements are optional: pictograms signalWord component Note: Hazmat information is not required for all categories.')
manufacturer
class-attribute
instance-attribute
¶
manufacturer = Field(None, description='This container provides information about the manufacturer of the item. Note: As a part of General Product Safety Regulation (GPSR) requirements effective on December 13th, 2024, sellers operating in, or shipping to, EU-based countries or Northern Ireland are conditionally required to provide regulatory manufacturer information in their eBay listings.')
product_safety
class-attribute
instance-attribute
¶
product_safety = Field(None, alias='productSafety', description='This container is used to provide product safety information for the listing. One of the following elements is required to complete the Product Safety section for a listing: pictograms or statements . The component element is optional.')
repair_score
class-attribute
instance-attribute
¶
repair_score = Field(None, alias='repairScore', description="This field represents the repair index for the listing. The repair index identifies the manufacturer's repair score for a product (i.e., how easy is it to repair the product). This field is a floating point value between 0.0 (i.e., difficult to repair) and 10.0 (i.e., easily repaired). Note: 0 should not be used as a default value, as it implies the product is not repairable.")
responsible_persons
class-attribute
instance-attribute
¶
responsible_persons = Field(None, alias='responsiblePersons', description='This container provides information about the EU-based Responsible Persons or entities associated with the listing. A maximum of 5 EU Responsible Persons are supported.')
ShipToLocationAvailability ¶
Bases: EbayModel
availability_distributions
class-attribute
instance-attribute
¶
availability_distributions = Field(None, alias='availabilityDistributions', description='This container is used to set the available quantity of the inventory item at one or more warehouse locations. This container will be returned if available quantity is set for one or more inventory locations.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description="This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This field represents the total quantity of the item that is available for sale across all marketplaces.")
ShipToLocationAvailabilityWithAll ¶
Bases: EbayModel
allocation_by_format
class-attribute
instance-attribute
¶
allocation_by_format = Field(None, alias='allocationByFormat', description='This container is used to specify the quantity of the inventory item that is available for purchase, allocated by the offer types.')
availability_distributions
class-attribute
instance-attribute
¶
availability_distributions = Field(None, alias='availabilityDistributions', description='This container is used to set the available quantity of the inventory item at one or more warehouse locations. This container will be returned if the available quantity is set for one or more inventory locations.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description="Important! Publish offer note: Although this field is not required before an offer can be published to create an active listing, out of stock listings will result if this field is omitted or set to 0 . This field is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers.")
Availability ¶
Bases: EbayModel
pickup_at_location_availability
class-attribute
instance-attribute
¶
pickup_at_location_availability = Field(None, alias='pickupAtLocationAvailability', description="This container consists of an array of one or more of the merchant's physical store locations where the inventory item is available for In-Store Pickup orders. The merchant's location, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order takes place) are all in this container.")
ship_to_location_availability
class-attribute
instance-attribute
¶
ship_to_location_availability = Field(None, alias='shipToLocationAvailability', description='This container specifies the quantity of the inventory item that are available for purchase across one or more eBay marketplaces.')
AvailabilityWithAll ¶
Bases: EbayModel
pickup_at_location_availability
class-attribute
instance-attribute
¶
pickup_at_location_availability = Field(None, alias='pickupAtLocationAvailability', description="This container consists of an array of one or more of the merchant's physical stores where the inventory item is available for in-store pickup. The store ID, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order occurs) are all returned in this container.")
ship_to_location_availability
class-attribute
instance-attribute
¶
ship_to_location_availability = Field(None, alias='shipToLocationAvailability', description='This container specifies the quantity of the inventory items that are available for a standard purchase, where the item is shipped to the buyer.')
EbayOfferDetailsWithAll ¶
Bases: EbayModel
available_quantity
class-attribute
instance-attribute
¶
available_quantity = Field(None, alias='availableQuantity', description='This integer value indicates the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the primary eBay category that the inventory item is listed under. This field is always returned for published offers, but is only returned if set for unpublished offers.')
charity
class-attribute
instance-attribute
¶
charity = Field(None, description='This container is returned if a charitable organization will receive a percentage of sale proceeds for each sale generated by the listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that indicates the percentage of the sales proceeds that will be donated to the charitable organization.')
extended_producer_responsibility
class-attribute
instance-attribute
¶
extended_producer_responsibility = Field(None, alias='extendedProducerResponsibility', description='This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace.')
format
class-attribute
instance-attribute
¶
format = Field(None, description='This enumerated value indicates the listing format of the offer.')
hide_buyer_details
class-attribute
instance-attribute
¶
hide_buyer_details = Field(None, alias='hideBuyerDetails', description="This field is returned as true if the private listing feature has been enabled for the offer. Sellers may want to use this feature when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. This field is always returned even if not explicitly set in the offer.")
include_catalog_product_details
class-attribute
instance-attribute
¶
include_catalog_product_details = Field(None, alias='includeCatalogProductDetails', description='This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem .')
listing
class-attribute
instance-attribute
¶
listing = Field(None, description='For published offers, this container is always returned in the getOffer and getOffers calls, and includes the eBay listing ID associated with the offer, the status of the listing, and the quantity sold through the listing. The listing container is not returned at all for unpublished offers.')
listing_description
class-attribute
instance-attribute
¶
listing_description = Field(None, alias='listingDescription', description='The description of the eBay listing that is part of the unpublished or published offer. This field is always returned for published offers, but is only returned if set for unpublished offers. Maximum length : 500,000 (which includes HTML markup/tags)')
listing_duration
class-attribute
instance-attribute
¶
listing_duration = Field(None, alias='listingDuration', description="This field indicates the number of days that the listing will be active. This field is returned for both auction and fixed-price listings; however, the value returned for fixed-price listings will always be GTC . The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.")
listing_policies
class-attribute
instance-attribute
¶
listing_policies = Field(None, alias='listingPolicies', description='This container indicates the listing policies that are applied to the offer. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API.')
listing_start_date
class-attribute
instance-attribute
¶
listing_start_date = Field(None, alias='listingStartDate', description='This timestamp is the date/time (in UTC format) that the seller set for the scheduled listing. With the scheduled listing feature, the seller can set a time in the future that the listing will become active, instead of the listing becoming active immediately after a publishOffer call. For example: 2023-05-30T19:08:00Z.')
lot_size
class-attribute
instance-attribute
¶
lot_size = Field(None, alias='lotSize', description='This field is only applicable and returned if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product. An example would be a set of four identical car tires. The integer value in this field is the number of identical items being sold through the lot listing.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This enumeration value is the unique identifier of the eBay site on which the offer is available, or will be made available.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description='The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it can not be modified. To get more information about this inventory location, the getInventoryLocation method can be used, passing in this value at the end of the call URI.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity call.')
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.')
quantity_limit_per_buyer
class-attribute
instance-attribute
¶
quantity_limit_per_buyer = Field(None, alias='quantityLimitPerBuyer', description='This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity in this field.')
regulatory
class-attribute
instance-attribute
¶
regulatory = Field(None, description='This container is used by the seller to provide regulatory information.')
secondary_category_id
class-attribute
instance-attribute
¶
secondary_category_id = Field(None, alias='secondaryCategoryId', description='The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. Note: You cannot list US eBay Motors vehicles in two categories.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='This is the seller-defined SKU value of the product in the offer. Maximum length : 50')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The enumeration value in this field specifies the status of the offer - either PUBLISHED or UNPUBLISHED .')
store_category_names
class-attribute
instance-attribute
¶
store_category_names = Field(None, alias='storeCategoryNames', description='This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) in this container will be the full path(s) to the eBay store categories, as shown below: "storeCategoryNames": [ "/Fashion/Men/Shirts", "/Fashion/Men/Accessories" ],')
tax
class-attribute
instance-attribute
¶
tax = Field(None, description="This container is only returned if a sales tax table, a Value-Added Tax (VAT) rate, and/or a tax exception category code was applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true , but a buyer's purchase will not involve sales tax.")
EbayOfferDetailsWithId ¶
Bases: EbayModel
available_quantity
class-attribute
instance-attribute
¶
available_quantity = Field(None, alias='availableQuantity', description='This integer value sets the quantity of the inventory item that will be available through the offer. Quantity must be set to 1 or more in order for the inventory item to be purchasable. This value should not be more than the quantity that is specified for the inventory item record. For auction listings, this field should not be provided.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay category that the inventory item is/will be listed under. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values.')
charity
class-attribute
instance-attribute
¶
charity = Field(None, description='This container is used if the seller wishes to update a published or unpublished offer with a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing.')
extended_producer_responsibility
class-attribute
instance-attribute
¶
extended_producer_responsibility = Field(None, alias='extendedProducerResponsibility', description='This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace.')
hide_buyer_details
class-attribute
instance-attribute
¶
hide_buyer_details = Field(None, alias='hideBuyerDetails', description='This field is included and set to true if the seller wishes to update a published or unpublished offer with the private listing feature. Alternatively, the seller could also remove the private listing feature (if already set for a published or unpublished offer) by including this field and setting it to false .')
include_catalog_product_details
class-attribute
instance-attribute
¶
include_catalog_product_details = Field(None, alias='includeCatalogProductDetails', description='This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem .')
listing_description
class-attribute
instance-attribute
¶
listing_description = Field(None, alias='listingDescription', description='The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer.')
listing_duration
class-attribute
instance-attribute
¶
listing_duration = Field(None, alias='listingDuration', description="This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC , but auction listings support different listing durations. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.")
listing_policies
class-attribute
instance-attribute
¶
listing_policies = Field(None, alias='listingPolicies', description='This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published.')
listing_start_date
class-attribute
instance-attribute
¶
listing_start_date = Field(None, alias='listingStartDate', description='This field can be used with an unpublished offer if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enough time to publish the listing with the publishOffer method. For example: 2023-05-30T19:08:00Z.')
lot_size
class-attribute
instance-attribute
¶
lot_size = Field(None, alias='lotSize', description='This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description="The unique identifier of a merchant's inventory location (where the inventory item in the offer is located). To get more information about inventory locations, the getInventoryLocations method can be used.br> Note: This field is not initially required upon first creating an offer, but will become required before an offer can be published. Maximum length : 36")
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.')
quantity_limit_per_buyer
class-attribute
instance-attribute
¶
quantity_limit_per_buyer = Field(None, alias='quantityLimitPerBuyer', description='This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceeding the quantity specified for this field.')
regulatory
class-attribute
instance-attribute
¶
regulatory = Field(None, description='This container is used by the seller to provide regulatory information.')
secondary_category_id
class-attribute
instance-attribute
¶
secondary_category_id = Field(None, alias='secondaryCategoryId', description='The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. Note: You cannot list US eBay Motors vehicles in two categories.')
store_category_names
class-attribute
instance-attribute
¶
store_category_names = Field(None, alias='storeCategoryNames', description='This container is used if the seller would like to place the inventory item into one or two store categories that the seller has set up for their eBay store.')
tax
class-attribute
instance-attribute
¶
tax = Field(None, description="This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true , but a buyer's purchase will not involve sales tax.")
EbayOfferDetailsWithKeys ¶
Bases: EbayModel
available_quantity
class-attribute
instance-attribute
¶
available_quantity = Field(None, alias='availableQuantity', description='This integer value sets the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay category that the product will be listed under. This field is not immediately required upon creating an offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values.')
charity
class-attribute
instance-attribute
¶
charity = Field(None, description='This container is used if the seller wishes to select a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing.')
extended_producer_responsibility
class-attribute
instance-attribute
¶
extended_producer_responsibility = Field(None, alias='extendedProducerResponsibility', description='This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace.')
format
class-attribute
instance-attribute
¶
format = Field(None, description='This enumerated value indicates the listing format of the offer. Supported values are FIXED_PRICE and AUCTION .')
hide_buyer_details
class-attribute
instance-attribute
¶
hide_buyer_details = Field(None, alias='hideBuyerDetails', description="This field is included and set to true if the seller wishes to create a private listing. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.")
include_catalog_product_details
class-attribute
instance-attribute
¶
include_catalog_product_details = Field(None, alias='includeCatalogProductDetails', description='This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem .')
listing_description
class-attribute
instance-attribute
¶
listing_description = Field(None, alias='listingDescription', description='The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer.')
listing_duration
class-attribute
instance-attribute
¶
listing_duration = Field(None, alias='listingDuration', description="This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC , but auction listings support different listing durations. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.")
listing_policies
class-attribute
instance-attribute
¶
listing_policies = Field(None, alias='listingPolicies', description='This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published.')
listing_start_date
class-attribute
instance-attribute
¶
listing_start_date = Field(None, alias='listingStartDate', description='This field can be used if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enough time to publish the listing with the publishOffer method. For example: 2023-05-30T19:08:00Z. This field is optional.')
lot_size
class-attribute
instance-attribute
¶
lot_size = Field(None, alias='lotSize', description='This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This enumeration value is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for the list of supported enumeration values. This field is required.')
merchant_location_key
class-attribute
instance-attribute
¶
merchant_location_key = Field(None, alias='merchantLocationKey', description="The unique identifier of a merchant's inventory location (where the inventory item in the offer is located). To get more information about inventory locations, the getInventoryLocations method can be used. Note: This field is not initially required upon first creating an offer, but will become required before an offer can be published.")
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.')
quantity_limit_per_buyer
class-attribute
instance-attribute
¶
quantity_limit_per_buyer = Field(None, alias='quantityLimitPerBuyer', description='This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity specified for this field.')
regulatory
class-attribute
instance-attribute
¶
regulatory = Field(None, description='This container is used by the seller to provide regulatory information.')
secondary_category_id
class-attribute
instance-attribute
¶
secondary_category_id = Field(None, alias='secondaryCategoryId', description='The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. Note: You cannot list US eBay Motors vehicles in two categories.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku / marketplaceId / format combination. This field is required. Use the getInventoryItems method to retrieve SKU values. Maximum length : 50')
store_category_names
class-attribute
instance-attribute
¶
store_category_names = Field(None, alias='storeCategoryNames', description='This container is used if the seller would like to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the eBay store categories, as shown below: "storeCategoryNames": [ "/Fashion/Men/Shirts", "/Fashion/Men/Accessories" ],')
tax
class-attribute
instance-attribute
¶
tax = Field(None, description="This container is applicable and used only if a sales-tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true , but a buyer's purchase will not involve sales tax.")
InventoryItem ¶
Bases: EbayModel
availability
class-attribute
instance-attribute
¶
availability = Field(None, description='This container is used to specify the quantity of the inventory item that are available for purchase. This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the getItemConditionPolicies method of the Metadata API . This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type.')
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description='This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose condition value is not NEW , LIKE_NEW , NEW_OTHER , or NEW_WITH_DEFECTS . The conditionDescription field is available for all eBay categories.')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either closed set or open text inputs.')
package_weight_and_size
class-attribute
instance-attribute
¶
package_weight_and_size = Field(None, alias='packageWeightAndSize', description="This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package.")
product
class-attribute
instance-attribute
¶
product = Field(None, description='This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog.')
InventoryItemWithSkuLocale ¶
Bases: EbayModel
availability
class-attribute
instance-attribute
¶
availability = Field(None, description='This container is used to specify the quantity of the inventory item that are available for purchase. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the getItemConditionPolicies method of the Metadata API . This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type.')
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description='This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose condition value is not NEW , LIKE_NEW , NEW_OTHER , or NEW_WITH_DEFECTS . The conditionDescription field is available for all eBay categories.')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either closed set or open text inputs.')
locale
class-attribute
instance-attribute
¶
locale = Field(None, description='This request parameter sets the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE).')
package_weight_and_size
class-attribute
instance-attribute
¶
package_weight_and_size = Field(None, alias='packageWeightAndSize', description="This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package.")
product
class-attribute
instance-attribute
¶
product = Field(None, description='This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku / marketplaceId / format combination. This field is required. Maximum length : 50')
InventoryItemWithSkuLocaleGroupKeys ¶
Bases: EbayModel
availability
class-attribute
instance-attribute
¶
availability = Field(None, description="This container shows the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer, and/or the quantity of the inventory item that is available for In-Store Pickup at one or more of the merchant's physical stores.")
condition
class-attribute
instance-attribute
¶
condition = Field(None, description="This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer.")
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description="This string field is used by the seller to more clearly describe the condition of used items, or items that are not 'Brand New', 'New with tags', or 'New in box'. The ConditionDescription field is available for all categories.")
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either closed set or open text.')
inventory_item_group_keys
class-attribute
instance-attribute
¶
inventory_item_group_keys = Field(None, alias='inventoryItemGroupKeys', description="This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups.")
locale
class-attribute
instance-attribute
¶
locale = Field(None, description='This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE).')
package_weight_and_size
class-attribute
instance-attribute
¶
package_weight_and_size = Field(None, alias='packageWeightAndSize', description='This container is used to specify the dimensions and weight of a shipping package.')
product
class-attribute
instance-attribute
¶
product = Field(None, description='This container is used in a createOrReplaceInventoryItem call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.')
InventoryItemWithSkuLocaleGroupid ¶
Bases: EbayModel
availability
class-attribute
instance-attribute
¶
availability = Field(None, description="This container is used to specify the quantity of the inventory item that are available for purchase if the item will be shipped to the buyer, and the quantity of the inventory item that are available for In-Store Pickup at one or more of the merchant's physical stores.")
condition
class-attribute
instance-attribute
¶
condition = Field(None, description="This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer.")
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description="This string field is used by the seller to more clearly describe the condition of used items, or items that are not 'Brand New', 'New with tags', or 'New in box'. The ConditionDescription field is available for all categories.")
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either closed set or open text.')
group_ids
class-attribute
instance-attribute
¶
group_ids = Field(None, alias='groupIds', description='This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item group(s). This array is not returned if the inventory item is not associated with any inventory item groups.')
inventory_item_group_keys
class-attribute
instance-attribute
¶
inventory_item_group_keys = Field(None, alias='inventoryItemGroupKeys', description="This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups.")
locale
class-attribute
instance-attribute
¶
locale = Field(None, description='This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE).')
package_weight_and_size
class-attribute
instance-attribute
¶
package_weight_and_size = Field(None, alias='packageWeightAndSize', description='This container is used to specify the dimensions and weight of a shipping package.')
product
class-attribute
instance-attribute
¶
product = Field(None, description='This container is used in a createOrReplaceInventoryItem call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.')
InventoryItems ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This is the URL to the current page of inventory items.')
inventory_items
class-attribute
instance-attribute
¶
inventory_items = Field(None, alias='inventoryItems', description='This container is an array of one or more inventory items, with detailed information on each inventory item.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This integer value is the number of inventory items that will be displayed on each results page.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This is the URL to the next page of inventory items. This field will only be returned if there are additional inventory items to view.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This is the URL to the previous page of inventory items. This field will only be returned if there are previous inventory items to view.')
size
class-attribute
instance-attribute
¶
size = Field(None, description='This integer value indicates the total number of pages of results that are available. This number will depend on the total number of inventory items available for viewing, and on the limit value.')
total
class-attribute
instance-attribute
¶
total = Field(None, description="This integer value is the total number of inventory items that exist for the seller's account. Based on this number and on the limit value, the seller may have to toggle through multiple pages to view all inventory items.")
Offers ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This is the URL to the current page of offers.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='This integer value is the number of offers that will be displayed on each results page.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This is the URL to the next page of offers. This field will only be returned if there are additional offers to view.')
offers
class-attribute
instance-attribute
¶
offers = Field(None, description="This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required sku query parameter. Note: Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces. Max Occurs: 25")
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view.')
size
class-attribute
instance-attribute
¶
size = Field(None, description='This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the limit value if there are additional pages of results to view. Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers and this value will be 2 .')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the limit value, the seller may have to toggle through multiple pages to view all offers. Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers, so this value would be 2 .')
PriceQuantity ¶
Bases: EbayModel
offers
class-attribute
instance-attribute
¶
offers = Field(None, description='This container is needed if the seller is updating the price and/or quantity of one or more published offers, and a successful call will actually update the active eBay listing with the revised price and/or available quantity. This call is not designed to work with unpublished offers. For unpublished offers, the seller should use the updateOffer call to update the available quantity and/or price.')
ship_to_location_availability
class-attribute
instance-attribute
¶
ship_to_location_availability = Field(None, alias='shipToLocationAvailability', description="This container is needed if the seller is updating the total 'ship-to-home' quantity for the corresponding inventory item (specified in the sku field). A successful call will update the inventory item record associated with the sku value.")
sku
class-attribute
instance-attribute
¶
sku = Field(None, description="This is the seller-defined SKU value of the inventory item whose total 'ship-to-home' quantity will be updated. This field is only required when the seller is updating the total quantity of an inventory item using the shipToLocationAvailability container.")
BulkEbayOfferDetailsWithKeys ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='The details of each offer that is being created is passed in under this container. Up to 25 offers can be created with one bulkCreateOffer call.')
BulkInventoryItem ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='The details of each inventory item that is being created or updated is passed in under this container. Up to 25 inventory item records can be created and/or updated with one bulkCreateOrReplaceInventoryItem call.')
BulkPriceQuantity ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description="This container is used by the seller to update the total 'ship-to-home' quantity of one or more inventory items (up to 25) and/or to update the price and/or quantity of one or more specific published offers.")
GetInventoryItemResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there were one or more errors associated with retrieving the inventory item record.')
inventory_item
class-attribute
instance-attribute
¶
inventory_item = Field(None, alias='inventoryItem', description='This container consists of detailed information on the inventory item specified in the sku field.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The HTTP status code returned in this field indicates the success or failure of retrieving the inventory item record for the inventory item specified in the sku field. See the HTTP status codes table to see which each status code indicates.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='This container will be returned if there were one or more warnings associated with retrieving the inventory item record.')