setCampaignStatus

The setCampaignStatus call is used by the seller to update the status of one discount campaign.

Request Details

Pass in one campaignId value and one campaigStatus value in the request to update the status of the specified campaign to that value.

Working with the Response

To verify if the setCampaignStatus call was successful in updating the status of the specified discount campaign, look for an ack value of Success. If the call is unsuccessful, the caller will need to view any corresponding error messages in the response.

setCampaignStatus 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).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<setCampaignStatusRequest xmlns="http://www.ebay.com/marketplace/incentives/v1/services">
  <campaignId> long </campaignId>
  <campaigStatus> CampaignStatusEnum </campaigStatus>
</setCampaignStatusRequest>

Argument	Type	Occurrence	Meaning

campaignId

long

Required

Specify one campaignId value to update the status of the corresponding discount campaign.

campaigStatus

CampaignStatusEnum

Required

Specify one CampaignStatusEnum value in the campaigStatus field to change the corresponding discount campaign to this status.

Applicable values:

• ACTIVE

(in/out) This value indicates that the discount campaign is active. Typically, a seller would specify this value in the createCampaign call to create and activate the discount campaign, or in the updateCampaigns or setCampaignStatus calls to activate a disabled discount campaign.

• DELETED

(in/out) This value indicates that the discount campaign has been deleted. Typically, a seller would specify this value in the updateCampaigns or setCampaignStatus calls to delete a discount campaign.

• DRAFT

(in/out) This value indicates that the discount campaign is in "Draft" mode only, and will not become ACTIVE when the startDate value is reached.

• ENDED

(in/out) This value indicates that the life of the discount campaign has ended. The life of a discount campaign ends when the endDate dateTime value is reached.

• ONHOLD

(in/out) This value indicates that the discount campaign has been put on hold. Typically, a seller would specify this value in the updateCampaigns or setCampaignStatus calls to place an active discount campaign on hold. Discount campaigns in the ONHOLD state can be activated again.

• SCHEDULED

(in/out) This value indicates that the discount campaign is scheduled to become ACTIVE when the startDate dateTime value is reached.

setCampaignStatus 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"?>
<setCampaignStatusResponse xmlns="http://www.ebay.com/marketplace/incentives/v1/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</setCampaignStatusResponse>

Return Value	Type	Occurrence	Meaning

Standard Output 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.

setCampaignStatus Samples

setCampaignStatus 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