deleteCampaigns

The deleteCampaigns call is used by a seller to delete one or more discount campaigns.

Request Details

Pass in one or more campaignId values in the deleteCampaigns request to delete discount campaigns.

Working with the Response

To verify if the deleteCampaigns call was successful in deleting all specified discount campaigns, look for the campaignDeleteStatus field. This boolean field is returned as "true" if all discount campaigns passed into the request are successfully deleted. If one or more discount campaign deletions are unsuccessful, this field is not returned, and the caller will need to view any corresponding error messages in the response.

deleteCampaigns Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

deleteCampaigns Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<deleteCampaignsResponse xmlns="http://www.ebay.com/marketplace/incentives/v1/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <campaignDeleteStatus> boolean </campaignDeleteStatus>
</deleteCampaignsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	A token representing the application-level acknowledgement code that indicates the response status.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Trading API Guide for information about this time format and converting to and from the GMT time zone.
version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.

Call-specific Output Fields

campaignDeleteStatus

boolean

Conditionally

Boolean field that is returned as "true" if all discount campaigns passed into the request are successfully deleted. If one or more discount campaign deletions are unsuccessful, this field is not returned, and the caller will need to view any corresponding error messages in the response.

deleteCampaigns Samples

deleteCampaigns Change History

Version	Description
1.0.0 2011-09-14	(added) New call.

User-Contributed Notes

Order Size Discounts API Call Reference Version 1.0.0