Marketing API — client.sell.marketing¶
Version v1.22.4 · base path /sell/marketing/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
bulk_create_ads_by_inventory_reference ¶
bulk_create_ads_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkCreateAdsByInventoryReferenceResponse
bulk_create_ads_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_ads_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkCreateAdsByInventoryReferenceResponse | httpx.Response
This method adds multiple listings that are managed with the Inventory API to an existing Promoted Listings campaign. For general strategy campaigns using the Cost Per Sale (CPS) model, bulk ads may be directly created for the listing. For each listing specified in the request, this method: Creates an ad for the listing. Sets the bid percentage (also known as the ad rate ) for the ads created.
bulk_create_ads_by_listing_id ¶
bulk_create_ads_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkAdResponse
bulk_create_ads_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_ads_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkAdResponse | httpx.Response
This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by the Trading API or Inventory API , or using values generated by an ad group ID. For general strategy campaigns using the Cost Per Sale (CPS) funding model, bulk ads may be directly created for the listing.
bulk_delete_ads_by_inventory_reference ¶
bulk_delete_ads_by_inventory_reference(campaign_id: str, *, body: BulkDeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkDeleteAdsByInventoryReferenceResponse
bulk_delete_ads_by_inventory_reference(campaign_id: str, *, body: BulkDeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_delete_ads_by_inventory_reference(campaign_id: str, *, body: BulkDeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkDeleteAdsByInventoryReferenceResponse | httpx.Response
This method works with listings created with the Inventory API . The method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified campaign. Inventory reference IDs are seller-defined IDs that are used with the Inventory API .
bulk_delete_ads_by_listing_id ¶
bulk_delete_ads_by_listing_id(campaign_id: str, *, body: BulkDeleteAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkDeleteAdResponse
bulk_delete_ads_by_listing_id(campaign_id: str, *, body: BulkDeleteAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_delete_ads_by_listing_id(campaign_id: str, *, body: BulkDeleteAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkDeleteAdResponse | httpx.Response
This method works with listing IDs created with either the Trading API or the Inventory API . The method deletes a set of ads, as specified by a list of listingID values from a Promoted Listings campaign. A listing ID value is generated by eBay when a seller creates a listing with either the Trading API and Inventory API.
bulk_update_ads_bid_by_inventory_reference ¶
bulk_update_ads_bid_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkUpdateAdsByInventoryReferenceResponse
bulk_update_ads_bid_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_ads_bid_by_inventory_reference(campaign_id: str, *, body: BulkCreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkUpdateAdsByInventoryReferenceResponse | httpx.Response
This method works with listings created with either the Trading API or the Inventory API . The method updates the bidPercentage values for a set of ads associated with the specified campaign. Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage values in the request body.
bulk_update_ads_bid_by_listing_id ¶
bulk_update_ads_bid_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkAdUpdateResponse
bulk_update_ads_bid_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_ads_bid_by_listing_id(campaign_id: str, *, body: BulkCreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkAdUpdateResponse | httpx.Response
This method works with listings created with either the Trading API or the Inventory API . The method updates the bidPercentage values for a set of ads associated with the specified campaign. Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage values in the request body.
bulk_update_ads_status ¶
bulk_update_ads_status(campaign_id: str, *, body: BulkUpdateAdStatusRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkAdUpdateStatusResponse
bulk_update_ads_status(campaign_id: str, *, body: BulkUpdateAdStatusRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_ads_status(campaign_id: str, *, body: BulkUpdateAdStatusRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkAdUpdateStatusResponse | httpx.Response
Note: This method is only available for select partners who have been approved for the priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, use the getAdvertisingEligibility method in Account API.
bulk_update_ads_status_by_listing_id ¶
bulk_update_ads_status_by_listing_id(campaign_id: str, *, body: BulkUpdateAdStatusByListingIdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkAdUpdateStatusByListingIdResponse
bulk_update_ads_status_by_listing_id(campaign_id: str, *, body: BulkUpdateAdStatusByListingIdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_ads_status_by_listing_id(campaign_id: str, *, body: BulkUpdateAdStatusByListingIdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkAdUpdateStatusByListingIdResponse | httpx.Response
The method updates the status of ads in bulk, based on listing ID values. Specify the campaign_id as a path parameter and supply a set of listing IDs with their updated adStatus values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.
get_ads ¶
get_ads(campaign_id: str, *, ad_group_ids: str | None = None, ad_status: str | None = None, limit: int | str | None = None, listing_ids: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.AdPagedCollectionResponse
get_ads(campaign_id: str, *, ad_group_ids: str | None = None, ad_status: str | None = None, limit: int | str | None = None, listing_ids: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_ads(campaign_id: str, *, ad_group_ids: str | None = None, ad_status: str | None = None, limit: int | str | None = None, listing_ids: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.AdPagedCollectionResponse | httpx.Response
This method retrieves Promoted Listings ads that are associated with listings created with either the Trading API or the Inventory API . The method retrieves ads related to the specified campaign. Specify the Promoted Listings campaign to target with the campaign_id path parameter.
create_ad_by_listing_id ¶
create_ad_by_listing_id(campaign_id: str, *, body: CreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_ad_by_listing_id(campaign_id: str, *, body: CreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_ad_by_listing_id(campaign_id: str, *, body: CreateAdRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by the Trading API or Inventory API , or using a value generated by an ad group ID. For general strategy campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing. For the listing ID specified in the request, this method: Creates an ad for the listing.
create_ads_by_inventory_reference ¶
create_ads_by_inventory_reference(campaign_id: str, *, body: CreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.AdReferences
create_ads_by_inventory_reference(campaign_id: str, *, body: CreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_ads_by_inventory_reference(campaign_id: str, *, body: CreateAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.AdReferences | httpx.Response
This method adds a listing that is managed with the Inventory API to an existing Promoted Listings campaign. For general strategy campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing. For each listing specified in the request, this method: Creates an ad for the listing. Sets the bid percentage (also known as the ad rate ) for the ads created.
get_ad ¶
get_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Ad
get_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Ad | httpx.Response
This method retrieves the specified ad from the specified campaign. In the request, supply the campaign_id and ad_id as path parameters. Call getCampaigns to retrieve a list of the seller's current campaign IDs and call getAds to retrieve their current ad IDs.
delete_ad ¶
delete_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
delete_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_ad(ad_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method removes the specified ad from the specified campaign. Pass the ID of the ad to delete with the ID of the campaign associated with the ad as path parameters to the call. Call getCampaigns to get the current list of the seller's campaign IDs. Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model.
delete_ads_by_inventory_reference ¶
delete_ads_by_inventory_reference(campaign_id: str, *, body: DeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.AdIds
delete_ads_by_inventory_reference(campaign_id: str, *, body: DeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_ads_by_inventory_reference(campaign_id: str, *, body: DeleteAdsByInventoryReferenceRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.AdIds | httpx.Response
This method works with listings that are managed with the Inventory API . The method deletes ads using a list of seller-defined inventory reference IDs, used with the Inventory API, that are associated with the specified campaign ID. Specify the campaign ID (as a path parameter) and a list of inventoryReferenceId and inventoryReferenceType pairs to be deleted.
get_ads_by_inventory_reference ¶
get_ads_by_inventory_reference(campaign_id: str, *, inventory_reference_id: str, inventory_reference_type: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Ads
get_ads_by_inventory_reference(campaign_id: str, *, inventory_reference_id: str, inventory_reference_type: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_ads_by_inventory_reference(campaign_id: str, *, inventory_reference_id: str, inventory_reference_type: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Ads | httpx.Response
This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign. Supply the campaign_id as a path parameter and use query parameters to specify the inventory_reference_id and inventory_reference_type pairs.
update_bid ¶
update_bid(ad_id: str, campaign_id: str, *, body: UpdateBidPercentageRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_bid(ad_id: str, campaign_id: str, *, body: UpdateBidPercentageRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_bid(ad_id: str, campaign_id: str, *, body: UpdateBidPercentageRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign. In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call. Call getCampaigns to retrieve a seller's current campaign IDs and call getAds to get their ad IDs.
get_ad_groups ¶
get_ad_groups(campaign_id: str, *, ad_group_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.AdGroupPagedCollectionResponse
get_ad_groups(campaign_id: str, *, ad_group_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_ad_groups(campaign_id: str, *, ad_group_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.AdGroupPagedCollectionResponse | httpx.Response
This method retrieves ad groups for the specified campaign. Each campaign can only have one ad group. In the request, supply the campaign_id as the path parameter. Call getCampaigns to retrieve a list of the current campaign IDs for a seller.
create_ad_group ¶
create_ad_group(campaign_id: str, *, body: CreateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_ad_group(campaign_id: str, *, body: CreateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_ad_group(campaign_id: str, *, body: CreateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method adds an ad group to an existing priority strategy campaign that uses manual targeting. To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter. Each campaign can have one or more associated ad groups.
get_ad_group ¶
get_ad_group(ad_group_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.AdGroup
get_ad_group(ad_group_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_ad_group(ad_group_id: str, campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.AdGroup | httpx.Response
This method retrieves the details of a specified ad group, such as the ad group’s default bid and status. In the request, specify the campaign_id and ad_group_id as path parameters. Call getCampaigns to retrieve a list of the current campaign IDs for a seller and call getAdGroups for the ad group ID of the ad group you wish to retrieve.
update_ad_group ¶
update_ad_group(ad_group_id: str, campaign_id: str, *, body: UpdateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_ad_group(ad_group_id: str, campaign_id: str, *, body: UpdateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_ad_group(ad_group_id: str, campaign_id: str, *, body: UpdateAdGroupRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method updates the ad group associated with a campaign. With this method, you can modify the default bid for the ad group, change the state of the ad group, or change the name of the ad group. Pass the ad_group_id you want to update as a URI parameter, and configure the adGroupStatus and defaultBid in the request payload.
suggest_bids ¶
suggest_bids(ad_group_id: str, campaign_id: str, *, body: TargetedBidRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.TargetedBidsPagedCollection
suggest_bids(ad_group_id: str, campaign_id: str, *, body: TargetedBidRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suggest_bids(ad_group_id: str, campaign_id: str, *, body: TargetedBidRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.TargetedBidsPagedCollection | httpx.Response
This method allows sellers to retrieve the suggested bids for input keywords and match type.
suggest_keywords ¶
suggest_keywords(ad_group_id: str, campaign_id: str, *, body: TargetedKeywordRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.TargetedKeywordsPagedCollection
suggest_keywords(ad_group_id: str, campaign_id: str, *, body: TargetedKeywordRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suggest_keywords(ad_group_id: str, campaign_id: str, *, body: TargetedKeywordRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.TargetedKeywordsPagedCollection | httpx.Response
This method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns.
clone_campaign ¶
clone_campaign(campaign_id: str, *, body: CloneCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
clone_campaign(campaign_id: str, *, body: CloneCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
clone_campaign(campaign_id: str, *, body: CloneCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method clones (makes a copy of) the specified campaign's campaign criterion . The campaign criterion is a container for the fields that define the criteria for a rule-based campaign. To clone a campaign, supply the campaign_id as a path parameter in your call. There is no request payload. The ID of the newly-cloned campaign is returned in the Location response header.
get_campaigns ¶
get_campaigns(*, campaign_name: str | None = None, campaign_status: str | None = None, campaign_targeting_types: str | None = None, channels: str | None = None, end_date_range: str | None = None, funding_strategy: str | None = None, limit: int | str | None = None, offset: int | str | None = None, start_date_range: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.CampaignPagedCollectionResponse
get_campaigns(*, campaign_name: str | None = None, campaign_status: str | None = None, campaign_targeting_types: str | None = None, channels: str | None = None, end_date_range: str | None = None, funding_strategy: str | None = None, limit: int | str | None = None, offset: int | str | None = None, start_date_range: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_campaigns(*, campaign_name: str | None = None, campaign_status: str | None = None, campaign_targeting_types: str | None = None, channels: str | None = None, end_date_range: str | None = None, funding_strategy: str | None = None, limit: int | str | None = None, offset: int | str | None = None, start_date_range: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.CampaignPagedCollectionResponse | httpx.Response
This method retrieves the details for all of the seller's defined campaigns. Request parameters can be used to retrieve a specific campaign, such as the campaign's name, the start and end date, the channel, the status, and the funding model (i.e., Cost Per Sale (CPS) or Cost Per Click (CPC)).
create_campaign ¶
create_campaign(*, body: CreateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_campaign(*, body: CreateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_campaign(*, body: CreateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method can be used to create a Promoted Listings general, priority, or offsite campaign. A Promoted Listings campaign is the structure in which you place the ads or ad group for the listings you wish to promote. Note: Campaigns can only contain ads for a maximum of 50,000 items. General strategy campaigns utilize a Cost Per Sale (CPS) funding model.
get_campaign ¶
get_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Campaign
get_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Campaign | httpx.Response
This method retrieves the details of a single campaign, as specified with the campaign_id query parameter. This method returns all the details of a campaign (including the campaign's the selection rules), except the for the listing IDs or inventory reference IDs included in the campaign. These IDs are returned by getAds . Call getCampaigns to retrieve a list of the seller's campaign IDs.
delete_campaign ¶
delete_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
delete_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method deletes the campaign specified by the campaign_id query parameter. Note: You can only delete campaigns that have ended. Call getCampaigns to retrieve the campaign_id and the campaign status ( RUNNING , PAUSED , ENDED , and so on) for all the seller's campaigns.
end_campaign ¶
end_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
end_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
end_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method ends an active ( RUNNING ) or paused campaign. Specify the campaign you want to end by supplying its campaign ID in a query parameter. Call getCampaigns to retrieve the campaign_id and the campaign status ( RUNNING , PAUSED , ENDED , and so on) for all the seller's campaigns.
find_campaign_by_ad_reference ¶
find_campaign_by_ad_reference(*, inventory_reference_id: str | None = None, inventory_reference_type: str | None = None, listing_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Campaigns
find_campaign_by_ad_reference(*, inventory_reference_id: str | None = None, inventory_reference_type: str | None = None, listing_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
find_campaign_by_ad_reference(*, inventory_reference_id: str | None = None, inventory_reference_type: str | None = None, listing_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Campaigns | httpx.Response
This method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference type pair. The request accepts either a listing_id , or an inventory_reference_id and inventory_reference_type pair, as used in the Inventory API.
get_campaign_by_name ¶
get_campaign_by_name(*, campaign_name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Campaign
get_campaign_by_name(*, campaign_name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_campaign_by_name(*, campaign_name: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Campaign | httpx.Response
This method retrieves the details of a single campaign, as specified with the campaign_name query parameter. Note that the campaign name you specify must be an exact, case-sensitive match of the name of the campaign you want to retrieve. Call getCampaigns to retrieve a list of the seller's campaign names.
pause_campaign ¶
pause_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
pause_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
pause_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method pauses an active (RUNNING) campaign. You can restart the campaign by calling resumeCampaign , as long as the campaign's end date is in the future. Note: The listings associated with a paused campaign cannot be added into another campaign. Call getCampaigns to retrieve the campaign_id and the campaign status ( RUNNING , PAUSED , ENDED , and so on) for all the seller's campaigns.
resume_campaign ¶
resume_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
resume_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
resume_campaign(campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method resumes a paused campaign, as long as its end date is in the future. Supply the campaign_id for the campaign you want to restart as a query parameter in the request. Call getCampaigns to retrieve the campaign_id and the campaign status ( RUNNING , PAUSED , ENDED , and so on) for all the seller's campaigns.
suggest_budget ¶
suggest_budget(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.SuggestBudgetResponse
suggest_budget(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suggest_budget(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.SuggestBudgetResponse | httpx.Response
Note: This method is only supported for Promoted Offsite campaigns. Sellers can use the getAdvertisingEligibility method of the Account API v1 to determine if they are eligible for offsite campaigns. This method allows sellers to retrieve the suggested budget for an offsite campaign.
suggest_items ¶
suggest_items(campaign_id: str, *, category_ids: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.TargetedAdsPagedCollection
suggest_items(campaign_id: str, *, category_ids: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suggest_items(campaign_id: str, *, category_ids: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.TargetedAdsPagedCollection | httpx.Response
This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns.
suggest_max_cpc ¶
suggest_max_cpc(*, body: SuggestMaxCpcRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.SuggestMaxCpcResponse
suggest_max_cpc(*, body: SuggestMaxCpcRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suggest_max_cpc(*, body: SuggestMaxCpcRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.SuggestMaxCpcResponse | httpx.Response
Note: This method is only supported for smart targeting priority strategy campaigns. Sellers can use the getAdvertisingEligibility method of the Account API v1 to determine if they are eligible for a priority strategy campaign. This method allows sellers to retrieve the suggested maximum cost-per-click value for a smart targeting campaign.
update_ad_rate_strategy ¶
update_ad_rate_strategy(campaign_id: str, *, body: UpdateAdrateStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_ad_rate_strategy(campaign_id: str, *, body: UpdateAdrateStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_ad_rate_strategy(campaign_id: str, *, body: UpdateAdrateStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method updates the ad rate strategy for an existing rules-based general strategy ad campaign that uses the Cost Per Sale (CPS) funding model. Specify the campaign_id as a path parameter. You can retrieve the campaign IDs for a seller by calling the getCampaigns method. Note: This method only applies to the CPS funding model; it does not apply to the Cost Per Click (CPC) funding model.
update_bidding_strategy ¶
update_bidding_strategy(campaign_id: str, *, body: UpdateBiddingStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_bidding_strategy(campaign_id: str, *, body: UpdateBiddingStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_bidding_strategy(campaign_id: str, *, body: UpdateBiddingStrategyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method allows sellers to change the bidding strategy for a specified Cost Per Click (CPC) campaign that uses manual targeting. Available bidding strategies are: FIXED When using a fixed bidding strategy, sellers manually assign and adjust keyword bids for the CPC campaign.
update_campaign_budget ¶
update_campaign_budget(campaign_id: str, *, body: UpdateCampaignBudgetRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
update_campaign_budget(campaign_id: str, *, body: UpdateCampaignBudgetRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_campaign_budget(campaign_id: str, *, body: UpdateCampaignBudgetRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method updates the daily budget for a priority strategy campaign that uses the Cost Per Click (CPC) funding model. A click occurs when an eBay user finds and clicks on the seller’s listing (within the search results) after using a keyword that the seller has created for the campaign.
update_campaign_identification ¶
update_campaign_identification(campaign_id: str, *, body: UpdateCampaignIdentificationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_campaign_identification(campaign_id: str, *, body: UpdateCampaignIdentificationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_campaign_identification(campaign_id: str, *, body: UpdateCampaignIdentificationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method can be used to change the name of a campaign, as well as modify the start or end dates. Specify the campaign_id you want to update as a URI parameter, and configure the campaignName and startDate in the request payload.
bulk_create_keyword ¶
bulk_create_keyword(campaign_id: str, *, body: BulkCreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkCreateKeywordResponse
bulk_create_keyword(campaign_id: str, *, body: BulkCreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_keyword(campaign_id: str, *, body: BulkCreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkCreateKeywordResponse | httpx.Response
This method adds keywords, in bulk, to an existing priority strategy ad group in a campaign that uses manual targeting. This method also sets the CPC rate for each keyword, depending on the selected bidding strategy, as follows: FIXED : If the seller provides a keyword bid, that bid value will be used. If no bid is provided, the adgroup's default bid value will be used.
bulk_update_keyword ¶
bulk_update_keyword(campaign_id: str, *, body: BulkUpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkUpdateKeywordResponse
bulk_update_keyword(campaign_id: str, *, body: BulkUpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_keyword(campaign_id: str, *, body: BulkUpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkUpdateKeywordResponse | httpx.Response
This method updates the bids and statuses of keywords, in bulk, for an existing priority strategy campaign. In the request, supply the campaign_id as a path parameter. Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller.
get_keywords ¶
get_keywords(campaign_id: str, *, ad_group_ids: str | None = None, keyword_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.KeywordPagedCollectionResponse
get_keywords(campaign_id: str, *, ad_group_ids: str | None = None, keyword_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_keywords(campaign_id: str, *, ad_group_ids: str | None = None, keyword_status: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.KeywordPagedCollectionResponse | httpx.Response
This method can be used to retrieve all of the keywords for ad groups in priority strategy campaigns that use the Cost Per Click (CPC) funding model. In the request, specify the campaign_id as a path parameter. If one or more ad_group_ids are passed in the request body, the keywords for those ad groups will be returned.
create_keyword ¶
create_keyword(campaign_id: str, *, body: CreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_keyword(campaign_id: str, *, body: CreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_keyword(campaign_id: str, *, body: CreateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method creates keywords using a specified campaign ID for an existing priority strategy campaign that uses manual targeting. In the request, supply the campaign_id as a path parameter. Call the suggestKeywords method to retrieve a list of keyword ideas to be targeted for priority strategy campaigns, and call the getCampaigns method to retrieve a list of current campaign IDs for a seller.
get_keyword ¶
get_keyword(campaign_id: str, keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Keyword
get_keyword(campaign_id: str, keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_keyword(campaign_id: str, keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Keyword | httpx.Response
This method retrieves details on a specific keyword from an ad group within a priority strategy campaign that uses the Cost Per Click (CPC) funding model. In the request, specify the campaign_id and keyword_id as path parameters. Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs.
update_keyword ¶
update_keyword(campaign_id: str, keyword_id: str, *, body: UpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.UpdateKeywordResponse
update_keyword(campaign_id: str, keyword_id: str, *, body: UpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_keyword(campaign_id: str, keyword_id: str, *, body: UpdateKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.UpdateKeywordResponse | httpx.Response
This method updates keywords using a campaign ID and keyword ID for an existing priority strategy campaign. In the request, specify the campaign_id and keyword_id as path parameters. Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs.
bulk_create_negative_keyword ¶
bulk_create_negative_keyword(*, body: BulkCreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkCreateNegativeKeywordResponse
bulk_create_negative_keyword(*, body: BulkCreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_create_negative_keyword(*, body: BulkCreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkCreateNegativeKeywordResponse | httpx.Response
This method adds negative keywords, in bulk, to an existing ad group in a priority strategy campaign that uses manual targeting. Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType . Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller.
bulk_update_negative_keyword ¶
bulk_update_negative_keyword(*, body: BulkUpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BulkUpdateNegativeKeywordResponse
bulk_update_negative_keyword(*, body: BulkUpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
bulk_update_negative_keyword(*, body: BulkUpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BulkUpdateNegativeKeywordResponse | httpx.Response
This method updates the statuses of existing negative keywords, in bulk. Specify the negativeKeywordId and negativeKeywordStatus in the request body.
get_negative_keywords ¶
get_negative_keywords(*, ad_group_ids: str, campaign_ids: str | None = None, limit: int | str | None = None, negative_keyword_status: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.NegativeKeywordPagedCollectionResponse
get_negative_keywords(*, ad_group_ids: str, campaign_ids: str | None = None, limit: int | str | None = None, negative_keyword_status: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_negative_keywords(*, ad_group_ids: str, campaign_ids: str | None = None, limit: int | str | None = None, negative_keyword_status: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.NegativeKeywordPagedCollectionResponse | httpx.Response
This method can be used to retrieve all of the negative keywords for ad groups in priority strategy campaigns that use the Cost Per Click (CPC) funding model. The results can be filtered using the campaign_ids , ad_group_ids , and negative_keyword_status query parameters. Call the getCampaigns method to retrieve a list of current campaign IDs for a seller.
create_negative_keyword ¶
create_negative_keyword(*, body: CreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_negative_keyword(*, body: CreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_negative_keyword(*, body: CreateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method adds a negative keyword to an existing ad group in a priority strategy campaign that uses manual targeting. Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType . Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller.
get_negative_keyword ¶
get_negative_keyword(negative_keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.NegativeKeyword
get_negative_keyword(negative_keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_negative_keyword(negative_keyword_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.NegativeKeyword | httpx.Response
This method retrieves details on a specific negative keyword. In the request, specify the negative_keyword_id as a path parameter.
update_negative_keyword ¶
update_negative_keyword(negative_keyword_id: str, *, body: UpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
update_negative_keyword(negative_keyword_id: str, *, body: UpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_negative_keyword(negative_keyword_id: str, *, body: UpdateNegativeKeywordRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method updates the status of an existing negative keyword. Specify the negative_keyword_id as a path parameter, and specify the negativeKeywordStatus in the request body.
get_report ¶
get_report(report_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_report(report_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_report(report_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This call downloads the report as specified by the report_id path parameter. Call createReportTask to schedule and generate a Promoted Listings report. All date values are returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ). Note: The reporting of some data related to sales and ad-fees may require a 72-hour ( maximum ) adjustment period which is often referred to as the Reconciliation Period .
get_report_metadata ¶
get_report_metadata(*, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ReportMetadatas
get_report_metadata(*, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_report_metadata(*, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ReportMetadatas | httpx.Response
This call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different types of Promoted Listings reports. You can retrieve metadata for all report types,funding models and channels, or you can filter based on funding model and/or channel.
get_report_metadata_for_report_type ¶
get_report_metadata_for_report_type(report_type: str, *, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ReportMetadata
get_report_metadata_for_report_type(report_type: str, *, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_report_metadata_for_report_type(report_type: str, *, funding_model: str | None = None, channel: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ReportMetadata | httpx.Response
This call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use the report_type path parameter to indicate metadata to retrieve. This method does not use a request payload. Note: The reporting of some data related to sales and ad-fees may require a 72-hour ( maximum ) adjustment period which is often referred to as the Reconciliation Period .
get_report_tasks ¶
get_report_tasks(*, limit: int | str | None = None, offset: int | str | None = None, report_task_statuses: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ReportTaskPagedCollection
get_report_tasks(*, limit: int | str | None = None, offset: int | str | None = None, report_task_statuses: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_report_tasks(*, limit: int | str | None = None, offset: int | str | None = None, report_task_statuses: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ReportTaskPagedCollection | httpx.Response
This method returns information on all the existing report tasks related to a seller. Use the report_task_statuses query parameter to control which reports to return. You can paginate the result set by specifying a limit , which dictates how many report tasks to return on each page of the response.
create_report_task ¶
create_report_task(*, body: CreateReportTask, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
create_report_task(*, body: CreateReportTask, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_report_task(*, body: CreateReportTask, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This method creates a report task , which generates a Promoted Listings report based on the values specified in the call. The report is generated based on the criteria you specify, including the report type, the report's dimensions and metrics, the report's start and end dates, the listings to include in the report, and more.
get_report_task ¶
get_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ReportTask
get_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ReportTask | httpx.Response
This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id path parameter. The report task includes the report criteria (such as the report dimensions, metrics, and included listing) and the report-generation rules (such as starting and ending dates for the specified report task).
delete_report_task ¶
delete_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
delete_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_report_task(report_task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
This call deletes the report task specified by the report_task_id path parameter. This method also deletes any reports generated by the report task. Report task IDs are generated by eBay when you call createReportTask . Get a complete list of a seller's report-task IDs by calling getReportTasks .
create_item_price_markdown_promotion ¶
create_item_price_markdown_promotion(*, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_item_price_markdown_promotion(*, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_item_price_markdown_promotion(*, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made.
get_item_price_markdown_promotion ¶
get_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ItemPriceMarkdown
get_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ItemPriceMarkdown | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method returns the complete details of the item price markdown discount that's indicated by the promotion_id path parameter.
update_item_price_markdown_promotion ¶
update_item_price_markdown_promotion(promotion_id: str, *, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
update_item_price_markdown_promotion(promotion_id: str, *, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_item_price_markdown_promotion(promotion_id: str, *, body: ItemPriceMarkdown | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method updates the specified item price markdown discount with the new configuration that you supply in the payload of the request.
delete_item_price_markdown_promotion ¶
delete_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
delete_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_item_price_markdown_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method deletes the item price markdown discount specified by the promotion_id path parameter.
create_item_promotion ¶
create_item_promotion(*, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BaseResponse
create_item_promotion(*, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_item_promotion(*, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BaseResponse | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method creates an item discount , where the buyer receives a discount when they meet the specific buying criteria.
get_item_promotion ¶
get_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ItemPromotionResponse
get_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ItemPromotionResponse | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method returns the complete details of the threshold discount specified by the promotion_id path parameter.
update_item_promotion ¶
update_item_promotion(promotion_id: str, *, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.BaseResponse
update_item_promotion(promotion_id: str, *, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_item_promotion(promotion_id: str, *, body: ItemPromotion | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.BaseResponse | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method updates the specified threshold discount with the new configuration that you supply in the request.
delete_item_promotion ¶
delete_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
delete_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_item_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method deletes the threshold discount specified by the promotion_id path parameter.
get_listing_set ¶
get_listing_set(promotion_id: str, *, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, status: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.ItemsPagedCollection
get_listing_set(promotion_id: str, *, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, status: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_set(promotion_id: str, *, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, status: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.ItemsPagedCollection | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method returns the set of listings associated with the promotion_id specified in the path parameter.
get_promotions ¶
get_promotions(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.PromotionsPagedCollection
get_promotions(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_promotions(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.PromotionsPagedCollection | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method returns a list of a seller's undeleted discounts.
pause_promotion ¶
pause_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
pause_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
pause_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method pauses a currently-active (RUNNING) threshold discount and changes the state of the discount from RUNNING to PAUSED .
resume_promotion ¶
resume_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.Error
resume_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
resume_promotion(promotion_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.Error | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method restarts a threshold discount that was previously paused and changes the state of the discount from PAUSED to RUNNING .
get_promotion_reports ¶
get_promotion_reports(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.PromotionsReportPagedCollection
get_promotion_reports(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_promotion_reports(*, marketplace_id: str, limit: int | str | None = None, offset: int | str | None = None, promotion_status: str | None = None, promotion_type: str | None = None, q: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.PromotionsReportPagedCollection | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method generates a report that lists the seller's running, paused, and ended discounts for the specified eBay marketplace.
get_promotion_summary_report ¶
get_promotion_summary_report(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.SummaryReportResponse
get_promotion_summary_report(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_promotion_summary_report(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.SummaryReportResponse | httpx.Response
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made. This method generates a report that summarizes the seller's discounts for the specified eBay marketplace.
get_email_campaigns ¶
get_email_campaigns(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.GetEmailCampaignsResponse
get_email_campaigns(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_email_campaigns(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.GetEmailCampaignsResponse | httpx.Response
This method retrieves a list of email campaigns from a seller's eBay store. Users can filter the results by email campaign type , email campaign status , and marketplace ID using the q query parameter.
create_email_campaign ¶
create_email_campaign(*, body: CreateEmailCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.CreateEmailCampaignResponse
create_email_campaign(*, body: CreateEmailCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_email_campaign(*, body: CreateEmailCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.CreateEmailCampaignResponse | httpx.Response
This method creates a new email campaign. An eBay store owner can create six different types of email campaigns: Welcome, New products & collections, Coupon, Sale event + markdown, Order discount, and Volume pricing. A successful createEmailCampaign request returns the emailCampaignId assigned to the new email campaign.
get_email_campaign ¶
get_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.GetEmailCampaignResponse
get_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.GetEmailCampaignResponse | httpx.Response
This method returns the details of a single email campaign specified by the email_campaign_id path parameter. Call getEmailCampaigns to retrieve a list of all email campaigns from a seller's eBay store.
update_email_campaign ¶
update_email_campaign(email_campaign_id: str, *, body: UpdateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.UpdateEmailCampaignResponse
update_email_campaign(email_campaign_id: str, *, body: UpdateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_email_campaign(email_campaign_id: str, *, body: UpdateCampaignRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.UpdateEmailCampaignResponse | httpx.Response
This method lets users update an existing email campaign. Pass the emailCampaignId in the request URL and specify the changes to field values in the request payload. Note: You can only update the custom fields of an email campaign. Fixed values, such as the emailCampaignType , cannot be changed.
delete_email_campaign ¶
delete_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.DeleteEmailCampaignResponse
delete_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_email_campaign(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.DeleteEmailCampaignResponse | httpx.Response
This method deletes the email campaign specified by the email_campaign_id path parameter. Call getEmailCampaigns to retrieve all of the seller's email campaigns. Use the email_campaign_id of the desired email campaign in the response as the path parameter for this request.
get_audiences ¶
get_audiences(*, email_campaign_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.GetEmailCampaignAudiencesResponse
get_audiences(*, email_campaign_type: str, 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_audiences(*, email_campaign_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.GetEmailCampaignAudiencesResponse | httpx.Response
This method retrieves all available email newsletter audiences for the email campaign type specified by the emailCampaignType path parameter. Use the optional limit and offset path parameters to paginate the results and to control which records are returned, respectively.
get_email_preview ¶
get_email_preview(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.GetEmailPreviewResponse
get_email_preview(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_email_preview(email_campaign_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.GetEmailPreviewResponse | httpx.Response
This method returns a preview of the email sent by the email campaign indicated by the email_campaign_id path parameter. Call getEmailCampaigns to obtain a list of email campaigns. Use the emailCampaignId value of the desired email campaign as the email_campaign_id path parameter value.
get_email_report ¶
get_email_report(*, end_date: str, start_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_marketing_models.GetEmailReportResponse
get_email_report(*, end_date: str, start_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_email_report(*, end_date: str, start_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_marketing_models.GetEmailReportResponse | httpx.Response
This method returns the seller's email campaign performance report for a time period specified by the startDate and endDate path parameters. The maximum date range for a report retrieved by this method is one year.
Models¶
AdGroupStatusEnum ¶
AdIds ¶
Bases: EbayModel
ad_ids
class-attribute
instance-attribute
¶
ad_ids = Field(None, alias='adIds', description='A list of ad IDs. Only one ad can be deleted per operation and only one adId value will be returned.')
AdRateStrategyEnum ¶
AdReference ¶
Bases: EbayModel
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned ID for an ad. This ID is generated when an ad is created.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The getAd URI of an ad. You can use this URI to retrieve the ad.')
AdReferences ¶
Bases: EbayModel
ads
class-attribute
instance-attribute
¶
ads = Field(None, description='A list of ad IDs. An ad ID is generated for each successfully created ad. Only one ad can be created per operation.')
AdStatusEnum ¶
AdditionalInfoEnum ¶
Bases: OpenStrEnum
AdditionalRecordEnum ¶
Bases: OpenStrEnum
non_performing_data
class-attribute
instance-attribute
¶
non_performing_data = 'NON_PERFORMING_DATA'
AlertTypeEnum ¶
AspectKeyEnum ¶
Bases: OpenStrEnum
AudienceTypeEnum ¶
Bases: OpenStrEnum
post_cmpgn_new_buyers
class-attribute
instance-attribute
¶
post_cmpgn_new_buyers = 'POST_CMPGN_NEW_BUYERS'
BiddingStrategyEnum ¶
BudgetStatusEnum ¶
CampaignAudience ¶
Bases: EbayModel
audience_type
class-attribute
instance-attribute
¶
audience_type = Field(None, alias='audienceType', description='This enum value indicates the audience type. For the complete list of audience types and their associated enum values, see AudienceTypeEnum .')
code
class-attribute
instance-attribute
¶
code = Field(None, description='The unique code for an audience.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The display name for an audience.')
CampaignStatusEnum ¶
Bases: OpenStrEnum
CampaignTargetingTypeEnum ¶
CampaignTypeEnum ¶
Bases: OpenStrEnum
CategoryScopeEnum ¶
CategoryTypeEnum ¶
ChannelEnum ¶
CouponTypeEnum ¶
CreateAdRequest ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned identifier for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. Use the getAdGroups method to retrieve the ad group IDs for a seller. Note: This field is required for manual targeting campaigns using the Cost Per Click (CPC) funding model.')
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description="The user-defined bid percentage (also known as the ad rate ) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. Required if the campaign's funding model is Cost Per Sale (CPS). The value specified here is also used to calculate the Promoted Listings fee.")
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique identifier of an eBay listing.')
CriterionTypeEnum ¶
Bases: OpenStrEnum
inventory_partition
class-attribute
instance-attribute
¶
inventory_partition = 'INVENTORY_PARTITION'
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DataTypeEnum ¶
Bases: OpenStrEnum
DeleteAdRequest ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned identifier for a listing that is generated when the listing is created. Note: This request accepts both listing IDs, as generated by the Inventory API, and an item IDs, as used in the eBay Traditional API set (e.g., the Trading and Finding APIs).')
DeleteEmailCampaignResponse ¶
Bases: EbayModel
email_campaign_id
class-attribute
instance-attribute
¶
email_campaign_id = Field(None, alias='emailCampaignId', description='The unique eBay-assigned ID for the email campaign that is generated when the email campaign is created.')
Dimension ¶
Bases: EbayModel
annotation_keys
class-attribute
instance-attribute
¶
annotation_keys = Field(None, alias='annotationKeys', description='A list of annotations associated with the dimension of the report.')
dimension_key
class-attribute
instance-attribute
¶
dimension_key = Field(None, alias='dimensionKey', description='The name of the dimension on which the report is based. A dimension is an attribute to which the report data applies.')
DimensionKeyAnnotation ¶
Bases: EbayModel
annotation_key
class-attribute
instance-attribute
¶
annotation_key = Field(None, alias='annotationKey', description='An annotation key associated with the dimension.')
data_type
class-attribute
instance-attribute
¶
data_type = Field(None, alias='dataType', description='The data type of the annotation key value.')
DimensionKeyEnum ¶
Bases: OpenStrEnum
DimensionMetadata ¶
Bases: EbayModel
data_type
class-attribute
instance-attribute
¶
data_type = Field(None, alias='dataType', description='The data type of the dimension value used to create the report.')
dimension_key
class-attribute
instance-attribute
¶
dimension_key = Field(None, alias='dimensionKey', description='The name of the dimension used to create the report.')
dimension_key_annotations
class-attribute
instance-attribute
¶
dimension_key_annotations = Field(None, alias='dimensionKeyAnnotations', description='An list of annotation keys associated with the specified dimension of the report.')
DynamicAdRatePreference ¶
Bases: EbayModel
ad_rate_adjustment_percent
class-attribute
instance-attribute
¶
ad_rate_adjustment_percent = Field(None, alias='adRateAdjustmentPercent', description='The percentage above or below (-) the eBay suggested ad rate that a seller is willing to pay. This specifies the maximum and minimum values to which an ad rate can be dynamically adjusted.')
ad_rate_cap_percent
class-attribute
instance-attribute
¶
ad_rate_cap_percent = Field(None, alias='adRateCapPercent', description='The maximum value (specified as a percentage) to which the eBay suggested ad rate can be adjusted. The adjusted ad rate will never exceed this percentage.')
EmailCampaignStatusEnum ¶
ErrorParameter ¶
ErrorParameterV3 ¶
ExclusionsEnum ¶
Bases: OpenStrEnum
FundingModelEnum ¶
GetEmailCampaignAudiencesResponse ¶
Bases: EbayModel
audiences
class-attribute
instance-attribute
¶
audiences = Field(None, description='An array of audiences available for the specified email campaign type. If no audiences are available, the result will return an empty array.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of store email campaign audiences.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of store email campaign audiences to return on a page from the result set.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This value indicates the offset used for the current page of store email campaign audiences returned.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of available audiences returned under the query conditions.')
GetEmailPreviewResponse ¶
Bases: EbayModel
content
class-attribute
instance-attribute
¶
content = Field(None, description='The raw HTML code of the email campaign contents. The client side can use this HTML output directly. Because the contents of an email campaign are subject to change, these contents are a "snapshot" of the email campaign at a specific time and date, indicated by the renderDate field.')
render_date
class-attribute
instance-attribute
¶
render_date = Field(None, alias='renderDate', description='The date and time when a "snapshot" of the email campaign contents contained in the content result was taken. Given in UTC format.')
InventoryCriterionEnum ¶
InventoryReferenceTypeEnum ¶
ItemMarkdownStatusEnum ¶
Bases: OpenStrEnum
ItemSelectModeEnum ¶
ItemSortEnum ¶
Bases: OpenStrEnum
KeywordStatusEnum ¶
MarketplaceIdEnum ¶
Bases: OpenStrEnum
MatchTypeEnum ¶
MetricEnum ¶
MetricMetadata ¶
NegativeKeywordMatchTypeEnum ¶
NegativeKeywordStatusEnum ¶
PriceRange ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='Specifies the currency of the listings in an email campaign using one of the three-digit codes of the CurrencyCodeEnum type.')
gte
class-attribute
instance-attribute
¶
gte = Field(None, description='The listings selected will be greater than or equal to this value. The value entered must be given in number format, such as 20.00. Either gte , lte , or both must contain a value if the seller wishes to use a price range.')
lte
class-attribute
instance-attribute
¶
lte = Field(None, description='The listings selected will be less than or equal to this value. The value entered must be given in number format, such as 100.00. Either gte , lte , or both must contain a value if the seller wishes to use a price range.')
PromotionPriorityEnum ¶
Bases: OpenStrEnum
PromotionSelectModeEnum ¶
PromotionStatusEnum ¶
Bases: OpenStrEnum
PromotionTypeEnum ¶
Bases: OpenStrEnum
ProposedBid ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD . Default: The default currency of the eBay marketplace that hosts the listing.')
range_end
class-attribute
instance-attribute
¶
range_end = Field(None, alias='rangeEnd', description='The end of the range specified for the bid.')
range_start
class-attribute
instance-attribute
¶
range_start = Field(None, alias='rangeStart', description='The start of the range specified for the bid.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value of the proposed bid.')
ReportFormatEnum ¶
Bases: OpenStrEnum
ReportTypeEnum ¶
Bases: OpenStrEnum
account_performance_report
class-attribute
instance-attribute
¶
account_performance_report = 'ACCOUNT_PERFORMANCE_REPORT'
all_campaign_performance_summary_report
class-attribute
instance-attribute
¶
all_campaign_performance_summary_report = 'ALL_CAMPAIGN_PERFORMANCE_SUMMARY_REPORT'
campaign_performance_report
class-attribute
instance-attribute
¶
campaign_performance_report = 'CAMPAIGN_PERFORMANCE_REPORT'
campaign_performance_summary_report
class-attribute
instance-attribute
¶
campaign_performance_summary_report = 'CAMPAIGN_PERFORMANCE_SUMMARY_REPORT'
inventory_performance_report
class-attribute
instance-attribute
¶
inventory_performance_report = 'INVENTORY_PERFORMANCE_REPORT'
listing_performance_report
class-attribute
instance-attribute
¶
listing_performance_report = 'LISTING_PERFORMANCE_REPORT'
keyword_performance_report
class-attribute
instance-attribute
¶
keyword_performance_report = 'KEYWORD_PERFORMANCE_REPORT'
search_query_performance_report
class-attribute
instance-attribute
¶
search_query_performance_report = 'SEARCH_QUERY_PERFORMANCE_REPORT'
ScheduleDateTypeEnum ¶
SortField ¶
Bases: EbayModel
ascending
class-attribute
instance-attribute
¶
ascending = Field(None, description='If set to true , the results are sorted in ascending order. If set to false , the fields are sorted in descending order.')
field
class-attribute
instance-attribute
¶
field = Field(None, description='Specifies the name of the field on which the result set is sorted.')
SuggestMaxCpcRequest ¶
Bases: EbayModel
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description='A comma delimited array of listing Ids the seller plans to associate with the smart targeting campaign for which the maxCpc will be suggested.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The unique identifier of the marketplace where the listings are hosted. See Marketplace ID values for supported values.')
SuggestedBids ¶
Bases: EbayModel
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text for the keyword.')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
proposed_bid
class-attribute
instance-attribute
¶
proposed_bid = Field(None, alias='proposedBid', description='The suggested bid associated with the keyword.')
TargetedBidsPagedCollection ¶
Bases: EbayModel
suggested_bids
class-attribute
instance-attribute
¶
suggested_bids = Field(None, alias='suggestedBids', description='A list of bids in the paginated collection.')
TargetedKeywordRequest ¶
Bases: EbayModel
additional_info
class-attribute
instance-attribute
¶
additional_info = Field(None, alias='additionalInfo', description='A field used to indicate whether additional information and insight data shall be provided for suggested keywords. Use this array to retrieve keyword insights, including active seller count and search volume. Valid Value: KEYWORD_INSIGHTS')
exclusions
class-attribute
instance-attribute
¶
exclusions = Field(None, description='A field used to indicate that the keywords already selected by sellers for the specified listing IDs should be filtered out of the response, and only new and unique keyword recommendations shall be returned. Valid Value: ADOPTED_KEYWORDS')
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description='A set of comma-separated listing IDs for the specific listings you wish to retrieve suggested keywords. Maximum number of listings requested: 300')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
TargetingMetricsEnum ¶
Bases: OpenStrEnum
TaskStatusEnum ¶
UpdateAdStatusByListingIdRequest ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. Use the getAdGroups method to retrieve the ad group IDs for a seller.')
ad_status
class-attribute
instance-attribute
¶
ad_status = Field(None, alias='adStatus', description='An enumeration value representing the current status of the ad. Valid Values: ACTIVE PAUSED ARCHIVED')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned identifier for a listing that is generated when the listing is created. Note: This field accepts both listing IDs (as generated by the Inventory API), and item IDs (as used in the eBay Traditional API set, such as the Trading and Finding APIs).')
UpdateAdStatusRequest ¶
Bases: EbayModel
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned identifier for an ad that belongs to the specified campaign. Use the getAds method to retrieve ad IDs.')
ad_status
class-attribute
instance-attribute
¶
ad_status = Field(None, alias='adStatus', description='An enumeration value representing the status you wish to update the specified ad to. Valid Values: ACTIVE PAUSED ARCHIVED')
UpdateAdrateStrategyRequest ¶
Bases: EbayModel
ad_rate_strategy
class-attribute
instance-attribute
¶
ad_rate_strategy = Field(None, alias='adRateStrategy', description='This field is used to change the current ad rate strategy for a Cost Per Sale (CPS) campaign. It is not needed if the ad rate strategy is not being changed for the campaign. Note: This field is not applicable for offsite campaigns.')
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description='The user-defined bid percentage (also known as the ad rate ) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.')
dynamic_ad_rate_preferences
class-attribute
instance-attribute
¶
dynamic_ad_rate_preferences = Field(None, alias='dynamicAdRatePreferences', description='A field that indicates whether a single, user-defined bid percentage (also known as the ad rate ) should be used, or whether eBay should automatically adjust listings to maintain the daily suggested bid percentage. Note: Dynamic adjustment is only applicable when the adRateStrategy is set to DYNAMIC . Default: FIXED')
UpdateBidPercentageRequest ¶
Bases: EbayModel
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description='The updated bid percentage value for the specified ad in the specified campaign. The bid percentage (also known as the ad rate ) is a user-defined value which sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing.')
UpdateCampaignIdentificationRequest ¶
Bases: EbayModel
campaign_name
class-attribute
instance-attribute
¶
campaign_name = Field(None, alias='campaignName', description="The new seller-defined name for the campaign. This value must be unique for the seller. If you don't want to change the name of the campaign, specify the current campaign name in this field. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters.")
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the campaign ends, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description="The new start date for the campaign, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). If the campaign status is RUNNING or PAUSED , the startDate must be specified and must be the actual start date of the campaign, even if you are only changing the endDate . You can retrieve the campaign's startDate using the getCampaign method.")
UpdateCampaignRequest ¶
Bases: EbayModel
audience_codes
class-attribute
instance-attribute
¶
audience_codes = Field(None, alias='audienceCodes', description='An array of audience codes for the audiences of the email campaign. At least one audience code is required. There is no limit to the number of audience codes that may be entered. Example: if the current email campaign contains "audienceCodes": "code1", "code2" and the user wishes to add an audience code code3 , set the audienceCodes value to "audienceCodes": "code1", "code2", "code3" .')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of either an eBay category or a store category. This field is used if a seller wants to apply an email campaign to a specific eBay category or store category. The categoryType determines whether the categoryId value is an eBay category or store category. Use the Taxonomy API to retrieve eBay categories. To retrieve seller store categories, use the getStore call.')
category_type
class-attribute
instance-attribute
¶
category_type = Field(None, alias='categoryType', description='This field must be set when applying an email campaign to a specific eBay category or store category. The enumeration value used indicates which type of category the categoryId belongs to.')
item_ids
class-attribute
instance-attribute
¶
item_ids = Field(None, alias='itemIds', description='An array of unique identifiers for the listings displayed in an email campaign. Used if the seller wishes to select the eBay listings in the email campaign rather than have eBay automatically select them. Call getSellerList to retrieve all seller listings. Each Item result contains an ItemID value. Use this value in itemIds to feature that listing.')
item_select_mode
class-attribute
instance-attribute
¶
item_select_mode = Field(None, alias='itemSelectMode', description='Determines whether listings featured in an email campaign are selected by the seller or by eBay. If itemSelectMode is set to AUTO , eBay automatically choses listings based on values set for sort , categoryType , categoryId , and priceRange . If itemSelectMode is set to MANUAL , listings are set by the seller by populating the itemIds array.')
personalized_message
class-attribute
instance-attribute
¶
personalized_message = Field(None, alias='personalizedMessage', description='The body of the email campaign. Accepts HTML and CSS. The maximum length is 1000 characters')
price_range
class-attribute
instance-attribute
¶
price_range = Field(None, alias='priceRange', description='This container is used if the seller wants to apply the email campaign to listings based on a price range. The priceRange container consists of the currency , gte , and lte fields. "gte" stands for "greater than or equal to" and "lte" stands for "less than or equal to". Either gte , lte , or both must be used if the seller wishes to include a price range.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="The ID of the discount used for an email campaign if the emailCampaignType is set to COUPON , SALE_EVENT , or ORDER_DISCOUNT , and promotionSelectModeEnum is set to MANUAL . To find a discount, call getPromotions to retrieve a list of the seller's discounts. Use the promotionId from an individual PromotionDetail result for the request.")
promotion_select_mode_enum
class-attribute
instance-attribute
¶
promotion_select_mode_enum = Field(None, alias='promotionSelectModeEnum', description='The selection mode for the discount used. If set to AUTO , eBay will choose the discount to include in the email campaign. If set to MANUAL , the seller must specify the discount in the promotionId field. This field is required if the emailCampaignType is set to COUPON , SALE_EVENT , or ORDER_DISCOUNT .')
schedule_date
class-attribute
instance-attribute
¶
schedule_date = Field(None, alias='scheduleDate', description='The date and time that the email campaign newsletter will be sent, given in UTC format. Example: 2023-05-20T03:13:35Z This field should be used if the seller wishes to send the email campaign on a future date. If no scheduleDate is set, the email campaign will send once it is created or updated.')
sort
class-attribute
instance-attribute
¶
sort = Field(None, description='The sort rule is used to display the listings featured in the email campaign. Sort rules are only used if itemSelectMode is set to AUTO . If itemSelectMode is MANUAL , listings are displayed in the order in which they are listed in the itemIds array. The following sort rules are available: ENDING_FIRST displays listings by ending date, from soonest to latest.')
subject
class-attribute
instance-attribute
¶
subject = Field(None, description='The email campaign subject. The maximum length is 70 characters.')
UpdateEmailCampaignResponse ¶
Bases: EbayModel
email_campaign_id
class-attribute
instance-attribute
¶
email_campaign_id = Field(None, alias='emailCampaignId', description='The unique eBay-assigned ID to the email campaign that is generated when the email campaign is created.')
email_campaign_status
class-attribute
instance-attribute
¶
email_campaign_status = Field(None, alias='emailCampaignStatus', description='The email campaign status. See EmailCampaignStatusEnum for a list of email campaign statuses and their descriptions.')
UpdateNegativeKeywordIdRequest ¶
Bases: EbayModel
negative_keyword_id
class-attribute
instance-attribute
¶
negative_keyword_id = Field(None, alias='negativeKeywordId', description='A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword. Use the getNegativeKeywords method to retrieve negative keyword IDs.')
negative_keyword_status
class-attribute
instance-attribute
¶
negative_keyword_status = Field(None, alias='negativeKeywordStatus', description='A field that defines the status of the negative keyword. See NegativeKeywordStatusEnum for supported values.')
UpdateNegativeKeywordRequest ¶
Bases: EbayModel
negative_keyword_status
class-attribute
instance-attribute
¶
negative_keyword_status = Field(None, alias='negativeKeywordStatus', description='A field that defines the status of the negative keyword.')
UpdateAdStatusByInventoryReferenceIdRequest ¶
Bases: RootModel[Any | None]
AdditionalInfoData ¶
Bases: EbayModel
metric_key
class-attribute
instance-attribute
¶
metric_key = Field(None, alias='metricKey', description='The metric used to provide additional information for the suggested keyword. Valid Values: ACTIVE_SELLER_COUNT SEARCH_VOLUME')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The data provided for the specified metric. Note: All metric data is compiled for the marketplace associated with the specified campaign ID.')
AlertDimension ¶
Bases: EbayModel
key
class-attribute
instance-attribute
¶
key = Field(None, description='The key field of the applied dimension. For example, the marketplace Id.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value field of the applied dimension. For example, if the key is a MARKETPLACE_ID , the value would be from Marketplace ID values .')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the specified currency . Required in the amount type.')
Aspect ¶
Bases: EbayModel
key
class-attribute
instance-attribute
¶
key = Field(None, description='The type of the aspect. For example, MINIMUM_REQUIRED .')
value
class-attribute
instance-attribute
¶
value = Field(None, description="The value of the aspect. For example, if the aspect is a percentage, a value of '2.0' would equal 2%.")
Budget ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The allocated budget amount for a CPC Promoted Listings campaign.')
budget_status
class-attribute
instance-attribute
¶
budget_status = Field(None, alias='budgetStatus', description='The budget status for a CPC Promoted Listings campaign.')
BudgetRequest ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The allocated budget amount for a CPC Promoted Listings campaign. Both the currency and value must be specified.')
BulkCreateAdRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array of listing IDs and their associated bid percentages, which the request uses to create ads in bulk. This request accepts both listing IDs, as generated by the Inventory API, and an item IDs, as used in the eBay Traditional API set (e.g., the Trading and Finding APIs). Maximum: 500 IDs per call')
BulkDeleteAdRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array of the listing IDs that identify the ads to remove.')
BulkUpdateAdStatusByInventoryReferenceIdRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array of listing IDs and bid percentages.')
BulkUpdateAdStatusByListingIdRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array of listing IDs, adStatus values, and adGroupId values.')
BulkUpdateAdStatusRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array of listing IDs and adStatus pairs.')
BulkUpdateNegativeKeywordRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='An array to update the statuses of one or more existing negative keywords.')
CampaignBudget ¶
Bases: EbayModel
daily
class-attribute
instance-attribute
¶
daily = Field(None, description="The daily budget limit for the Cost Per Click (CPC) Promoted Listings campaign. Required if the campaign's funding model is CPC. This will be a dollar value. All clicks using the keywords defined for the campaign will go towards expending the daily budget. Once the daily budget is exceeded for the campaign, all Promoted Listings under the campaign will be turned off until the next day.")
CampaignBudgetRequest ¶
Bases: EbayModel
daily
class-attribute
instance-attribute
¶
daily = Field(None, description="The daily budget limit for a CPC Promoted Listings campaign. When running an offsite campaign, eBay may spend more or less than the seller's daily budget to capitalize on interested buyers, but will not exceed 2x the daily budget. The average over the course of the campaign will not exceed the provided daily budget.")
CampaignDTO ¶
Bases: EbayModel
audiences
class-attribute
instance-attribute
¶
audiences = Field(None, description='The audiences that the email campaign is being sent to. See AudienceTypeEnum for a list of audience types.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date and time that the email campaign was created, given in UTC format.')
email_campaign_id
class-attribute
instance-attribute
¶
email_campaign_id = Field(None, alias='emailCampaignId', description='The unique eBay identifier for the email campaign assigned automatically when the email campaign is created.')
email_campaign_status
class-attribute
instance-attribute
¶
email_campaign_status = Field(None, alias='emailCampaignStatus', description='The email campaign status. See EmailCampaignStatusEnum for information on statuses.')
email_campaign_type
class-attribute
instance-attribute
¶
email_campaign_type = Field(None, alias='emailCampaignType', description='The email campaign type. See CampaignTypeEnum for definitions of email campaign types.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace where the email campaign is active.')
modification_date
class-attribute
instance-attribute
¶
modification_date = Field(None, alias='modificationDate', description='The date and time the email campaign was last modified, given in UTC format.')
schedule_date
class-attribute
instance-attribute
¶
schedule_date = Field(None, alias='scheduleDate', description='The date and time that the email campaign newsletter is scheduled to send, given in UTC format.')
schedule_date_type
class-attribute
instance-attribute
¶
schedule_date_type = Field(None, alias='scheduleDateType', description='The schedule type used for sending the email campaign. See ScheduleDateTypeEnum for available schedule types.')
sent_date
class-attribute
instance-attribute
¶
sent_date = Field(None, alias='sentDate', description='The date and time that the email campaign was last sent, given in UTC format.')
subject
class-attribute
instance-attribute
¶
subject = Field(None, description='The email campaign subject line..')
CouponConfiguration ¶
Bases: EbayModel
coupon_code
class-attribute
instance-attribute
¶
coupon_code = Field(None, alias='couponCode', description='A unique code that buyers can use during checkout to receive a discount. The code must be unique across eBay. The code must be from 8-15 alphanumeric characters and can contain no more than two dashes ( - ). This is required when the discount type is CODED_COUPON.')
coupon_type
class-attribute
instance-attribute
¶
coupon_type = Field(None, alias='couponType', description="This indicates the type of Coded Coupon discount, and is required when the discount type is CODED_COUPON . Supported types: PRIVATE_SINGLE_SELLER_COUPON: Anyone can use and share the coupon code, but it isn't posted on eBay. PUBLIC_SINGLE_SELLER_COUPON: Anyone can find the coupon code on eBay and use it.")
max_coupon_redemption_per_user
class-attribute
instance-attribute
¶
max_coupon_redemption_per_user = Field(None, alias='maxCouponRedemptionPerUser', description='This sets the limit on the number of times a buyer can use this coupon. The range of values is 1-10. If no value is provided, a buyer can use the coupon an unlimited number of times.')
CreateAdGroupRequest ¶
Bases: EbayModel
default_bid
class-attribute
instance-attribute
¶
default_bid = Field(None, alias='defaultBid', description='A bid amount that applies to all of the keywords in an ad group that do not have individual bids.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name of the ad group.')
CreateAdsByInventoryReferenceRequest ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='Note: This field is not currently in use. Ad groups are only applicable to priority strategy ad campaigns that use the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.')
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description="The user-defined bid percentage (also known as the ad rate ) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. Required if the campaign's funding model is Cost Per Sale (CPS). The value specified here is also used to calculate the Promoted Listings fee.")
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The unique identifier of a single-item listing or a multi-variation listing. To create an ad for a single-item listing, set the inventoryReferenceType value to INVENTORY_ITEM and specify an item ID or a SKU (if the SKU is defined in the listing).')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='This enumerated value indicates the type of item the inventoryReferenceId references. The item can be either an INVENTORY_ITEM or an INVENTORY_ITEM_GROUP .')
CreateEmailCampaignRequest ¶
Bases: EbayModel
audience_codes
class-attribute
instance-attribute
¶
audience_codes = Field(None, alias='audienceCodes', description='An array of audience codes for the audiences of the email campaign. At least one audience code is required. There is no upper limit to the number of audience codes. To retrieve seller audiences, call getAudiences . Use the code values in the response to populate audienceCodes .')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of either an eBay category or a store category. This field is used if a seller wants to apply an email campaign to a specific eBay category or store category. The categoryType determines whether the categoryId value is an eBay category or store category. Use the Taxonomy API to retrieve eBay categories. To retrieve seller store categories, use the getStore call.')
category_type
class-attribute
instance-attribute
¶
category_type = Field(None, alias='categoryType', description='This field must be set when applying an email campaign to a specific eBay category or store category. The enumeration value used indicates which type of category the categoryId belongs to.')
email_campaign_type
class-attribute
instance-attribute
¶
email_campaign_type = Field(None, alias='emailCampaignType', description='The email campaign type of the email campaign being created. There are six email campaigns that a user can create: WELCOME - an email sent automatically to new subscribers. ITEM_SHOWCASE - an email featuring new products & collections that the seller wants to highlight. COUPON - an email containing a coupon code and up to 4 items that this coupon can be applied to.')
item_ids
class-attribute
instance-attribute
¶
item_ids = Field(None, alias='itemIds', description='An array of unique identifiers for the listings displayed in an email campaign. Used if the seller wishes to select the eBay listings in the email campaign rather than have eBay automatically select them. Call getSellerList to retrieve all seller listings. Each Item result contains an ItemID value. Use this value in itemIds to feature that listing.')
item_select_mode
class-attribute
instance-attribute
¶
item_select_mode = Field(None, alias='itemSelectMode', description='Determines whether listings featured in an email campaign are selected by the seller or by eBay. If itemSelectMode is set to AUTO , eBay automatically choses listings based on values set for sort , categoryType , categoryId , and priceRange . If itemSelectMode is set to MANUAL , listings are set by the seller by populating the itemIds array.')
personalized_message
class-attribute
instance-attribute
¶
personalized_message = Field(None, alias='personalizedMessage', description='The body of the email campaign. Accepts HTML and CSS. Max length: 1000')
price_range
class-attribute
instance-attribute
¶
price_range = Field(None, alias='priceRange', description='This container is used if the seller wants to apply the email campaign to listings based on a price range. The priceRange container consists of the currency , gte , and lte fields. "gte" stands for "greater than or equal to" and "lte" stands for "less than or equal to". Either gte , lte , or both must be used. currency is a required field if including a price range.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="The unique identifier of the discount used for an email campaign if the emailCampaignType is set to COUPON , SALE_EVENT , or ORDER_DISCOUNT . promotionSelectModeEnum must set to MANUAL if a discount is selected. Call getPromotions to retrieve a list of the seller's discounts. Use the promotionId from an individual PromotionDetail in the result to populate the request.")
promotion_select_mode_enum
class-attribute
instance-attribute
¶
promotion_select_mode_enum = Field(None, alias='promotionSelectModeEnum', description='The selection mode for the discount used if the emailCampaignType is set to COUPON , SALE_EVENT , or ORDER_DISCOUNT . If promotionSelectModeEnum is set to AUTO , eBay will choose the discount to include in the email campaign. If set to MANUAL , the seller must specify the discount in the promotionId field.')
schedule_date
class-attribute
instance-attribute
¶
schedule_date = Field(None, alias='scheduleDate', description='The date and time that the email campaign newsletter will be sent, given in UTC format. Example: 2023-05-20T03:13:35Z This field should be used if the seller wishes to send the email campaign on a future date. If no scheduleDate is set, the email campaign will send once it is created or updated.')
sort
class-attribute
instance-attribute
¶
sort = Field(None, description='The sort rule is used to display the listings featured in the email campaign. Sort rules are only used if itemSelectMode is set to AUTO . If itemSelectMode is MANUAL , listings are displayed in the order in which they are listed in the itemIds array. The following sort rules are available: ENDING_FIRST displays listings by ending date, from soonest to latest.')
subject
class-attribute
instance-attribute
¶
subject = Field(None, description='The subject line of the email campaign. Max length: 70')
CreateEmailCampaignResponse ¶
Bases: EbayModel
email_campaign_id
class-attribute
instance-attribute
¶
email_campaign_id = Field(None, alias='emailCampaignId', description='The unique eBay-assigned identifier of the email campaign. It is generated automatically when the email campaign is created. This value is returned unless there is an error.')
email_campaign_status
class-attribute
instance-attribute
¶
email_campaign_status = Field(None, alias='emailCampaignStatus', description='The status of the email campaign. ACTIVE is returned for email campaigns that have been successfully created but not been sent. SENT is returned for email campaigns that have already been sent. ERROR is returned when an email has not been successfully created.')
CreateKeywordRequest ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description="This adGroupId is created when an ad group is first created and associated with a campaign. This is the ad group that the corresponding keyword will be added to. This ad group must be a part of the campaign that is specified in the call URI. Use the getAdGroups method to retrieve the ad group IDs for a seller, and getKeywords to retrieve the keyword IDs for a seller's keywords.")
bid
class-attribute
instance-attribute
¶
bid = Field(None, description='This container is used to set the maximum bid for the keyword. Each time a listing is retrieved in search results using this keyword and clicked on, the seller will be charged, at most, this amount. Each click goes toward the daily budget set up for the CPC campaign. If the bid is not provided, then the default bid associated with the ad group is used.')
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball). Maximum number of characters: 100 Maximum number of words: 10')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
CreateNegativeKeywordRequest ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='This adGroupId is created when an ad group is first created and associated with a campaign. This is the ad group to which the corresponding negative keyword will be added. Use the getAdGroups method to retrieve the ad group IDs for a seller. Required if the negative keyword is being created at the ad group level.')
campaign_id
class-attribute
instance-attribute
¶
campaign_id = Field(None, alias='campaignId', description='This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the set of negative keywords being created. Use the getCampaigns method to retrieve campaign IDs. Required if the negative keyword is being created at the ad group level.')
negative_keyword_match_type
class-attribute
instance-attribute
¶
negative_keyword_match_type = Field(None, alias='negativeKeywordMatchType', description='A field that defines the match type for the negative keyword. Note: Broad matching of negative keywords is not currently supported. Valid Values: EXACT PHRASE')
negative_keyword_text
class-attribute
instance-attribute
¶
negative_keyword_text = Field(None, alias='negativeKeywordText', description='The negative keyword text.')
DeleteAdsByInventoryReferenceRequest ¶
Bases: EbayModel
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The unique identifier of a single-item listing or a multi-variation listing. To create an ad for a single-item listing, set the inventoryReferenceType value to INVENTORY_ITEM and specify an item ID or a SKU (if the SKU is defined in the listing).')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='This enumerated value indicates the type of item the inventoryReferenceId references. The item can be either an INVENTORY_ITEM or an INVENTORY_ITEM_GROUP .')
DiscountBenefit ¶
Bases: EbayModel
amount_off_item
class-attribute
instance-attribute
¶
amount_off_item = Field(None, alias='amountOffItem', description='The monetary amount that is discounted off an item (or items) when the discount criteria is met.')
amount_off_order
class-attribute
instance-attribute
¶
amount_off_order = Field(None, alias='amountOffOrder', description="Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met. Because this field is valid only for orders, it's not a valid combination to use with markdown discounts. Valid values for the associated amountOffOrder.")
percentage_off_item
class-attribute
instance-attribute
¶
percentage_off_item = Field(None, alias='percentageOffItem', description='The percentage applied to the sales price that is discounted off the discounted item (or items) when the discount criteria is met. Valid integer values for percentage off: Min: 5 Max: 80')
percentage_off_order
class-attribute
instance-attribute
¶
percentage_off_order = Field(None, alias='percentageOffOrder', description='Used for threshold discounts, this is the percentage of the order price that is discounted off the order when the discount criteria is met. This field is not value for markdown discounts. Valid integer values for ORDER_DISCOUNT discounts: Min: 5 Max: 80 For VOLUME_DISCOUNT discounts: Must be set to 0 for the first discount rule.')
DiscountSpecification ¶
Bases: EbayModel
for_each_amount
class-attribute
instance-attribute
¶
for_each_amount = Field(None, alias='forEachAmount', description='The monetary amount that must be spent on discounted items before the discount is applied. Valid values for the associated forEachAmount value field: 5 , 10 , 15 , 20 , 25 , 30 , 35 , 40 , 45 , 49 , 50 , 55 , 59 , 60 , 65 , 69 , 70 , 75 , 79 , 80 , 85 , 89 , 90 , 95 , 99 , 100 , 110 , 120 , 125 , 149 , 150 , 175 , 199 , 200 , 249 , 250 , 299 , 300 , 350 , 399 , 400 , 450 , 499 , 500')
for_each_quantity
class-attribute
instance-attribute
¶
for_each_quantity = Field(None, alias='forEachQuantity', description='The number of items that must be purchased in order to qualify for the discount. Valid values: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 20 , 25 , 50 , 75 , 1001 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 20 , 25 , 50 , 75 , 100')
min_amount
class-attribute
instance-attribute
¶
min_amount = Field(None, alias='minAmount', description='Known as the "threshold amount", the minimum dollar amount that needs to be spent on discounted items in order to qualify for the discount.')
min_quantity
class-attribute
instance-attribute
¶
min_quantity = Field(None, alias='minQuantity', description='The minimum quantity of discounted items that needs to be bought in order to qualify for the discount. Valid values: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 20 , 25 , 50 , 75 , 100')
number_of_discounted_items
class-attribute
instance-attribute
¶
number_of_discounted_items = Field(None, alias='numberOfDiscountedItems', description='Use this field to configure "Buy One Get One" (or BOGO ) discounts. You must couple this field with forEachQuantity and an amountOffItem or percentOffItem field to configure your BOGO discount. This field is not valid with order-based discounts. The value of this field represents the number of items to be discounted when other discount criteria is met.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description="The category type for this error or warning. It takes an ErrorCategory object which can have one of three values: Application : Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.")
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name of the domain containing the service or application.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.")
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='An expanded version of message that should be around 100-200 characters long, but is not required to be such.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value .')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description="Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.")
GetEmailCampaignResponse ¶
Bases: EbayModel
audiences
class-attribute
instance-attribute
¶
audiences = Field(None, description='An array of one or more audiences associated with the email campaign.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of an eBay category or an eBay store category. This field is returned if a seller has applied the email campaign to a specific category. The categoryType value will indicate if the category ID is for an eBay category or an eBay store category.')
category_type
class-attribute
instance-attribute
¶
category_type = Field(None, alias='categoryType', description='The enumeration value returned here indicates if the categoryId value is the identifier of an eBay category or an eBay store category. This field is returned if a seller has applied the email campaign to a specific category.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date and time that the email campaign was created, given in UTC format.')
email_campaign_id
class-attribute
instance-attribute
¶
email_campaign_id = Field(None, alias='emailCampaignId', description='The unique identifier of the email campaign.')
email_campaign_status
class-attribute
instance-attribute
¶
email_campaign_status = Field(None, alias='emailCampaignStatus', description='The email campaign status. See EmailCampaignStatusEnum for a list of valid statuses.')
email_campaign_type
class-attribute
instance-attribute
¶
email_campaign_type = Field(None, alias='emailCampaignType', description='The email campaign type. See CampaignTypeEnum for valid email campaign types.')
item_ids
class-attribute
instance-attribute
¶
item_ids = Field(None, alias='itemIds', description='The listing IDs of the items that were manually added to the email campaign. Only listings added manually by the seller are returned. Returns a null array if no listings were added.')
item_select_mode
class-attribute
instance-attribute
¶
item_select_mode = Field(None, alias='itemSelectMode', description='The mode used to select the items listed in the email campaign.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace where the email campaign is active. See MarketplaceIdEnum for a list of marketplace IDs.')
modification_date
class-attribute
instance-attribute
¶
modification_date = Field(None, alias='modificationDate', description='The date and time the email campaign was last modified, given in UTC format.')
personalized_message
class-attribute
instance-attribute
¶
personalized_message = Field(None, alias='personalizedMessage', description='The body of the email campaign sent to the audience.')
price_range
class-attribute
instance-attribute
¶
price_range = Field(None, alias='priceRange', description='The price range and currency set within the email campaign. This container will only return if a price range was set.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description='The ID of the discount that was assigned to the email campaign.')
promotion_select_mode
class-attribute
instance-attribute
¶
promotion_select_mode = Field(None, alias='promotionSelectMode', description='Indicates whether the listings that the discount was applied to were selected manually or automatically. This field will only return if a discount was applied.')
schedule_date
class-attribute
instance-attribute
¶
schedule_date = Field(None, alias='scheduleDate', description='The date and time that the email campaign newsletter is scheduled to send, given in UTC format. This field is only returned if the seller set the start of the email campaign to a date in the future.')
schedule_date_type
class-attribute
instance-attribute
¶
schedule_date_type = Field(None, alias='scheduleDateType', description='The schedule type of the email campaign. See ScheduleDateTypeEnum .')
sent_date
class-attribute
instance-attribute
¶
sent_date = Field(None, alias='sentDate', description='The date and time that the email campaign was sent, given in UTC format.')
sort
class-attribute
instance-attribute
¶
sort = Field(None, description='The sort rule is used to display the items in the email campaign. If no sort rule was selected, the default will be NEWLY_LISTED .')
subject
class-attribute
instance-attribute
¶
subject = Field(None, description='The email campaign subject.')
GetEmailCampaignsResponse ¶
Bases: EbayModel
campaigns
class-attribute
instance-attribute
¶
campaigns = Field(None, description='A list of email campaigns that match the search criteria.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of store email campaigns.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of store email campaigns to return on a page from the result set.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This value indicates the offset used for current page of store email campaigns being returned.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='Total number of available results returned under the filter criteria submitted in the request.')
GetEmailReportResponse ¶
Bases: EbayModel
click_count
class-attribute
instance-attribute
¶
click_count = Field(None, alias='clickCount', description='The number of item listing links clicked from the body of campaign emails for the time range specified by the query.')
open_count
class-attribute
instance-attribute
¶
open_count = Field(None, alias='openCount', description='The total email opened count for all email campaigns from a seller for the time range specified by the query.')
total_sales
class-attribute
instance-attribute
¶
total_sales = Field(None, alias='totalSales', description="A seller's total sale amount for the time range specified by the query.")
InventoryItem ¶
Bases: EbayModel
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The unique identifier of a single-item listing or a multi-variation listing.')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='Indicates the type of the inventoryReferenceId , which can be either INVENTORY_ITEM or INVENTORY_ITEM_GROUP . Note: This value is not currently returned in the response.')
InventoryReference ¶
Bases: EbayModel
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The unique identifier of a single-item listing or a multi-variation listing. To create an ad for a single-item listing, set the inventoryReferenceType value to INVENTORY_ITEM and specify an item ID or a SKU (if the SKU is defined in the listing).')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='Indicates the type of item indicated by the inventoryReferenceId . This value can be set to either INVENTORY_ITEM or INVENTORY_ITEM_GROUP . Required if if you supply an inventoryReferenceId .')
ItemBasis ¶
Bases: EbayModel
estimated_value
class-attribute
instance-attribute
¶
estimated_value = Field(None, alias='estimatedValue', description='The estimated value of the search impressions for items based on the provided dimensions. Duration: 17 days Total slots: 200 Channel: Dweb, Mweb, Native')
metric
class-attribute
instance-attribute
¶
metric = Field(None, description='The basis of the statistics.')
ItemMarkdownStatus ¶
Bases: EbayModel
listing_markdown_status
class-attribute
instance-attribute
¶
listing_markdown_status = Field(None, alias='listingMarkdownStatus', description='Indicates the state assigned to the markdown discount using one of the status values.')
status_changed_date
class-attribute
instance-attribute
¶
status_changed_date = Field(None, alias='statusChangedDate', description='Identifies the date the last time the state of the discount changed. Both both markdown and markup events can trigger a status change.')
status_message
class-attribute
instance-attribute
¶
status_message = Field(None, alias='statusMessage', description='An eBay-assigned text string that describes the status of the discount.')
Keyword ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='This field identifies the ad group that the keyword is associated with.')
bid
class-attribute
instance-attribute
¶
bid = Field(None, description='The bid associated with the keyword. This container will not be returned if the keyword does not have a defined bid value.')
keyword_id
class-attribute
instance-attribute
¶
keyword_id = Field(None, alias='keywordId', description='The unique identifier of a keyword.')
keyword_status
class-attribute
instance-attribute
¶
keyword_status = Field(None, alias='keywordStatus', description='The status of the keyword. Valid Values: ACTIVE PAUSED ARCHIVED')
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text of the keyword.')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
KeywordPagedCollectionResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the current page of results from the result set.')
keywords
class-attribute
instance-attribute
¶
keywords = Field(None, description='This array contains all of the keywords that match the request criteria. Keywords will be sorted by adGroupId, regardless of whether you searched for keywords across the entire campaign, or if you searched for keywords within one or specific ad groups.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of keywords returned on a single page from the result set. This value can be set in the request with the limit query parameter.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Max length : 2048')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of keywords retrieved in the result set. If no keywords are found, this field is returned with a value of 0 .')
KeywordRequest ¶
Bases: EbayModel
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball). You can use the getKeywords method to retrieve keyword values currently associated with the specified ad group. Maximum number of characters: 100 Maximum number of words: 10')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
KeywordResponse ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='The identifier of the ad group that the keyword was added to.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there is an issue creating the corresponding keyword and/or adding that keyword to the corresponding ad group.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The getKeyword URI for the keyword, which is used to retrieve the keyword. This URI will be returned for each successfully created keyword.')
keyword_id
class-attribute
instance-attribute
¶
keyword_id = Field(None, alias='keywordId', description='A unique eBay-assigned ID for a keyword that is generated for an ad group. This keyword ID will be generated for each successfully created keyword.')
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text of the keyword.')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code is returned for each keyword to indicate the success or failure of adding that keyword to the ad group.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='List of warnings associated with this operation')
ListingDetail ¶
Bases: EbayModel
current_price
class-attribute
instance-attribute
¶
current_price = Field(None, alias='currentPrice', description='The container that returns the current price of the listing.')
free_shipping
class-attribute
instance-attribute
¶
free_shipping = Field(None, alias='freeShipping', description='If set to true , the seller pays for the shipping (or that the item is marked for local pickup only) In this case, the listing does not have an associated shipping cost for the first listed domestic-shipping option (even if the first domestic-shipping option specifies a flat-rate or calculated shipping option).')
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The seller\'s inventory reference ID for a listing. Also known as the "SKU" or "custom label," an inventory reference ID is either the ID of the listing or, if the listing has variations (such as a shirt that\'s available in multiple sizes and colors), the ID of the parent listing.')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='Indicates the type of the inventoryReferenceId , which can be either a single-SKU or a multi-SKU listing ( INVENTORY_ITEM and INVENTORY_ITEM_GROUP , respectively). Note: This value is not currently returned in the response.')
listing_category_id
class-attribute
instance-attribute
¶
listing_category_id = Field(None, alias='listingCategoryId', description='The ID of the category that listing belongs to. The ID is a numeric and unique identifier for the category that is assigned by eBay.')
listing_condition
class-attribute
instance-attribute
¶
listing_condition = Field(None, alias='listingCondition', description='An eBay-assigned value that indicates condition of the associated item. For more information, see Item condition ID and name values .')
listing_condition_id
class-attribute
instance-attribute
¶
listing_condition_id = Field(None, alias='listingConditionId', description='The ID of the condition associated with the item. For more information, see Item condition ID and name values . Note: This value is not currently returned in the response.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID that is generated when the item is listed.')
listing_promotion_statuses
class-attribute
instance-attribute
¶
listing_promotion_statuses = Field(None, alias='listingPromotionStatuses', description='A list of the status values assigned to the item and the date that each new status was assigned.')
quantity
class-attribute
instance-attribute
¶
quantity = Field(None, description='The number of items being sold in the listing.')
store_category_id
class-attribute
instance-attribute
¶
store_category_id = Field(None, alias='storeCategoryId', description='Store CategoryId (if any) that to which the listing belongs. This field is blank if there is no seller Store category ID.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-defined title of the listing that a seller can use to identify the item. This label is not displayed in end-user flows.')
MaxCpc ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The allocated maximum CPC amount for a smart targeting campaign. Both the currency and amount must be specified when allocating the Max CPC.')
NegativeKeyword ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='An ad group ID that is generated when an ad group is first created and associated with a campaign. Note: You can call the getAdGroups method to retrieve the ad group IDs for a seller.')
campaign_id
class-attribute
instance-attribute
¶
campaign_id = Field(None, alias='campaignId', description='A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.')
negative_keyword_id
class-attribute
instance-attribute
¶
negative_keyword_id = Field(None, alias='negativeKeywordId', description='A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword.')
negative_keyword_match_type
class-attribute
instance-attribute
¶
negative_keyword_match_type = Field(None, alias='negativeKeywordMatchType', description='A field that defines the match type for the negative keyword. Note: Broad matching of negative keywords is not currently supported. Valid Values: EXACT PHRASE')
negative_keyword_status
class-attribute
instance-attribute
¶
negative_keyword_status = Field(None, alias='negativeKeywordStatus', description='A field that defines the status of the negative keyword.')
negative_keyword_text
class-attribute
instance-attribute
¶
negative_keyword_text = Field(None, alias='negativeKeywordText', description='The text for the negative keyword.')
NegativeKeywordPagedCollectionResponse ¶
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. This value can be set in the request with the limit query parameter.')
negative_keywords
class-attribute
instance-attribute
¶
negative_keywords = Field(None, alias='negativeKeywords', description='A list of negative keywords returned in the paginated collection.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Default: 0 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 call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of result sets in the paginated collection.')
NegativeKeywordResponse ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique identifier for an ad group that is generated when an ad group is first created and associated with a campaign.')
campaign_id
class-attribute
instance-attribute
¶
campaign_id = Field(None, alias='campaignId', description='A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there is an issue creating the corresponding negative keyword.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI for the negative keyword, which is used to retrieve the negative keyword. This URI will be returned for each successfully created negative keyword.')
negative_keyword_id
class-attribute
instance-attribute
¶
negative_keyword_id = Field(None, alias='negativeKeywordId', description='A unique eBay-assigned ID for a negative keyword. This negative keyword ID will be generated for each successfully created negative keyword.')
negative_keyword_match_type
class-attribute
instance-attribute
¶
negative_keyword_match_type = Field(None, alias='negativeKeywordMatchType', description='The match type for the negative keyword. Note: Broad matching of negative keywords is not currently supported. Valid Values: EXACT PHRASE')
negative_keyword_text
class-attribute
instance-attribute
¶
negative_keyword_text = Field(None, alias='negativeKeywordText', description='The text for the negative keyword.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='The status of the request to create a negative keyword. This field indicates whether the process was successful or not.')
PromotionDetail ¶
Bases: EbayModel
coupon_code
class-attribute
instance-attribute
¶
coupon_code = Field(None, alias='couponCode', description='A unique code that buyers can use during checkout to receive a discount. The code must be unique across eBay.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='This is the seller-defined "tag line" for the offer, such as "Save on designer shoes." Tag lines appear under the "offer-type text" that is generated for a discount and displayed under the offer tile that is shown on the seller\'s All Offers page and on the discount\'s event page.')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the discount ends in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace ID of the site where the discount is hosted. Threshold discounts are supported on a select set of marketplaces while markdown discounts are supported on all eBay marketplaces. Valid values for threshold discounts are as follows: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES = Spain EBAY_FR = France EBAY_GB = Great Britain EBAY_IT = Italy EBAY_US = United States')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name or "title" of the discount, such as "Buy 1 Get 1", that the seller can use to identify a discount. This label is not displayed in end-user flows. Maximum length: 90')
priority
class-attribute
instance-attribute
¶
priority = Field(None, description="Applicable for only ORDER_DISCOUNT discount, this field indicates the precedence of the discount, which is used to determine the position of a discount on the seller's All Offers page. If an item is associated with multiple discounts, the discount with the higher priority takes precedence.")
promotion_href
class-attribute
instance-attribute
¶
promotion_href = Field(None, alias='promotionHref', description='The URI of the discount details.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="A unique eBay-assigned ID for the discount that's generated when the discount is created.")
promotion_image_url
class-attribute
instance-attribute
¶
promotion_image_url = Field(None, alias='promotionImageUrl', description="Required for CODED_COUPON , MARKDOWN_SALE , and ORDER_DISCOUNT discount, and not applicable for VOLUME_DISCOUNT discounts, this field is a URL that points to an image for the discount. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size.")
promotion_status
class-attribute
instance-attribute
¶
promotion_status = Field(None, alias='promotionStatus', description='The current status of the discount. When creating a new discount, you must set this value to either DRAFT or SCHEDULED .')
promotion_type
class-attribute
instance-attribute
¶
promotion_type = Field(None, alias='promotionType', description='Indicates type of the discount, either CODED_COUPON , MARKDOWN_SALE , ORDER_DISCOUNT , or VOLUME_DISCOUNT .')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the discount starts in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
PromotionReportDetail ¶
Bases: EbayModel
average_item_discount
class-attribute
instance-attribute
¶
average_item_discount = Field(None, alias='averageItemDiscount', description='The average item discount is the average discount that has been applied to each item being discounted. This value is calculated as follows: totalDiscount / itemsSoldQuantity = averageItemDiscount')
average_item_revenue
class-attribute
instance-attribute
¶
average_item_revenue = Field(None, alias='averageItemRevenue', description='The average item revenue is the average revenue that has been received for each item being discounted.. This value is calculated as follows: totalSales / itemsSoldQuantity = averageItemRevenue')
average_order_discount
class-attribute
instance-attribute
¶
average_order_discount = Field(None, alias='averageOrderDiscount', description='The average order discount is the average discount that has been applied to each order that has an active discount. This value is calculated as follows: totalDiscount / numberOfOrdersSold = averageOrderDiscount')
average_order_revenue
class-attribute
instance-attribute
¶
average_order_revenue = Field(None, alias='averageOrderRevenue', description='The average order revenue is the average revenue that has been received for each order that has an active discount. This value is calculated as follows: totalSales / numberOfOrdersSold = averageOrderRevenue')
average_order_size
class-attribute
instance-attribute
¶
average_order_size = Field(None, alias='averageOrderSize', description='The average order size is the average number of items that each order contained that have an active discount. This value is calculated as follows: itemsSoldQuantity / numberOfOrdersSold = averageOrderSize')
base_sale
class-attribute
instance-attribute
¶
base_sale = Field(None, alias='baseSale', description='This is the monetary amount of items purchased that have been discounted where the threshold wasn\'t met , so the discount was not applied. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchased only one pair of socks, so they pay the full price of $5. Here, your baseSale amount would be $5.')
items_sold_quantity
class-attribute
instance-attribute
¶
items_sold_quantity = Field(None, alias='itemsSoldQuantity', description='This is the quantity of items purchased in a threshold discount where the threshold has been met and the discount was applied. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10).')
number_of_orders_sold
class-attribute
instance-attribute
¶
number_of_orders_sold = Field(None, alias='numberOfOrdersSold', description='This is the number of orders sold in a threshold discount where the threshold has been met and the discount was applied. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your numberOfOrdersSold would be 1 and your itemsSoldQuantity would be 2.')
percentage_sales_lift
class-attribute
instance-attribute
¶
percentage_sales_lift = Field(None, alias='percentageSalesLift', description='The percentage sales lift is the total dollar amount gained due to discounts. This value is calculated as follows: promotionSale / totalSale = percentageSalesLift')
promotion_href
class-attribute
instance-attribute
¶
promotion_href = Field(None, alias='promotionHref', description='The URI of the discount report.')
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="A unique eBay-assigned ID for the discount that's generated when the discount is created.")
promotion_report_id
class-attribute
instance-attribute
¶
promotion_report_id = Field(None, alias='promotionReportId', description='The unique eBay-assigned ID of the discount report that is generated when the report is created.')
promotion_sale
class-attribute
instance-attribute
¶
promotion_sale = Field(None, alias='promotionSale', description='This is the monetary amount of the items sold in a threshold discount where the threshold has been met and the discount was applied. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your promotionSale amount would be $7.50.')
promotion_type
class-attribute
instance-attribute
¶
promotion_type = Field(None, alias='promotionType', description='Indicates the type of the discount, either CODED_COUPON , MARKDOWN_SALE , ORDER_DISCOUNT , or VOLUME_DISCOUNT .')
total_discount
class-attribute
instance-attribute
¶
total_discount = Field(None, alias='totalDiscount', description='This is the monetary discount amount applied to the sale of items in a threshold discount where the threshold has been met and the discount was applied. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your totalDiscount amount would be $2.50.')
total_sale
class-attribute
instance-attribute
¶
total_sale = Field(None, alias='totalSale', description='This is the total monetary sales amount of all items sold that were discounted. For example, suppose you\'re running a "Buy 1, get 1 at 50%" discount on $5 socks. You make one sale where the buyer purchases only one pair of socks and they pay the full price of $5 ( baseSale ). You make a second sale where the buyer purchases two pairs of socks and they pay $7.50, for both pairs ( promotionSale ).')
PromotionsPagedCollection ¶
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. This value can be set in the request with the limit query parameter.')
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. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
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. Max length : 2048')
promotions
class-attribute
instance-attribute
¶
promotions = Field(None, description='A list containing the details of each returned discount. This includes all the information about the discounts except for the listings that are discounted.')
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 .')
PromotionsReportPagedCollection ¶
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. This value can be set in the request with the limit query parameter.')
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. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
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. Max length : 2048')
promotion_reports
class-attribute
instance-attribute
¶
promotion_reports = Field(None, alias='promotionReports', description='A list of promotionReports contained in the paginated result set.')
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 .')
ReportMetadata ¶
Bases: EbayModel
dimension_metadata
class-attribute
instance-attribute
¶
dimension_metadata = Field(None, alias='dimensionMetadata', description='A list containing the metadata for the dimension used in the report.')
max_number_of_dimensions_to_request
class-attribute
instance-attribute
¶
max_number_of_dimensions_to_request = Field(None, alias='maxNumberOfDimensionsToRequest', description='The maximum number of dimensions that can be requested for the specified report type.')
max_number_of_metrics_to_request
class-attribute
instance-attribute
¶
max_number_of_metrics_to_request = Field(None, alias='maxNumberOfMetricsToRequest', description='The maximum number of metrics that can be requested for the specified report type.')
channel
class-attribute
instance-attribute
¶
channel = Field(None, description='This field indicates whether a COST_PER_CLICK report type is related to an ON_SITE or OFF_SITE Promoted Listings campaign. This field is not returned for COST_PER_SALE report types since COST_PER_SALE campaigns are only available ON_SITE .')
metric_metadata
class-attribute
instance-attribute
¶
metric_metadata = Field(None, alias='metricMetadata', description='A list containing the metadata for the metrics in the report.')
report_type
class-attribute
instance-attribute
¶
report_type = Field(None, alias='reportType', description='The report_type , as specified in the request to create the report task. Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending.')
ReportMetadatas ¶
Bases: EbayModel
report_metadata
class-attribute
instance-attribute
¶
report_metadata = Field(None, alias='reportMetadata', description='A list of the metadata for the associated report type.')
ReportTask ¶
Bases: EbayModel
campaign_ids
class-attribute
instance-attribute
¶
campaign_ids = Field(None, alias='campaignIds', description="A list of IDs for the campaigns that are included in the report. A campaign ID is a unique eBay-assigned identifier of the campaign that's generated when the campaign is created. Call getCampaigns to return the current campaign IDs for a seller.")
channels
class-attribute
instance-attribute
¶
channels = Field(None, description='The channel for the advertising campaign that will be included in the report task. This value indicates whether the data included in the report task is for an Onsite or Offsite advertising campaign.')
date_from
class-attribute
instance-attribute
¶
date_from = Field(None, alias='dateFrom', description='The date defining the start of the timespan covered by the report, formatted as an ISO 8601 timestamp.')
date_to
class-attribute
instance-attribute
¶
date_to = Field(None, alias='dateTo', description='The date defining the end of the timespan covered by the report, formatted as an ISO 8601 timestamp.')
dimensions
class-attribute
instance-attribute
¶
dimensions = Field(None, description='A list containing the dimension in the report.')
funding_models
class-attribute
instance-attribute
¶
funding_models = Field(None, alias='fundingModels', description='The funding model for the campaign that shall be included in the report. Note: The default funding model for Promoted Listings reports is COST_PER_SALE . Valid Values: COST_PER_SALE COST_PER_CLICK')
inventory_references
class-attribute
instance-attribute
¶
inventory_references = Field(None, alias='inventoryReferences', description="If supplied in the request, this field returns a list of the seller's inventory reference IDs included in the report. Each item is referenced by a pair of inventoryRefernceID and inventoryReferenceType values, where an inventory reference ID can be either a seller-defined SKU value or an inventoryItemGroupKey .")
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description="If supplied in the request, this field returns a list of the listing IDs included in the report. A listing ID is an eBay-assigned ID that's generated when a listing is created.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace used by the report task.')
metric_keys
class-attribute
instance-attribute
¶
metric_keys = Field(None, alias='metricKeys', description='A list of metrics for the report task.')
report_expiration_date
class-attribute
instance-attribute
¶
report_expiration_date = Field(None, alias='reportExpirationDate', description='The date after which the report is no longer be available. Reports are available for 30 days and you cannot download a report after it has expired. Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ')
report_format
class-attribute
instance-attribute
¶
report_format = Field(None, alias='reportFormat', description='Indicates the format of the report. Currently, only TSV_GZIP is supported.')
report_href
class-attribute
instance-attribute
¶
report_href = Field(None, alias='reportHref', description='The URL of the generated report, which can be used to download the report once it has been generated.')
report_id
class-attribute
instance-attribute
¶
report_id = Field(None, alias='reportId', description='A unique eBay-assigned ID for the report.')
report_name
class-attribute
instance-attribute
¶
report_name = Field(None, alias='reportName', description="An eBay-assigned name for the report that's created by the createReportTask call. This name is unique for the seller.")
report_task_completion_date
class-attribute
instance-attribute
¶
report_task_completion_date = Field(None, alias='reportTaskCompletionDate', description='The date the report task completed the report generation. Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ')
report_task_creation_date
class-attribute
instance-attribute
¶
report_task_creation_date = Field(None, alias='reportTaskCreationDate', description='The date the report task was created. Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ')
report_task_expected_completion_date
class-attribute
instance-attribute
¶
report_task_expected_completion_date = Field(None, alias='reportTaskExpectedCompletionDate', description='The date the report task is expected to complete the report generation. Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ')
report_task_id
class-attribute
instance-attribute
¶
report_task_id = Field(None, alias='reportTaskId', description='The unique eBay-assigned ID of the report task. This value is generated when the report task is created with a call to createReportTask .')
report_task_status
class-attribute
instance-attribute
¶
report_task_status = Field(None, alias='reportTaskStatus', description='Indicates the current state of the report task.')
report_task_status_message
class-attribute
instance-attribute
¶
report_task_status_message = Field(None, alias='reportTaskStatusMessage', description='A status message with additional information about the report task.')
report_type
class-attribute
instance-attribute
¶
report_type = Field(None, alias='reportType', description='Indicates type of report associated with the report task. Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending.')
ReportTaskPagedCollection ¶
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. This value can be set in the request with the limit query parameter.')
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. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
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. Max 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 .')
report_tasks
class-attribute
instance-attribute
¶
report_tasks = Field(None, alias='reportTasks', description='A list of report tasks contained on this page from the paginated response.')
SelectionRule ¶
Bases: EbayModel
brands
class-attribute
instance-attribute
¶
brands = Field(None, description='An array of product brands. For more details, see Using the selectionRules container .')
category_ids
class-attribute
instance-attribute
¶
category_ids = Field(None, alias='categoryIds', description='This field contains an array of the associated category ID(s). For Item discounts , a single-item array containing the category ID associated with the discounts. Required when used in an Item discount and either specifying a selectionRules container or when inventoryCriterionType is set to INVENTORY_BY_RULE .')
category_scope
class-attribute
instance-attribute
¶
category_scope = Field(None, alias='categoryScope', description="This enumerated value indicates if the category ID for the item is an identifier for eBay categories or for a seller's eBay store categories. For Promoted Listing campaigns , this field includes the type of the category ID for the item(s) to be included in the campaign.")
listing_condition_ids
class-attribute
instance-attribute
¶
listing_condition_ids = Field(None, alias='listingConditionIds', description='A comma-separated list of unique identifiers for the conditions of listings to be included For Promoted Listing campaigns , refer to Add items to the campaign . Up to four IDs can be specified. For Item discounts , refer to Item condition ID and name values .')
max_price
class-attribute
instance-attribute
¶
max_price = Field(None, alias='maxPrice', description='This container sets the maximum price threshold. For more details, see Using the selectionRules container .')
min_price
class-attribute
instance-attribute
¶
min_price = Field(None, alias='minPrice', description='This container sets the minimum price threshold. For more details, see Using the selectionRules container .')
SuggestMaxCpcResponse ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The suggested maxCpc amount for the smart targeting campaign.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The unique identifier of the marketplace where the listings are hosted.')
SummaryReportResponse ¶
Bases: EbayModel
base_sale
class-attribute
instance-attribute
¶
base_sale = Field(None, alias='baseSale', description='The total revenue from all the purchased items that were part of a discount but did not trigger a discount during the discount period.')
last_updated
class-attribute
instance-attribute
¶
last_updated = Field(None, alias='lastUpdated', description='The date the report was generated.')
percentage_sales_lift
class-attribute
instance-attribute
¶
percentage_sales_lift = Field(None, alias='percentageSalesLift', description='The percentage of the total dollar amount gained due to discounts. This value is calculated as follows: precentageSalesLift = promotionSale / ( baseSale + promotionSale )')
promotion_sale
class-attribute
instance-attribute
¶
promotion_sale = Field(None, alias='promotionSale', description='The total revenue from all the purchased items that were part of a discount and their purchase did trigger a discount during the discount period.')
total_sale
class-attribute
instance-attribute
¶
total_sale = Field(None, alias='totalSale', description="Total dollar sales amount of all the seller's listings, current to the date the report was generated.")
TargetedBidRequest ¶
Bases: EbayModel
keywords
class-attribute
instance-attribute
¶
keywords = Field(None, description='An array of keywords for which bids will be required. Maximum number of keywords: 500')
TargetingItems ¶
UpdateAdGroupRequest ¶
Bases: EbayModel
ad_group_status
class-attribute
instance-attribute
¶
ad_group_status = Field(None, alias='adGroupStatus', description='An enumeration value representing the current status of the ad group. If the status of the ad is currently ACTIVE , you can change status to PAUSED or ARCHIVED . If ad group is currently in PAUSED status, you can change the status back to ACTIVE . Ads that are currently in ARCHIVED status cannot be made ACTIVE again. Valid Values: ACTIVE PAUSED ARCHIVED')
default_bid
class-attribute
instance-attribute
¶
default_bid = Field(None, alias='defaultBid', description='A bid amount that applies to all of the keywords in an ad group that do not have individual bids.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The updated name for the specified ad group.')
UpdateAdsByInventoryReferenceResponse ¶
Bases: EbayModel
ads
class-attribute
instance-attribute
¶
ads = Field(None, description='A list of ad IDs and links to retrieve them.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='A container for all of the errors associated with the specified inventory reference ID.')
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The reference ID associated with the ad. The reference ID could be a SKU number or Inventory Item Group, depending on value of inventoryReferenceType .')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='The inventory reference type associated with the ad. The inventory reference type could be a SKU number or Inventory Item Group.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates whether or not the CPS ad was successfully updated.')
UpdateCampaignBudgetRequest ¶
Bases: EbayModel
daily
class-attribute
instance-attribute
¶
daily = Field(None, description='The daily budget limit for the Cost Per Click (CPC) Promoted Listings campaign. This will be a dollar value. All clicks using the keywords defined for the campaign will go towards expending the daily budget. Once the daily budget is exceeded for the campaign, all Promoted Listings under the campaign will be turned off until the next day. Valid Values : 50.00 100.00')
UpdateKeywordByKeywordIdRequest ¶
Bases: EbayModel
bid
class-attribute
instance-attribute
¶
bid = Field(None, description='This container is used to set or change the bid percentage for the keyword. Each time a listing is retrieved in search results using this keyword and clicked on, the seller will be charged this amount. Each click goes toward the daily budget set up for the Cost Per Click (CPC) campaign.')
keyword_id
class-attribute
instance-attribute
¶
keyword_id = Field(None, alias='keywordId', description='This field is used to identify the keyword to be updated. The getKeyword method can be used to retrieve keywordId values.')
keyword_status
class-attribute
instance-attribute
¶
keyword_status = Field(None, alias='keywordStatus', description="Include this field if you wish to change the status of the keyword. The status value specified here must be different than the keyword's current status. To confirm the current status of a keyword, you can use the getKeyword method. If the status of the ad is currently ACTIVE , you can change status to PAUSED or ARCHIVED .")
UpdateKeywordRequest ¶
Bases: EbayModel
bid
class-attribute
instance-attribute
¶
bid = Field(None, description='This container is used to set or change the bid for the keyword. Each time a listing is retrieved in search results using this keyword and clicked on, the seller will be charged this amount. Each click goes toward the daily budget set up for the CPC campaign. If the bid is not provided, then the default bid associated with the ad group is used.')
keyword_status
class-attribute
instance-attribute
¶
keyword_status = Field(None, alias='keywordStatus', description="Include this field if you wish to change the status of the keyword. The status value specified here must be different than the keyword's current status. To confirm the current status of a keyword, you can use the getKeyword method. If the status of the ad is currently ACTIVE , you can change status to PAUSED or ARCHIVED .")
UpdateKeywordResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='This container will be returned if there are one or more issues associated with modifying the corresponding keyword.')
keyword_id
class-attribute
instance-attribute
¶
keyword_id = Field(None, alias='keywordId', description='This field identifies the keyword that the seller updated, or attempted to update.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code is returned for each keyword to indicate the success or failure of updating that keyword.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='List of warnings associated with this operation')
UpdateNegativeKeywordResponse ¶
Bases: EbayModel
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='A container that will be returned if there are one or more issues associated with modifying the corresponding negative keyword.')
negative_keyword_id
class-attribute
instance-attribute
¶
negative_keyword_id = Field(None, alias='negativeKeywordId', description='A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the success or failure of updating that negative keyword.')
AdGroup ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model.')
ad_group_status
class-attribute
instance-attribute
¶
ad_group_status = Field(None, alias='adGroupStatus', description='An enumeration value representing the current status of the ad group. Valid Values: ACTIVE PAUSED ARCHIVED')
default_bid
class-attribute
instance-attribute
¶
default_bid = Field(None, alias='defaultBid', description='A bid amount that applies to all of the keywords in an ad group that do not have individual bids. For all keywords without individual bids, the default bid is the amount that the seller will pay per click for the listings in the ad group in the promoted listings campaign. Valid Values : 0.5, 0.75')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name of the ad group.')
AdGroupPagedCollectionResponse ¶
Bases: EbayModel
ad_groups
class-attribute
instance-attribute
¶
ad_groups = Field(None, alias='adGroups', description='The details of existing ad groups, such as the name, ID, and status of the ad groups.')
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. This value can be set in the request with the limit query parameter.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list, where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items retrieved in the result set. Note: If no items are found, this field is returned with a value of 0 .')
AdResponse ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a priority strategy campaign that uses the Cost Per Click (CPC) funding model. Note: This field will always be returned for campaigns that use the CPC funding model. It will not be returned for campaigns that use the Cost Per Sale (CPS) funding model.')
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned ID for an ad. This ID is generated when an ad is created. Note: This field is only returned when an ad is successfully created for the corresponding listing.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='An array of errors associated with the request.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The getAd URI that points to the ad. Note: This field is only returned when an ad is successfully created for the corresponding listing.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID for a listing that is generated when the listing is created.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code indicating if the corresponding ad was successfully created or not. 200 Successful should be returned for successfully created ads. Note: A status code is returned for each ad that the seller creates, or attempts to create.')
AdUpdateResponse ¶
Bases: EbayModel
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned ID that is generated when the ad is created.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='A list of errors associated with the specified listing ID.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI for the ad, which can be used to retrieve the ad.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID that is generated when the listing is created.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the response-status of the request.')
AdUpdateStatusByListingIdResponse ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='A list of errors associated with the specified listing ID.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI for the ad, which can be used to retrieve the ad.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID that is generated when the listing is created.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the response-status of the request.')
AdUpdateStatusResponse ¶
Bases: EbayModel
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned ID that is generated when the ad is created.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='A list of errors associated with the specified listing ID.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI for the ad, which can be used to retrieve the ad.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the response-status of the request.')
AdditionalInfo ¶
Bases: EbayModel
info_type
class-attribute
instance-attribute
¶
info_type = Field(None, alias='infoType', description='The type of additional information provided for the suggested keyword. Valid Value: KEYWORD_INSIGHTS')
metrics
class-attribute
instance-attribute
¶
metrics = Field(None, description='A list of additional data provided for the suggested keyword.')
AlertDetails ¶
Bases: EbayModel
BaseResponse ¶
Bases: EbayModel
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='The container for any warning error messages generated by the request. Warnings are not fatal in that they do not prevent the call from running and returning a response, but they should be reviewed to ensure your requests are returning the responses you expect.')
BidPreference ¶
Bases: EbayModel
max_cpc
class-attribute
instance-attribute
¶
max_cpc = Field(None, alias='maxCpc', description='The maximum amount for which the eBay suggested bid can be adjusted. This value represents the most a seller is willing to pay for each click on their ad. The adjusted bid will never exceed this amount. This field is required for smart targeting campaigns. Note: The maximum cost-per-click has a minimum value of 0.02 and a maximum value of 100.')
BudgetRecommendationResponse ¶
Bases: EbayModel
budget
class-attribute
instance-attribute
¶
budget = Field(None, description='The allocated daily budget for the Cost Per Click (CPC) Promoted Listings campaign.')
campaign_id
class-attribute
instance-attribute
¶
campaign_id = Field(None, alias='campaignId', description='The unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.')
channels
class-attribute
instance-attribute
¶
channels = Field(None, description='The channel for the campaign. This value indicates whether the campaign is an Onsite or Offsite advertising campaign. Valid Values: ON_SITE OFF_SITE')
BulkAdResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This array displays the list of ads that were successfully created. For any ads that were not created successfully, the errors array may provide more detail about why creation of one or more ads failed.')
BulkAdUpdateResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A set of ad listings processed by the call.')
BulkAdUpdateStatusByListingIdResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='An array of processed ad listings in bulk.')
BulkAdUpdateStatusResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='An array of processed ad listings in bulk.')
BulkCreateAdsByInventoryReferenceRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='A list of inventory reference ID and inventory reference type pairs, and the bid percentage, which the call uses to create ads in bulk.')
BulkCreateKeywordRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This array is used to pass in multiple keywords for one or more ad groups that belong to a campaign that uses the Cost Per Click (CPC) funding model. Up to {max value} keywords can be created with one call.')
BulkCreateKeywordResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of keywords that have been processed by the request.')
BulkCreateNegativeKeywordRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='This array is used to pass in multiple negative keywords for one or more ad groups that belong to a campaign that uses the Cost Per Click (CPC) funding model.')
BulkCreateNegativeKeywordResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of negative keywords that have been processed by the request.')
BulkDeleteAdsByInventoryReferenceRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='A list of inventory referenceID and inventory reference type pairs that specify the set of ads to remove in bulk.')
BulkUpdateAdsByInventoryReferenceResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of inventory references that were processed from the request.')
BulkUpdateAdsStatusByInventoryReferenceResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of inventory references that were processed from the request.')
BulkUpdateKeywordRequest ¶
Bases: EbayModel
requests
class-attribute
instance-attribute
¶
requests = Field(None, description='Use this array to update the bid values and/or statuses of one or more existing keywords.')
BulkUpdateKeywordResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of keywords that have been processed from the bulk request.')
BulkUpdateNegativeKeywordResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='A list of negative keywords that have been processed from the bulk request.')
CampaignCriterion ¶
Bases: EbayModel
auto_select_future_inventory
class-attribute
instance-attribute
¶
auto_select_future_inventory = Field(None, alias='autoSelectFutureInventory', description="A field used to indicate whether listings shall be automatically added to, or removed from, a Promoted Listings campaign based on the rules that have been configured for the campaign. If set to true , eBay adds all listings matching the campaign criterion to the campaign, including any new listings created from the items in a seller's inventory. Default: false")
criterion_type
class-attribute
instance-attribute
¶
criterion_type = Field(None, alias='criterionType', description='This enum defines the criterion (selection rule) types. Currently, the only criterion type supported is INVENTORY_PARTITION , and you must specify this value if you manage your items with the Inventory API and you want to include items based on their inventory reference IDs. Do not include this field if you manage your listings with Trading API/legacy model.')
selection_rules
class-attribute
instance-attribute
¶
selection_rules = Field(None, alias='selectionRules', description='This container shows all of the rules/inclusion filters used to add listings to the campaign. For information on using the contained fields, see Promoted Listing campaigns .')
CreateAdsByInventoryReferenceResponse ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a priority strategy campaign that uses the Cost Per Click (CPC) funding model. Note: This field will always be returned for campaigns that use the CPC funding model. It will not be returned for campaigns that use the Cost Per Sale (CPS) funding model.')
ads
class-attribute
instance-attribute
¶
ads = Field(None, description='A list of ad IDs. An ad ID is generated for each successfully created ad.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='An array of errors or warnings associated with the create-ads request.')
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='An ID that identifies a single-item listing or multiple-variation listing that is managed with the Inventory API . The inventory reference ID is a seller-defined value that can be either an SKU for a single-item listing or an inventoryItemGroupKey for a multiple-value listing.')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='Indicates the type of item the inventoryReferenceId references. The item can be either an INVENTORY_ITEM or an INVENTORY_ITEM_GROUP .')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the response-status of the request. Check this code to see if the ads were successfully created.')
CreateReportTask ¶
Bases: EbayModel
additional_records
class-attribute
instance-attribute
¶
additional_records = Field(None, alias='additionalRecords', description='A list of additional records that shall be included in the report, such as non-performing data. Note: Additional records are only applicable to Promoted Listings priority strategy campaigns that use the Cost Per Click (CPC) funding model. Valid Value: NON_PERFORMING_DATA')
campaign_ids
class-attribute
instance-attribute
¶
campaign_ids = Field(None, alias='campaignIds', description='A list of campaign IDs to be included in the report task. Use the getCampaigns method to retrieve a list of the current campaign IDs for a seller. For general campaign strategy sellers, this field is required if the reportType is set to CAMPAIGN_PERFORMANCE_REPORT or CAMPAIGN_PERFORMANCE_SUMMARY_REPORT .')
channels
class-attribute
instance-attribute
¶
channels = Field(None, description='The channel for the advertising campaign that will be included in the report task. This value indicates whether the data included in the report task is for an Onsite or Offsite advertising campaign. If no value is entered, this field will default to ON_SITE . Multiple channels are not supported. Note: Channels are only applicable for campaigns that use the Cost Per Click (CPC) funding model.')
date_from
class-attribute
instance-attribute
¶
date_from = Field(None, alias='dateFrom', description='The date defining the start of the timespan covered by the report. Format the timestamp as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock with local offset. Note: The date specified cannot be a future date. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2021-03-15T13:00:00-07:00')
date_to
class-attribute
instance-attribute
¶
date_to = Field(None, alias='dateTo', description='The date defining the end of the timespan covered by the report. As with the dateFrom field, format the timestamp as an ISO 8601 string. Note: The date specified cannot be a future date. Additionally, the time specified must be a later time than that specified in the dateFrom field. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2021-03-17T13:00:00-07:00')
dimensions
class-attribute
instance-attribute
¶
dimensions = Field(None, description='The list of the dimensions applied to the report. A dimension is an attribute to which the report data applies. For example, if you set dimensionKey to campaign_id in a Campaign Performance Report, the data will apply to the entire ad campaign. For information on the dimensions and how to specify them, see Promoted Listings reporting .')
funding_models
class-attribute
instance-attribute
¶
funding_models = Field(None, alias='fundingModels', description='The funding model for the campaign that shall be included in the report. Note: The default funding model for Promoted Listings reports is COST_PER_SALE . Note: Multiple value support for the fundingModels array has been deprecated. See API Deprecation Status for information. Valid Values: COST_PER_SALE COST_PER_CLICK Required if the campaign funding model is Cost Per Click (CPC).')
inventory_references
class-attribute
instance-attribute
¶
inventory_references = Field(None, alias='inventoryReferences', description='You can use this field to supply an array of items to include in the report if you manage your inventory with the Inventory API . This field is mutually exclusive with the listingIds field; if you populate this field, do not populate the listingIds field.')
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description='Use this field to supply an array of eBay listing IDs you want to include in the report. Important: This field is mutually exclusive with the inventoryReferences field; if you populate this field, do not populate the inventoryReferences field.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The unique identifier for the eBay marketplace on which the report is based.')
metric_keys
class-attribute
instance-attribute
¶
metric_keys = Field(None, alias='metricKeys', description='The list of metrics to be included in the report. Metrics are the quantitative measurements compiled into the report and the data returned is based on the specified dimension of the report. For example, if the dimension is campaign , the metrics for number of sales would be the number of sales in the campaign.')
report_format
class-attribute
instance-attribute
¶
report_format = Field(None, alias='reportFormat', description='The file format of the report. Currently, the only supported format is TSV_GZIP , which is a gzip file with tab separated values.')
report_type
class-attribute
instance-attribute
¶
report_type = Field(None, alias='reportType', description='The type of report to be generated, such as ACCOUNT_PERFORMANCE_REPORT or CAMPAIGN_PERFORMANCE_REPORT . Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending. Maximum: 1')
DeleteAdResponse ¶
Bases: EbayModel
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='The unique identifier of the ad that was deleted, or the ad that the seller attempted to delete.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='An array of the errors or warnings associated with the request.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID for a listing that is generated when the listing is created.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code that indicates the response-status of the request. Check this code to see if the ad was successfully deleted. Note: A status code is returned for each ad that the seller deletes, or attempts to delete.')
DeleteAdsByInventoryReferenceResponse ¶
Bases: EbayModel
ad_ids
class-attribute
instance-attribute
¶
ad_ids = Field(None, alias='adIds', description='The unique identifier of the ad that was deleted, or the ad that the seller attempted to delete. Note: Although the field name is plural and it is an array, only one ad ID will be returned here since there can be only one ad per listing.')
errors
class-attribute
instance-attribute
¶
errors = Field(None, description='The container for the errors associated with the request.')
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='The inventory reference ID is a seller-defined SKU value for a single-item listing, or a seller-defined identifier for an inventory item group. Both of these values are defined when using the Inventory API, and an inventory item group is used to create a multiple-variation listing.')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='The enumeration value returned here indicates if the ad was for a single-variation listing or a multiple-variation listing.')
status_code
class-attribute
instance-attribute
¶
status_code = Field(None, alias='statusCode', description='An HTTP status code indicating if the corresponding ad was successfully deleted or not. 200 Successful should be returned for successfully deleted ads. Note: A status code is returned for each ad that the seller deletes, or attempts to delete.')
DiscountRule ¶
Bases: EbayModel
discount_benefit
class-attribute
instance-attribute
¶
discount_benefit = Field(None, alias='discountBenefit', description='This container defines the discount as either a monetary amount or a percentage of the sales price. Note: When configuring discount benefits, populate just one of the following fields in the discountBenefit container: amountOffItem amountOffOrder percentageOffItem percentageOffOrder For volume pricing, only percentageOffOrder is applicable as a discountBenefit .')
discount_specification
class-attribute
instance-attribute
¶
discount_specification = Field(None, alias='discountSpecification', description='This container defines the criteria for when the discounts trigger, such as the minimum quantity that the buyer must purchase before the discount kicks in. The discount is applied each time the criteria defined by this container is met.')
max_discount_amount
class-attribute
instance-attribute
¶
max_discount_amount = Field(None, alias='maxDiscountAmount', description="The limit on how much a buyer can save using a CODED_COUPON discount type. Permitted values are 1-1000. Supported currency codes include USD, GBP, EUR, and AUD. Note: The Currency Code for 'maxDiscountAmount' must be the same as the Currency Code for 'budget'.")
rule_order
class-attribute
instance-attribute
¶
rule_order = Field(None, alias='ruleOrder', description='This field indicates the order in which the discountRules are presented. The value specified for this field must equal the associated minQuantity value. Required if you are creating a volume pricing discount.')
FundingStrategy ¶
Bases: EbayModel
ad_rate_strategy
class-attribute
instance-attribute
¶
ad_rate_strategy = Field(None, alias='adRateStrategy', description='This field is used to set the ad rate strategy for a Cost Per Sale (CPS) campaign. The default value for this field is FIXED . If this field is omitted, the default value will be used. Note: This field is not applicable for Cost Per Click (CPC) or offsite campaigns.')
bidding_strategy
class-attribute
instance-attribute
¶
bidding_strategy = Field(None, alias='biddingStrategy', description='Indicates the bidding strategy for an onsite Cost Per Click (CPC) campaign that uses manual targeting. Note: This field is not applicable for smart targeting campaigns. Valid values are: FIXED When using a fixed bidding strategy, sellers manually assign and adjust keyword bids for the CPC campaign.')
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description='The user-defined bid percentage (also known as the ad rate ) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.')
bid_preferences
class-attribute
instance-attribute
¶
bid_preferences = Field(None, alias='bidPreferences', description='This container indicates the bidding preferences of the campaign, such as the maximum CPC amount. Note: This container is only applicable for smart targeting campaigns. This container is required if the user wants to create a Smart Targeting campaign.')
dynamic_ad_rate_preferences
class-attribute
instance-attribute
¶
dynamic_ad_rate_preferences = Field(None, alias='dynamicAdRatePreferences', description='A field that indicates whether a single, user-defined bid percentage (also known as the ad rate ) should be used, or whether eBay should automatically adjust listings to maintain the daily suggested bid percentage. Note: Dynamic adjustment is only applicable when the adRateStrategy is set to DYNAMIC This field is not applicable for offsite campaigns. Default: FIXED')
funding_model
class-attribute
instance-attribute
¶
funding_model = Field(None, alias='fundingModel', description='Indicates the model that eBay uses to calculate the Promoted Listings fee. For a description of the funding model types, refer to FundingModelTypeEnum .')
ItemsPagedCollection ¶
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. This value can be set in the request with the limit query parameter.')
listings
class-attribute
instance-attribute
¶
listings = Field(None, description='An array of the listings associated with a discount.')
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. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
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. Max 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 .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of warnings that were generated by the request. Warning do not stop processing, but should be checked to ensure that the response contains the correct information.')
RuleCriteria ¶
Bases: EbayModel
exclude_inventory_items
class-attribute
instance-attribute
¶
exclude_inventory_items = Field(None, alias='excludeInventoryItems', description='A list of seller inventory reference IDs to exclude from the discount. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent items Maximum SKU or custom label length: 50 characters')
exclude_listing_ids
class-attribute
instance-attribute
¶
exclude_listing_ids = Field(None, alias='excludeListingIds', description='A list of eBay listing IDs to exclude from the discount. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent items Maximum SKU or custom label length: 50 characters')
markup_inventory_items
class-attribute
instance-attribute
¶
markup_inventory_items = Field(None, alias='markupInventoryItems', description="A list of SKUs to remove from a markdown discount. The listed SKUs are 'marked up' to their standard price after being part of the markdown discount.")
markup_listing_ids
class-attribute
instance-attribute
¶
markup_listing_ids = Field(None, alias='markupListingIds', description="A list of listing IDs to remove from a markdown discount. The listed items are 'marked up' to their standard price after being part of the markdown discount.")
selection_rules
class-attribute
instance-attribute
¶
selection_rules = Field(None, alias='selectionRules', description='The container for the rules that select the items to be discounted. Required if inventoryCriterionType is set to INVENTORY_BY_RULE . For information on using the contained fields, see Item discounts .')
SuggestBudgetResponse ¶
Bases: EbayModel
suggested_budget
class-attribute
instance-attribute
¶
suggested_budget = Field(None, alias='suggestedBudget', description='The suggested allocated daily budget for an offsite campaign.')
SuggestedKeywords ¶
Bases: EbayModel
additional_info
class-attribute
instance-attribute
¶
additional_info = Field(None, alias='additionalInfo', description='A container for the additional information and compiled insight data for suggested keywords.')
keyword_text
class-attribute
instance-attribute
¶
keyword_text = Field(None, alias='keywordText', description='The text for the keyword.')
match_type
class-attribute
instance-attribute
¶
match_type = Field(None, alias='matchType', description='A field that defines the match type for the keyword. Valid Values: BROAD EXACT PHRASE')
TargetedAdsPagedCollection ¶
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. This value can be set in the request with the limit query parameter.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Default: 0 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 call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results.')
suggested_items
class-attribute
instance-attribute
¶
suggested_items = Field(None, alias='suggestedItems', description='A list of suggested items in the paginated collection.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items retrieved in the result set. Note: If no items are found, this field is returned with a value of 0 .')
TargetedKeywordsPagedCollection ¶
Bases: EbayModel
suggested_keywords
class-attribute
instance-attribute
¶
suggested_keywords = Field(None, alias='suggestedKeywords', description='A list of suggested keywords in the paged collection. Note: A relevancy check with items already present in the ad-group is performed even if item IDs associated with the ad-group are not explicitly passed in the request.')
UpdateBiddingStrategyRequest ¶
Bases: EbayModel
bidding_strategy
class-attribute
instance-attribute
¶
bidding_strategy = Field(None, alias='biddingStrategy', description='The new bidding strategy for the specified Cost Per Click (CPC) campaign.')
bid_preferences
class-attribute
instance-attribute
¶
bid_preferences = Field(None, alias='bidPreferences', description='This container indicates the bidding preferences of the campaign, such as the maximum CPC amount. Note: This container is only applicable for smart targeting campaigns. This container is required if the user wants to create a Smart Targeting campaign.')
Alert ¶
Bases: EbayModel
alert_type
class-attribute
instance-attribute
¶
alert_type = Field(None, alias='alertType', description='The type of alert message. For example, an invalid bid percentage.')
details
class-attribute
instance-attribute
¶
details = Field(None, description='A description of the alert including dimensions and aspects.')
BulkCreateAdsByInventoryReferenceResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='This array displays the list of ads that were successfully created. For any ads that were not created successfully, the errors array may provide more detail about why creation of one or more ads failed.')
BulkDeleteAdResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='An array of the ads that were deleted by the bulkDeleteAdsByListingId request, including information associated with each individual delete request.')
BulkDeleteAdsByInventoryReferenceResponse ¶
Bases: EbayModel
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='An array of the ads that were deleted by the bulkDeleteAdsByInventoryReference request, including information associated with each individual delete request.')
Campaign ¶
Bases: EbayModel
alerts
class-attribute
instance-attribute
¶
alerts = Field(None, description='This array contains alert messages for the campaign.')
budget
class-attribute
instance-attribute
¶
budget = Field(None, description='The allocated budget for the Cost Per Click (CPC) Promoted Listings campaign. Note: This field will only be returned for campaigns using the CPC funding model; it does not apply to the Cost Per Sale (CPS) funding model.')
campaign_criterion
class-attribute
instance-attribute
¶
campaign_criterion = Field(None, alias='campaignCriterion', description='The selection rules (criterion) used to select the listings for a campaign. If you populate the campaignCriterion object in your createCampaign request, ads for the campaign are created by rule for the listings that meet the criteria you specify, and these ads are associated with the campaign.')
campaign_id
class-attribute
instance-attribute
¶
campaign_id = Field(None, alias='campaignId', description='A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.')
campaign_name
class-attribute
instance-attribute
¶
campaign_name = Field(None, alias='campaignName', description='A seller-defined name for the campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters')
campaign_status
class-attribute
instance-attribute
¶
campaign_status = Field(None, alias='campaignStatus', description='Indicates the status of the campaign, such as RUNNING , PAUSED , and ENDED .')
campaign_targeting_type
class-attribute
instance-attribute
¶
campaign_targeting_type = Field(None, alias='campaignTargetingType', description='The targeting type of the campaign. This value indicates whether the campaign is a manual targeting or smart targeting ad campaign.')
channels
class-attribute
instance-attribute
¶
channels = Field(None, description='The channel for the campaign. This value indicates whether the campaign is an Onsite or Offsite advertising campaign. Valid Values: ON_SITE OFF_SITE')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the campaign ends, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.')
funding_strategy
class-attribute
instance-attribute
¶
funding_strategy = Field(None, alias='fundingStrategy', description='This container includes parameters that define an ad campaign funding strategy. The set of seller-configurable parameters depends on the selected fundingModel value. Currently, the supported funding models are COST_PER_SALE (CPS) and COST_PER_CLICK (CPC). For onsite ads, the CPC model supports two bidding strategies: FIXED and DYNAMIC .')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace where the campaign is hosted.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the campaign starts, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller. On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed.')
CampaignPagedCollectionResponse ¶
Bases: EbayModel
campaigns
class-attribute
instance-attribute
¶
campaigns = Field(None, description="This array contains all of the seller's campaign that match the request criteria.")
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. This value can be set in the request with the limit query parameter.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set. Max 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 can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Max length : 2048')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of campaigns retrieved in the result set. If no campaigns are found, this field is returned with a value of 0 .')
Campaigns ¶
Bases: EbayModel
campaigns
class-attribute
instance-attribute
¶
campaigns = Field(None, description='This is an array of one or campaigns that match the listing or inventory item group specified in the request.')
CloneCampaignRequest ¶
Bases: EbayModel
campaign_name
class-attribute
instance-attribute
¶
campaign_name = Field(None, alias='campaignName', description='A seller-defined name for the newly-cloned campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the campaign ends, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.')
funding_strategy
class-attribute
instance-attribute
¶
funding_strategy = Field(None, alias='fundingStrategy', description='This container includes parameters that define an ad campaign funding strategy. The set of seller-configurable parameters depends on the selected fundingModel value.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the cloned campaign starts, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller. On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed.')
CreateCampaignRequest ¶
Bases: EbayModel
budget
class-attribute
instance-attribute
¶
budget = Field(None, description='The allocated daily budget for the Cost Per Click (CPC) Promoted Listings campaign. Required if the campaign funding model is CPC.')
campaign_criterion
class-attribute
instance-attribute
¶
campaign_criterion = Field(None, alias='campaignCriterion', description='This container is used if the seller wishes to create one or more rules for a rules-based campaign. If you populate the campaignCriterion object in your createCampaign request, ads for the campaign are created by rule for the listings that meet the criteria you specify, and these ads are associated with the campaign to be created.')
campaign_name
class-attribute
instance-attribute
¶
campaign_name = Field(None, alias='campaignName', description='A seller-defined name for the campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters')
campaign_targeting_type
class-attribute
instance-attribute
¶
campaign_targeting_type = Field(None, alias='campaignTargetingType', description='The targeting type of the campaign. This value indicates whether the campaign is a manual targeting or smart targeting campaign. If not value is specified, this field will default to MANUAL . Note: This feature is only supported for on-site campaigns that use the Cost Per Click (CPC) funding model.')
channels
class-attribute
instance-attribute
¶
channels = Field(None, description='The channel for the campaign. This value indicates whether the advertising campaign is an Onsite or Offsite. If no value is entered, this field will default to ON_SITE . Multiple channels are not supported. Note: Channels is only applicable for campaigns that use the Cost Per Click (CPC) funding model.')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the campaign ends, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.')
funding_strategy
class-attribute
instance-attribute
¶
funding_strategy = Field(None, alias='fundingStrategy', description='This container includes parameters that define an ad campaign funding strategy. The set of seller-configurable parameters depends on the selected fundingModel value.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace where the campaign is hosted. See the MarketplaceIdEnum type to get the appropriate enumeration value for the listing marketplace.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the campaign starts, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller. On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed.')
InventoryCriterion ¶
Bases: EbayModel
inventory_criterion_type
class-attribute
instance-attribute
¶
inventory_criterion_type = Field(None, alias='inventoryCriterionType', description='Indicates how the items to be discounted are selected. You can include inventory by ID, using rules, or globally include all your inventory.')
inventory_items
class-attribute
instance-attribute
¶
inventory_items = Field(None, alias='inventoryItems', description='An array of containers for the seller\'s inventory reference IDs (also known as an "SKU" or "custom label") to be added to the discount. Note: The request can have either inventoryItems or listingIds , but not both.')
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description='An array of eBay listing IDs to be discounted. Note: The request can have either inventoryItems or listingIds , but not both. Required: All listings being discounted must offer an electronic payment method.')
rule_criteria
class-attribute
instance-attribute
¶
rule_criteria = Field(None, alias='ruleCriteria', description='This container defines a set of inventory selection rules for a discount. When defining rule criteria, you must limit item exclusions to 100 IDs when you choose from live inventory. Required if InventoryCriterionEnum is set to INVENTORY_BY_RULE or INVENTORY_ANY .')
ItemPromotion ¶
Bases: EbayModel
apply_discount_to_single_item_only
class-attribute
instance-attribute
¶
apply_discount_to_single_item_only = Field(None, alias='applyDiscountToSingleItemOnly', description='This flag is relevant in only when promotionType is set to VOLUME_DISCOUNT . For details on volume pricing discounts, see Configuring volume pricing discounts . If set to true , the discount is applied only when the buyer purchases multiple quantities of a single item that is being discounted. Otherwise, the discount applies to multiple quantities of any the items being discounted.')
budget
class-attribute
instance-attribute
¶
budget = Field(None, description="This sets the budget for the CODED_COUPON discount type. Supported values range from 100-1000000. Supported currency codes include USD, GBP, EUR, and AUD. Note: The budget value for an active or paused discount can not be decreased. Note: The Currency Code for 'budget' must be the same as the Currency Code for 'maxDiscountAmount'.")
coupon_configuration
class-attribute
instance-attribute
¶
coupon_configuration = Field(None, alias='couponConfiguration', description='The configuration of a coded coupon discount.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='This is the seller-defined "tag line" for the offer, such as "Save on designer shoes." The tag line appears under the "offer-type text" that is generated for the discount and is displayed on the offer tile that\'s shown on the seller\'s All Offers page, and on the event page for the discount.')
discount_rules
class-attribute
instance-attribute
¶
discount_rules = Field(None, alias='discountRules', description='This container defines a discount using the following two required fields: discountBenefit – Defines a discount as either a monetary amount or a percentage that is subtracted from the sales price of an item, a set of items, or an order. discountSpecification – Defines a set of rules that determine when the discount is applied.')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the discount ends in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
inventory_criterion
class-attribute
instance-attribute
¶
inventory_criterion = Field(None, alias='inventoryCriterion', description="A container that defines either the listing IDs or the selection rules that specify the items to be discounted. Listing IDs can be either eBay listing IDs or a list of the seller's inventory reference IDs (know as SKUs or custom labels). See the selectionRules container for the rule criteria you can use to select inventory.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace ID of the site where the threshold discount is hosted. Threshold discounts are currently supported on a limited number of eBay marketplaces. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES = Spain EBAY_FR = France EBAY_GB = Great Britain EBAY_IT = Italy EBAY_US = United States')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name or "title" of the discount that the seller can use to identify a discounts. This label is not displayed in end-user flows. Maximum length: 90')
priority
class-attribute
instance-attribute
¶
priority = Field(None, description="Applicable for only ORDER_DISCOUNT discounts, this field indicates the precedence of the discounts, which is used to determine the position of a discount on the seller's All Offers page. If an item is associated with multiple discounts, the discount with the higher priority takes precedence.")
promotion_image_url
class-attribute
instance-attribute
¶
promotion_image_url = Field(None, alias='promotionImageUrl', description="Required for CODED_COUPON, MARKDOWN_SALE, and ORDER_DISCOUNT discounts, and not valid for VOLUME_DISCOUNT discounts. Populate this field with a URL that points to an image to be used with the discount. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size.")
promotion_status
class-attribute
instance-attribute
¶
promotion_status = Field(None, alias='promotionStatus', description='The current status of the discount. When creating a new discount, this value must be set to either DRAFT or SCHEDULED . Note that you must set this value to SCHEDULED when you update a RUNNING discount.')
promotion_type
class-attribute
instance-attribute
¶
promotion_type = Field(None, alias='promotionType', description='Use this field to specify the type of the discount you are creating. The supported types are: CODED_COUPON – A coupon code discount set with createItemPromotion . MARKDOWN_SALE – A markdown discount set with createItemPriceMarkdownPromotion . ORDER_DISCOUNT – A threshold discount set with createItemPromotion . VOLUME_DISCOUNT – A volume pricing discount set with createItemPromotion .')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the discount starts in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
ItemPromotionResponse ¶
Bases: EbayModel
apply_discount_to_single_item_only
class-attribute
instance-attribute
¶
apply_discount_to_single_item_only = Field(None, alias='applyDiscountToSingleItemOnly', description='If set to true , the discount is applied only when the buyer purchases multiple quantities of a single item being discounted. Otherwise, the discount applies to multiple quantities of any items being discounted. Different variations of a multi-variation item are considered to be the same item.')
budget
class-attribute
instance-attribute
¶
budget = Field(None, description="This sets the budget for the CODED_COUPON discount type. Supported values range from 100-1000000. Supported currency codes include USD, GBP, EUR, and AUD. Note: The budget value for an active or paused discount can not be decreased. Note: The Currency Code for 'budget' must be the same as the Currency Code for 'maxDiscountAmount'.")
coupon_configuration
class-attribute
instance-attribute
¶
coupon_configuration = Field(None, alias='couponConfiguration', description='The configuration of a coded coupon discount.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='Required for CODED_COUPON discounts, this is the seller-defined "tag line" for the offer, such as "Save on designer shoes." The tag line appears under the "offer-type text" that is generated for the discount and is displayed under the offer tile that is shown on the seller\'s All Offers page and on the event page for the discount. This tag line is not used with volume pricing discounts.')
discount_rules
class-attribute
instance-attribute
¶
discount_rules = Field(None, alias='discountRules', description='A list containing the discount benefits ( discountRule ) and the rules that define when the benefit is applied ( discountSpecification ).')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the discount ends in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
inventory_criterion
class-attribute
instance-attribute
¶
inventory_criterion = Field(None, alias='inventoryCriterion', description="Returns either an array of listing IDs or the selection rules used to specify the items being discounted. Listing IDs can be either eBay listing IDs or an array of seller's inventory reference IDs (know as SKUs or custom labels). See the selectionRules container for the rule criteria you can use to select inventory.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace ID of the site where the threshold discount is hosted. Threshold discounts are currently supported on a limited number of eBay marketplaces. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES = Spain EBAY_FR = France EBAY_GB = Great Britain EBAY_IT = Italy EBAY_US = United States')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-defined name or "title" of the discount that the seller can use to identify a discount. This label is not displayed in end-user flows. Maximum length: 90')
priority
class-attribute
instance-attribute
¶
priority = Field(None, description="Applicable for only ORDER_DISCOUNT discounts, this field indicates the precedence of the discount, which eBay uses to determine the position of a discount on the seller's All Offers page. If an item is associated with multiple discounts, the discount with the higher priority takes precedence.")
promotion_id
class-attribute
instance-attribute
¶
promotion_id = Field(None, alias='promotionId', description="A unique eBay-assigned ID for the discount that's generated when the discount is created.")
promotion_image_url
class-attribute
instance-attribute
¶
promotion_image_url = Field(None, alias='promotionImageUrl', description="Required for CODED_COUPON, MARKDOWN_SALE, and ORDER_DISCOUNT discounts, and not applicable for VOLUME_DISCOUNT discounts, this field is a URL that points to an image for the discount. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size.")
promotion_status
class-attribute
instance-attribute
¶
promotion_status = Field(None, alias='promotionStatus', description='The current status of the discount. When creating a new discount, this value must be set to either DRAFT or SCHEDULED .')
promotion_type
class-attribute
instance-attribute
¶
promotion_type = Field(None, alias='promotionType', description='Indicates the type of the discount, either CODED_COUPON , MARKDOWN_SALE , ORDER_DISCOUNT , or VOLUME_DISCOUNT .')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the discount starts in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')
SelectedInventoryDiscount ¶
Bases: EbayModel
discount_benefit
class-attribute
instance-attribute
¶
discount_benefit = Field(None, alias='discountBenefit', description='This container defines the discount as either a monetary amount or a percentage applied to the sales price.')
discount_id
class-attribute
instance-attribute
¶
discount_id = Field(None, alias='discountId', description='A unique, eBay-generated ID that you can use to identify the discount. This field is ignored in POST and PUT operations.')
inventory_criterion
class-attribute
instance-attribute
¶
inventory_criterion = Field(None, alias='inventoryCriterion', description="A container that defines either the listing IDs or the selection rules that specify the items to include in the discount. Listing IDs can be either eBay listing IDs or a list of the seller's inventory reference IDs (know as SKUs or custom labels). See the selectionRules container for the rule criteria you can use to select inventory.")
rule_order
class-attribute
instance-attribute
¶
rule_order = Field(None, alias='ruleOrder', description='For markdown discounts, this field is reserved for future use.')
Ad ¶
Bases: EbayModel
ad_group_id
class-attribute
instance-attribute
¶
ad_group_id = Field(None, alias='adGroupId', description='A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. This ID is created after a successful createAdGroup call, and all ad groups must be associated with a CPC campaign.')
ad_id
class-attribute
instance-attribute
¶
ad_id = Field(None, alias='adId', description='A unique eBay-assigned ID that is generated when the ad is created.')
ad_status
class-attribute
instance-attribute
¶
ad_status = Field(None, alias='adStatus', description='The current status of the CPC ad. Valid Values: ACTIVE PAUSED ARCHIVED Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.')
alerts
class-attribute
instance-attribute
¶
alerts = Field(None, description='An array containing alert messages for the ad.')
bid_percentage
class-attribute
instance-attribute
¶
bid_percentage = Field(None, alias='bidPercentage', description='The user-defined bid percentage (also known as the ad rate ) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.')
inventory_reference_id
class-attribute
instance-attribute
¶
inventory_reference_id = Field(None, alias='inventoryReferenceId', description='An ID that identifies a single-item listing or multiple-variation listing that is managed with the Inventory API . The inventory reference ID is a seller-defined value that can be either an SKU for a single-item listing or an inventoryItemGroupKey for a multiple-value listing.')
inventory_reference_type
class-attribute
instance-attribute
¶
inventory_reference_type = Field(None, alias='inventoryReferenceType', description='The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be INVENTORY_ITEM for a single-variation listing, or INVENTORY_ITEM_GROUP for a multiple-variation listing. This field is only returned if the ad is associated with a SKU or an inventory item group value.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='A unique eBay-assigned ID that is generated when a listing is created.')
AdPagedCollectionResponse ¶
Bases: EbayModel
ads
class-attribute
instance-attribute
¶
ads = Field(None, description='The list of ads that matched the request criteria.')
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. This value can be set in the request with the limit query parameter.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The call URI that can be used to retrieve the next page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be increased to retrieve the next page of results. Max length : 2048')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first result on the current page. This value can be set in the request with the offset query parameter. If the offset value is not set, it defaults to zero. 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 call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Max 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 .')
Ads ¶
Bases: EbayModel
ads
class-attribute
instance-attribute
¶
ads = Field(None, description='A list of ad IDs. An ad ID is generated for each successfully created ad.')
ItemPriceMarkdown ¶
Bases: EbayModel
apply_free_shipping
class-attribute
instance-attribute
¶
apply_free_shipping = Field(None, alias='applyFreeShipping', description='If set to true , free shipping is applied to the first shipping service specified for the item. The first domestic shipping option is set to "free shipping," regardless if the shipping optionType for that service is set to FLAT_RATE , CALCULATED , or NOT_SPECIFIED (freight). This flag essentially adds free shipping as a part of the discount. Default: false')
auto_select_future_inventory
class-attribute
instance-attribute
¶
auto_select_future_inventory = Field(None, alias='autoSelectFutureInventory', description='If set to true , eBay will automatically add inventory items to the markdown discount if they meet the selectedInventoryDiscounts criteria specified for the markdown discount. Default: false')
block_price_increase_in_item_revision
class-attribute
instance-attribute
¶
block_price_increase_in_item_revision = Field(None, alias='blockPriceIncreaseInItemRevision', description="If set to true , price increases (including removing the free shipping flag) are blocked and an error message is returned if a seller attempts to adjust the price of an item that's partaking in this markdown discount. If set to false , an item is dropped from the markdown discount if the seller adjusts the price. Default: false")
description
class-attribute
instance-attribute
¶
description = Field(None, description='This field is required if you are configuring an MARKDOWN_SALE discount. This is the seller-defined "tag line" for the offer, such as "Save on designer shoes." A tag line appears under the "offer-type text" that is generated for the discount. The text is displayed on the offer tile that is shown on the seller\'s All Offers page and on the event page for the discount.')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The date and time the discount ends, in UTC format ( yyyy-MM-ddThh:mm:ssZ ). The value supplied for endDate must be at least 24 hours after the value supplied for the startDate of the markdown discount. For display purposes, convert this time into the local time of the seller. Max value: 14 days for the AT, CH, DE, ES, FR, IE, IT, and UK, marketplaces. 45 days for all other marketplaces.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace ID of the site where the markdown discount is hosted. Markdown discounts are supported on all eBay marketplaces.')
name
class-attribute
instance-attribute
¶
name = Field(None, description="The seller-defined name or 'title' of the discount that the seller can use to identify a discount. This label is not displayed in end-user flows. Maximum length: 90")
priority
class-attribute
instance-attribute
¶
priority = Field(None, description='This field is ignored in markdown discounts.')
promotion_image_url
class-attribute
instance-attribute
¶
promotion_image_url = Field(None, alias='promotionImageUrl', description="Required for CODED_COUPON, MARKDOWN_SALE, and ORDER_DISCOUNT discounts, populate this field with a URL that points to an image to be used with the discount. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size.")
promotion_status
class-attribute
instance-attribute
¶
promotion_status = Field(None, alias='promotionStatus', description='The current status of the discount. When creating a new discount, you must set this value to either DRAFT or SCHEDULED . Note that you must set this value to SCHEDULED when you update a RUNNING discount.')
selected_inventory_discounts
class-attribute
instance-attribute
¶
selected_inventory_discounts = Field(None, alias='selectedInventoryDiscounts', description='A list that defines the sets of selected items for the markdown discount.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The date and time the discount starts in UTC format ( yyyy-MM-ddThh:mm:ssZ ). For display purposes, convert this time into the local time of the seller.')