DispatchCoupons Service Operation - Customer Billing

Article
03/20/2023

Dispatch coupons of the specified coupon class name owned by the specified customer.

Coupons that are already redeemed or dispatched coupons won't be dispatched.

Request Elements

The DispatchCouponsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
CouponClassName	The name of coupon class whose available coupons are dispatched.	string
CustomerId	The identifier of the customer that the coupon class belongs to.	long
SendToEmails	Email addresses to which the coupons are dispatched. Email address count should not exceed 1000.	string array

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The DispatchCouponsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
PartialErrors	An array of BatchError objects that correspond to any email addresses where the coupon code could not be sent to. The list can be empty if there were no errors.	BatchError array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <Action mustUnderstand="1">DispatchCoupons</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DispatchCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <SendToEmails i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </SendToEmails>
      <CustomerId>ValueHere</CustomerId>
      <CouponClassName i:nil="false">ValueHere</CouponClassName>
    </DispatchCouponsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DispatchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <PartialErrors xmlns:e6="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e6:BatchError>
          <e6:Code>ValueHere</e6:Code>
          <e6:Details d4p1:nil="false">ValueHere</e6:Details>
          <e6:Index>ValueHere</e6:Index>
          <e6:Message d4p1:nil="false">ValueHere</e6:Message>
        </e6:BatchError>
      </PartialErrors>
    </DispatchCouponsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<DispatchCouponsResponse> DispatchCouponsAsync(
	IList<string> sendToEmails,
	long customerId,
	string couponClassName)
{
	var request = new DispatchCouponsRequest
	{
		SendToEmails = sendToEmails,
		CustomerId = customerId,
		CouponClassName = couponClassName
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.DispatchCouponsAsync(r), request));
}

static DispatchCouponsResponse dispatchCoupons(
	ArrayOfstring sendToEmails,
	java.lang.Long customerId,
	java.lang.String couponClassName) throws RemoteException, Exception
{
	DispatchCouponsRequest request = new DispatchCouponsRequest();

	request.setSendToEmails(sendToEmails);
	request.setCustomerId(customerId);
	request.setCouponClassName(couponClassName);

	return CustomerBillingService.getService().dispatchCoupons(request);
}

static function DispatchCoupons(
	$sendToEmails,
	$customerId,
	$couponClassName)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new DispatchCouponsRequest();

	$request->SendToEmails = $sendToEmails;
	$request->CustomerId = $customerId;
	$request->CouponClassName = $couponClassName;

	return $GLOBALS['CustomerBillingProxy']->GetService()->DispatchCoupons($request);
}

response=customerbilling_service.DispatchCoupons(
	SendToEmails=SendToEmails,
	CustomerId=CustomerId,
	CouponClassName=CouponClassName)

Requirements

Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

Share via