{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:ebay-sell-marketing/get-campaigns":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_campaigns","summary":"This method retrieves the details for all of the seller's defined campaigns. Request parameters can be used…","description":"GET /ad_campaign","tags":["ecommerce"],"parameters":[{"name":"campaign_name","in":"query","required":false,"description":"Specifies the campaign name. The results are filtered to include only the campaign by the specified name. Note: The results might be null…","schema":{"type":"string","description":"Specifies the campaign name. The results are filtered to include only the campaign by the specified name. Note: The results might be null…"}},{"name":"campaign_status","in":"query","required":false,"description":"Include this filter and input a specific campaign status to retrieve campaigns currently in that state. Note: The results might not…","schema":{"type":"string","description":"Include this filter and input a specific campaign status to retrieve campaigns currently in that state. Note: The results might not…"}},{"name":"end_date_range","in":"query","required":false,"description":"Specifies the range of a campaign's end date. The results are filtered to include only campaigns with an end date that is within specified…","schema":{"type":"string","description":"Specifies the range of a campaign's end date. The results are filtered to include only campaigns with an end date that is within specified…"}},{"name":"funding_strategy","in":"query","required":false,"description":"Specifies the funding strategy for the campaign. The results will be filtered to only include campaigns with the specified funding model.…","schema":{"type":"string","description":"Specifies the funding strategy for the campaign. The results will be filtered to only include campaigns with the specified funding model.…"}},{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of campaigns to return on a page in the paginated response. Default: 10 Maximum: 500","schema":{"type":"string","description":"Specifies the maximum number of campaigns to return on a page in the paginated response. Default: 10 Maximum: 500"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response. Combine offset…","schema":{"type":"string","description":"Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response. Combine offset…"}},{"name":"start_date_range","in":"query","required":false,"description":"Specifies the range of a campaign's start date in which to filter the results. The results are filtered to include only campaigns with a…","schema":{"type":"string","description":"Specifies the range of a campaign's start date in which to filter the results. The results are filtered to include only campaigns with a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_campaign","summary":"This method creates a Promoted Listings ad campaign. A Promoted Listings campaign is the structure into…","description":"POST /ad_campaign","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/find-campaign-by-ad-reference":{"get":{"operationId":"ecommerce_ebay_sell_marketing_find_campaign_by_ad_reference","summary":"This method retrieves the campaigns containing the listing that is specified using either a listing ID, or…","description":"GET /ad_campaign/find_campaign_by_ad_reference","tags":["ecommerce"],"parameters":[{"name":"inventory_reference_id","in":"query","required":false,"description":"The seller's inventory reference ID of the listing to be used to find the campaign in which it is associated. This will either be a…","schema":{"type":"string","description":"The seller's inventory reference ID of the listing to be used to find the campaign in which it is associated. This will either be a…"}},{"name":"inventory_reference_type","in":"query","required":false,"description":"The type of the seller's inventory reference ID, which is a listing or group of items. You must always pass in both inventory_reference_id…","schema":{"type":"string","description":"The type of the seller's inventory reference ID, which is a listing or group of items. You must always pass in both inventory_reference_id…"}},{"name":"listing_id","in":"query","required":false,"description":"Identifier of the eBay listing associated with the ad.","schema":{"type":"string","description":"Identifier of the eBay listing associated with the ad."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-campaign-by-name":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_campaign_by_name","summary":"This method retrieves the details of a single campaign, as specified with the campaign_name query parameter.…","description":"GET /ad_campaign/get_campaign_by_name","tags":["ecommerce"],"parameters":[{"name":"campaign_name","in":"query","required":true,"description":"The name of the campaign.","schema":{"type":"string","description":"The name of the campaign."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-campaign":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_campaign","summary":"This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.…","description":"GET /ad_campaign/{campaign_id}","tags":["ecommerce"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_campaign","summary":"This method deletes the campaign specified by the campaign_id query parameter. Note: You can only delete…","description":"DELETE /ad_campaign/{campaign_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-ads":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_ads","summary":"This method retrieves Promoted Listings ads that are associated with listings created with either the…","description":"GET /ad_campaign/{campaign_id}/ad","tags":["ecommerce"],"parameters":[{"name":"ad_group_ids","in":"query","required":false,"description":"A comma-separated list of ad group IDs. The results will be filtered to only include active ads for these ad groups. Call getAdGroups to…","schema":{"type":"string","description":"A comma-separated list of ad group IDs. The results will be filtered to only include active ads for these ad groups. Call getAdGroups to…"}},{"name":"ad_status","in":"query","required":false,"description":"A comma-separated list of ad statuses. The results will be filtered to only include the given statuses of the ad. If none are provided,…","schema":{"type":"string","description":"A comma-separated list of ad statuses. The results will be filtered to only include the given statuses of the ad. If none are provided,…"}},{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of ads to return on a page in the paginated response. Default: 10 Maximum: 500","schema":{"type":"string","description":"Specifies the maximum number of ads to return on a page in the paginated response. Default: 10 Maximum: 500"}},{"name":"listing_ids","in":"query","required":false,"description":"A comma-separated list of listing IDs. The response includes only active ads (ads associated with a RUNNING campaign). The results do not…","schema":{"type":"string","description":"A comma-separated list of listing IDs. The response includes only active ads (ads associated with a RUNNING campaign). The results do not…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of ads to skip in the result set before returning the first ad in the paginated response. Combine offset with the…","schema":{"type":"string","description":"Specifies the number of ads to skip in the result set before returning the first ad in the paginated response. Combine offset with the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-ad-by-listing-id":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_ad_by_listing_id","summary":"This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by…","description":"POST /ad_campaign/{campaign_id}/ad","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-ad":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_ad","summary":"This method retrieves the specified ad from the specified campaign. In the request, supply the campaign_id…","description":"GET /ad_campaign/{campaign_id}/ad/{ad_id}","tags":["ecommerce"],"parameters":[{"name":"ad_id","in":"query","required":true,"description":"A unique identifier for an ad. This ID is generated when the ad is created.","schema":{"type":"string","description":"A unique identifier for an ad. This ID is generated when the ad is created."}},{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-ad":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_ad","summary":"This method removes the specified ad from the specified campaign. Pass the ID of the ad to delete with the…","description":"DELETE /ad_campaign/{campaign_id}/ad/{ad_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ad_id","campaign_id"],"properties":{"ad_id":{"type":"string","description":"Identifier of an ad. This ID was generated when the ad was created."},"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-bid":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_bid","summary":"This method updates the bid percentage (also known as the \"ad rate\") for the specified ad in the specified…","description":"POST /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ad_id","campaign_id","body"],"properties":{"ad_id":{"type":"string","description":"A unique eBay-assigned ID for an ad that's generated when an ad is created."},"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-ad-groups":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_ad_groups","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /ad_campaign/{campaign_id}/ad_group","tags":["ecommerce"],"parameters":[{"name":"ad_group_status","in":"query","required":false,"description":"A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group. The results…","schema":{"type":"string","description":"A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group. The results…"}},{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"limit","in":"query","required":false,"description":"The number of results, from the current result set, to be returned in a single page.","schema":{"type":"string","description":"The number of results, from the current result set, to be returned in a single page."}},{"name":"offset","in":"query","required":false,"description":"The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output.…","schema":{"type":"string","description":"The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-ad-group":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_ad_group","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/ad_group","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-ad-group":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_ad_group","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /ad_campaign/{campaign_id}/ad_group/{ad_group_id}","tags":["ecommerce"],"parameters":[{"name":"ad_group_id","in":"query","required":true,"description":"The ID of the ad group that shall be retrieved.","schema":{"type":"string","description":"The ID of the ad group that shall be retrieved."}},{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-ad-group":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_ad_group","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"PUT /ad_campaign/{campaign_id}/ad_group/{ad_group_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ad_group_id","campaign_id","body"],"properties":{"ad_group_id":{"type":"string","description":"The ID of the ad group that shall be updated."},"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/suggest-bids":{"post":{"operationId":"ecommerce_ebay_sell_marketing_suggest_bids","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ad_group_id","campaign_id","body"],"properties":{"ad_group_id":{"type":"string","description":"The ID of the ad group containing the keywords for which the bid suggestions will be provided."},"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/suggest-keywords":{"post":{"operationId":"ecommerce_ebay_sell_marketing_suggest_keywords","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ad_group_id","campaign_id"],"properties":{"ad_group_id":{"type":"string","description":"The ID of the ad group for which the keyword suggestions will be provided."},"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-create-ads-by-inventory-reference":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_create_ads_by_inventory_reference","summary":"This method adds multiple listings that are managed with the Inventory API to an existing Promoted Listings…","description":"POST /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-create-ads-by-listing-id":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_create_ads_by_listing_id","summary":"This method adds multiple listings to an existing Promoted Listings campaign using listingId values…","description":"POST /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-create-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_create_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/bulk_create_keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-delete-ads-by-inventory-reference":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_delete_ads_by_inventory_reference","summary":"This method works with listings created with the Inventory API . The method deletes a set of ads, as…","description":"POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-delete-ads-by-listing-id":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_delete_ads_by_listing_id","summary":"This method works with listing IDs created with either the Trading API or the Inventory API . The method…","description":"POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-ads-bid-by-inventory-reference":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_ads_bid_by_inventory_reference","summary":"This method works with listings created with either the Trading API or the Inventory API . The method…","description":"POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-ads-bid-by-listing-id":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_ads_bid_by_listing_id","summary":"This method works with listings created with either the Trading API or the Inventory API . The method…","description":"POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-ads-status":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_ads_status","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/bulk_update_ads_status","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-ads-status-by-listing-id":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_ads_status_by_listing_id","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/bulk_update_ads_status_by_listing_id","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/bulk_update_keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/clone-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_clone_campaign","summary":"This method clones (makes a copy of) the specified campaign's campaign criterion . The campaign criterion is…","description":"POST /ad_campaign/{campaign_id}/clone","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. This ID is the campaign ID of the campaign…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-ads-by-inventory-reference":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_ads_by_inventory_reference","summary":"This method adds a listing that is managed with the Inventory API to an existing Promoted Listings campaign.…","description":"POST /ad_campaign/{campaign_id}/create_ads_by_inventory_reference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-ads-by-inventory-reference":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_ads_by_inventory_reference","summary":"This method works with listings that are managed with the Inventory API . The method deletes ads using a…","description":"POST /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/end-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_end_campaign","summary":"This method ends an active ( RUNNING ) or paused campaign. Specify the campaign you want to end by supplying…","description":"POST /ad_campaign/{campaign_id}/end","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-ads-by-inventory-reference":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_ads_by_inventory_reference","summary":"This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API…","description":"GET /ad_campaign/{campaign_id}/get_ads_by_inventory_reference","tags":["ecommerce"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"inventory_reference_id","in":"query","required":true,"description":"The inventory reference ID associated with the ad you want returned. A seller's inventory reference ID is the ID of either a listing or…","schema":{"type":"string","description":"The inventory reference ID associated with the ad you want returned. A seller's inventory reference ID is the ID of either a listing or…"}},{"name":"inventory_reference_type","in":"query","required":true,"description":"The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a single listing) or INVENTORY_ITEM_GROUP (a…","schema":{"type":"string","description":"The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a single listing) or INVENTORY_ITEM_GROUP (a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-keywords":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_keywords","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /ad_campaign/{campaign_id}/keyword","tags":["ecommerce"],"parameters":[{"name":"ad_group_ids","in":"query","required":false,"description":"A comma-separated list of ad group IDs. This query parameter is used if the seller wants to retrieve keywords from one or more specific ad…","schema":{"type":"string","description":"A comma-separated list of ad group IDs. This query parameter is used if the seller wants to retrieve keywords from one or more specific ad…"}},{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"keyword_status","in":"query","required":false,"description":"A comma-separated list of keyword statuses. The results will be filtered to only include the given statuses of the keyword. If none are…","schema":{"type":"string","description":"A comma-separated list of keyword statuses. The results will be filtered to only include the given statuses of the keyword. If none are…"}},{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of results to return on a page in the paginated response. Default: 10 Maximum: 500","schema":{"type":"string","description":"Specifies the maximum number of results to return on a page in the paginated response. Default: 10 Maximum: 500"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of results to skip in the result set before returning the first report in the paginated response. Combine offset with…","schema":{"type":"string","description":"Specifies the number of results to skip in the result set before returning the first report in the paginated response. Combine offset with…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-keyword":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /ad_campaign/{campaign_id}/keyword/{keyword_id}","tags":["ecommerce"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"keyword_id","in":"query","required":true,"description":"This path parameter is used to identify the keyword to retrieve.","schema":{"type":"string","description":"This path parameter is used to identify the keyword to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"PUT /ad_campaign/{campaign_id}/keyword/{keyword_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","keyword_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"keyword_id":{"type":"string","description":"A unique eBay-assigned ID that is generated when a keyword is created."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/pause-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_pause_campaign","summary":"This method pauses an active (RUNNING) campaign. You can restart the campaign by calling resumeCampaign , as…","description":"POST /ad_campaign/{campaign_id}/pause","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/resume-campaign":{"post":{"operationId":"ecommerce_ebay_sell_marketing_resume_campaign","summary":"This method resumes a paused campaign, as long as its end date is in the future. Supply the campaign_id for…","description":"POST /ad_campaign/{campaign_id}/resume","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/suggest-items":{"get":{"operationId":"ecommerce_ebay_sell_marketing_suggest_items","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /ad_campaign/{campaign_id}/suggest_items","tags":["ecommerce"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"}},{"name":"category_ids","in":"query","required":false,"description":"Specifies the category ID that is used to limit the results. This refers to an exact leaf category (the lowest level in that category and…","schema":{"type":"string","description":"Specifies the category ID that is used to limit the results. This refers to an exact leaf category (the lowest level in that category and…"}},{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of campaigns to return on a page in the paginated response. If no value is specified, the default value is…","schema":{"type":"string","description":"Specifies the maximum number of campaigns to return on a page in the paginated response. If no value is specified, the default value is…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response. Combine offset…","schema":{"type":"string","description":"Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response. Combine offset…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-ad-rate-strategy":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_ad_rate_strategy","summary":"This method updates the ad rate strategy for an existing Promoted Listings Standard (PLS) rules-based ad…","description":"POST /ad_campaign/{campaign_id}/update_ad_rate_strategy","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-campaign-budget":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_campaign_budget","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /ad_campaign/{campaign_id}/update_campaign_budget","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-campaign-identification":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_campaign_identification","summary":"This method can be used to change the name of a campaign, as well as modify the start or end dates. Specify…","description":"POST /ad_campaign/{campaign_id}/update_campaign_identification","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","body"],"properties":{"campaign_id":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-report":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_report","summary":"This call downloads the report as specified by the report_id path parameter. Call createReportTask to…","description":"GET /ad_report/{report_id}","tags":["ecommerce"],"parameters":[{"name":"report_id","in":"query","required":true,"description":"The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when you run a report task with a call to…","schema":{"type":"string","description":"The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when you run a report task with a call to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-report-metadata":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_report_metadata","summary":"This call retrieves information that details the fields used in each of the Promoted Listings reports. Use…","description":"GET /ad_report_metadata","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-report-metadata-for-report-type":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_report_metadata_for_report_type","summary":"This call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use…","description":"GET /ad_report_metadata/{report_type}","tags":["ecommerce"],"parameters":[{"name":"report_type","in":"query","required":true,"description":"The name of the report type whose metadata you want to retrieve. Tip: For details about available report types and their descriptions,…","schema":{"type":"string","description":"The name of the report type whose metadata you want to retrieve. Tip: For details about available report types and their descriptions,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-report-tasks":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_report_tasks","summary":"This method returns information on all the existing report tasks related to a seller. Use the…","description":"GET /ad_report_task","tags":["ecommerce"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of report tasks to return on a page in the paginated response. Default: 10 Maximum: 500","schema":{"type":"string","description":"Specifies the maximum number of report tasks to return on a page in the paginated response. Default: 10 Maximum: 500"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of report tasks to skip in the result set before returning the first report in the paginated response. Combine offset…","schema":{"type":"string","description":"Specifies the number of report tasks to skip in the result set before returning the first report in the paginated response. Combine offset…"}},{"name":"report_task_statuses","in":"query","required":false,"description":"This parameter filters the returned report tasks by their status. Supply a comma-separated list of the report statuses you want returned.…","schema":{"type":"string","description":"This parameter filters the returned report tasks by their status. Supply a comma-separated list of the report statuses you want returned.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-report-task":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_report_task","summary":"Note: Using multiple funding models in one report is deprecated. If multiple funding models are used, a…","description":"POST /ad_report_task","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-report-task":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_report_task","summary":"This call returns the details of a specific Promoted Listings report task, as specified by the…","description":"GET /ad_report_task/{report_task_id}","tags":["ecommerce"],"parameters":[{"name":"report_task_id","in":"query","required":true,"description":"A unique eBay-assigned ID for the report task that's generated when the report task is created by a call to createReportTask .","schema":{"type":"string","description":"A unique eBay-assigned ID for the report task that's generated when the report task is created by a call to createReportTask ."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-report-task":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_report_task","summary":"This call deletes the report task specified by the report_task_id path parameter. This method also deletes…","description":"DELETE /ad_report_task/{report_task_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["report_task_id"],"properties":{"report_task_id":{"type":"string","description":"A unique eBay-assigned ID for the report task that's generated when the report task is created by a call to createReportTask ."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-create-negative-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_create_negative_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /bulk_create_negative_keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/bulk-update-negative-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_bulk_update_negative_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /bulk_update_negative_keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-item-price-markdown-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_item_price_markdown_promotion","summary":"This method creates an item price markdown promotion (know simply as a \"markdown promotion\") where a…","description":"POST /item_price_markdown","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-item-price-markdown-promotion":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_item_price_markdown_promotion","summary":"This method returns the complete details of the item price markdown promotion that's indicated by the…","description":"GET /item_price_markdown/{promotion_id}","tags":["ecommerce"],"parameters":[{"name":"promotion_id","in":"query","required":true,"description":"This path parameter takes a concatenation of the ID of the promotion you want to get plus the marketplace ID on which the promotion is…","schema":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to get plus the marketplace ID on which the promotion is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-item-price-markdown-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_item_price_markdown_promotion","summary":"This method updates the specified item price markdown promotion with the new configuration that you supply…","description":"PUT /item_price_markdown/{promotion_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to update plus the marketplace ID on which the promotion is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-item-price-markdown-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_item_price_markdown_promotion","summary":"This method deletes the item price markdown promotion specified by the promotion_id path parameter. Call…","description":"DELETE /item_price_markdown/{promotion_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to delete plus the marketplace ID on which the promotion is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-item-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_item_promotion","summary":"This method creates an item promotion , where the buyer receives a discount when they meet the buying…","description":"POST /item_promotion","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-item-promotion":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_item_promotion","summary":"This method returns the complete details of the threshold promotion specified by the promotion_id path…","description":"GET /item_promotion/{promotion_id}","tags":["ecommerce"],"parameters":[{"name":"promotion_id","in":"query","required":true,"description":"This path parameter takes a concatenation of the ID of the promotion you want to retrieve plus the marketplace ID on which the promotion…","schema":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to retrieve plus the marketplace ID on which the promotion…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-item-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_item_promotion","summary":"This method updates the specified threshold promotion with the new configuration that you supply in the…","description":"PUT /item_promotion/{promotion_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to update plus the marketplace ID on which the promotion is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/delete-item-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_delete_item_promotion","summary":"This method deletes the threshold promotion specified by the promotion_id path parameter. Call getPromotions…","description":"DELETE /item_promotion/{promotion_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to delete plus the marketplace ID on which the promotion is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-negative-keywords":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_negative_keywords","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /negative_keyword","tags":["ecommerce"],"parameters":[{"name":"ad_group_ids","in":"query","required":false,"description":"A comma-separated list of ad group IDs. This query parameter is used if the seller wants to retrieve the negative keywords from one or…","schema":{"type":"string","description":"A comma-separated list of ad group IDs. This query parameter is used if the seller wants to retrieve the negative keywords from one or…"}},{"name":"campaign_ids","in":"query","required":false,"description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. This query parameter is used if the seller…","schema":{"type":"string","description":"A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. This query parameter is used if the seller…"}},{"name":"limit","in":"query","required":false,"description":"The number of results, from the current result set, to be returned in a single page.","schema":{"type":"string","description":"The number of results, from the current result set, to be returned in a single page."}},{"name":"negative_keyword_status","in":"query","required":false,"description":"A comma-separated list of negative keyword statuses. This query parameter is used if the seller wants to filter the search results based…","schema":{"type":"string","description":"A comma-separated list of negative keyword statuses. This query parameter is used if the seller wants to filter the search results based…"}},{"name":"offset","in":"query","required":false,"description":"The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output.…","schema":{"type":"string","description":"The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/create-negative-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_create_negative_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"POST /negative_keyword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-negative-keyword":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_negative_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"GET /negative_keyword/{negative_keyword_id}","tags":["ecommerce"],"parameters":[{"name":"negative_keyword_id","in":"query","required":true,"description":"The unique identifier for the negative keyword. This value is returned in the Location response header from the createNegativeKeyword…","schema":{"type":"string","description":"The unique identifier for the negative keyword. This value is returned in the Location response header from the createNegativeKeyword…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/update-negative-keyword":{"post":{"operationId":"ecommerce_ebay_sell_marketing_update_negative_keyword","summary":"Note: This method is only available for select partners who have been approved for the eBay Promoted…","description":"PUT /negative_keyword/{negative_keyword_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["negative_keyword_id","body"],"properties":{"negative_keyword_id":{"type":"string","description":"The unique identifier for the negative keyword. This value is returned in the Location response header from the createNegativeKeyword…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-promotions":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_promotions","summary":"This method returns a list of a seller's undeleted promotions. The call returns up to 200…","description":"GET /promotion","tags":["ecommerce"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200","schema":{"type":"string","description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200"}},{"name":"marketplace_id","in":"query","required":true,"description":"The eBay marketplace ID of the site where the promotion is hosted. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES = Spain…","schema":{"type":"string","description":"The eBay marketplace ID of the site where the promotion is hosted. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES = Spain…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…","schema":{"type":"string","description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…"}},{"name":"promotion_status","in":"query","required":false,"description":"Specifies the promotion state by which you want to filter the results. The response contains only those promotions that match the state…","schema":{"type":"string","description":"Specifies the promotion state by which you want to filter the results. The response contains only those promotions that match the state…"}},{"name":"promotion_type","in":"query","required":false,"description":"Filters the returned promotions based on their campaign promotion type. Specify one of the following values to indicate the promotion type…","schema":{"type":"string","description":"Filters the returned promotions based on their campaign promotion type. Specify one of the following values to indicate the promotion type…"}},{"name":"q","in":"query","required":false,"description":"A string consisting of one or more keywords . eBay filters the response by returning only the promotions that contain the supplied…","schema":{"type":"string","description":"A string consisting of one or more keywords . eBay filters the response by returning only the promotions that contain the supplied…"}},{"name":"sort","in":"query","required":false,"description":"Specifies the order for how to sort the response. If you precede the supplied value with a dash, the response is sorted in reverse order.…","schema":{"type":"string","description":"Specifies the order for how to sort the response. If you precede the supplied value with a dash, the response is sorted in reverse order.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-listing-set":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_listing_set","summary":"This method returns the set of listings associated with the promotion_id specified in the path parameter.…","description":"GET /promotion/{promotion_id}/get_listing_set","tags":["ecommerce"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200","schema":{"type":"string","description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…","schema":{"type":"string","description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…"}},{"name":"promotion_id","in":"query","required":true,"description":"This path parameter takes a concatenation of the ID of the promotion you want to get plus the marketplace ID on which the promotion is…","schema":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to get plus the marketplace ID on which the promotion is…"}},{"name":"q","in":"query","required":false,"description":"Reserved for future use.","schema":{"type":"string","description":"Reserved for future use."}},{"name":"sort","in":"query","required":false,"description":"Specifies the order in which to sort the associated listings in the response. If you precede the supplied value with a dash, the response…","schema":{"type":"string","description":"Specifies the order in which to sort the associated listings in the response. If you precede the supplied value with a dash, the response…"}},{"name":"status","in":"query","required":false,"description":"This query parameter applies only to markdown promotions. It filters the response based on the indicated status of the promotion.…","schema":{"type":"string","description":"This query parameter applies only to markdown promotions. It filters the response based on the indicated status of the promotion.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/pause-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_pause_promotion","summary":"This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion…","description":"POST /promotion/{promotion_id}/pause","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to pause plus the marketplace ID on which the promotion is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/resume-promotion":{"post":{"operationId":"ecommerce_ebay_sell_marketing_resume_promotion","summary":"This method restarts a threshold promotion that was previously paused and changes the state of the promotion…","description":"POST /promotion/{promotion_id}/resume","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_id"],"properties":{"promotion_id":{"type":"string","description":"This path parameter takes a concatenation of the ID of the promotion you want to resume plus the marketplace ID on which the promotion is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-promotion-reports":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_promotion_reports","summary":"This method generates a report that lists the seller's running, paused, and ended promotions for the…","description":"GET /promotion_report","tags":["ecommerce"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200","schema":{"type":"string","description":"Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200"}},{"name":"marketplace_id","in":"query","required":true,"description":"The eBay marketplace ID of the site for which you want the promotions report. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES…","schema":{"type":"string","description":"The eBay marketplace ID of the site for which you want the promotions report. Valid values: EBAY_AU = Australia EBAY_DE = Germany EBAY_ES…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…","schema":{"type":"string","description":"Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine…"}},{"name":"promotion_status","in":"query","required":false,"description":"Limits the results to the promotions that are in the state specified by this query parameter. Valid values: DRAFT SCHEDULED RUNNING PAUSED…","schema":{"type":"string","description":"Limits the results to the promotions that are in the state specified by this query parameter. Valid values: DRAFT SCHEDULED RUNNING PAUSED…"}},{"name":"promotion_type","in":"query","required":false,"description":"Filters the returned promotions in the report based on their campaign promotion type. Specify one of the following values to indicate the…","schema":{"type":"string","description":"Filters the returned promotions in the report based on their campaign promotion type. Specify one of the following values to indicate the…"}},{"name":"q","in":"query","required":false,"description":"A string consisting of one or more keywords . eBay filters the response by returning only the promotions that contain the supplied…","schema":{"type":"string","description":"A string consisting of one or more keywords . eBay filters the response by returning only the promotions that contain the supplied…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-marketing/get-promotion-summary-report":{"get":{"operationId":"ecommerce_ebay_sell_marketing_get_promotion_summary_report","summary":"This method generates a report that summarizes the seller's promotions for the specified eBay marketplace.…","description":"GET /promotion_summary_report","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"The eBay marketplace ID of the site you for which you want a promotion summary report. Valid values: EBAY_AU = Australia EBAY_DE = Germany…","schema":{"type":"string","description":"The eBay marketplace ID of the site you for which you want a promotion summary report. Valid values: EBAY_AU = Australia EBAY_DE = Germany…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}