POST api/Coupon/HWCouponPrizeRedeemed

Notifies PFC that a coupon was redeemed by a consumer at an installer location

Request Information

URI Parameters

None.

Body Parameters

The details about the coupon that was redeemed

Name	Description	Type	Additional information
ValvolineDrivesKeyword	Keyword assigned to the installer	string	Max length: 25
CouponCode	The coupon code that was redeemed at the Valvoline Service Installer.	string	Required Max length: 20
ConsumerFirstName	Consumer First Name	string	Max length: 100
ConsumerLastName	Consumer Last Name	string	Max length: 100
ConsumerAddress1	Consumer Address Line 1	string	Max length: 100
ConsumerAddress2	Consumer Address Line 2	string	Max length: 100
ConsumerCity	Consumer City	string	Max length: 100
ConsumerState	Consumer State/Prov	string	Max length: 4
ConsumerZip	Consumer Zip Code	string	Max length: 12
ConsumerPhoneNumber	Consumer's Mobile Number	string	Max length: 50
ConsumerEmail	Consumer's Email Address	string	Max length: 150
ServiceDate	The Date the service was performed at the installer	date	Required
InvoiceNo	The invoice number on the receipt	string	Max length: 50
InstallerAccountNo	The account number of the installer	string	Max length: 40
ReceivedMethod	Allows caller to specify the received method for the coupon.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ValvolineDrivesKeyword": "sample string 1",
  "CouponCode": "sample string 2",
  "ConsumerFirstName": "sample string 3",
  "ConsumerLastName": "sample string 4",
  "ConsumerAddress1": "sample string 5",
  "ConsumerAddress2": "sample string 6",
  "ConsumerCity": "sample string 7",
  "ConsumerState": "sample string 8",
  "ConsumerZip": "sample string 9",
  "ConsumerPhoneNumber": "sample string 10",
  "ConsumerEmail": "sample string 11",
  "ServiceDate": "2025-01-09T20:03:42.4414267-06:00",
  "InvoiceNo": "sample string 13",
  "InstallerAccountNo": "sample string 14",
  "ReceivedMethod": 1
}

application/xml, text/xml

Sample:

<CouponRedeemedMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models">
  <ConsumerAddress1>sample string 5</ConsumerAddress1>
  <ConsumerAddress2>sample string 6</ConsumerAddress2>
  <ConsumerCity>sample string 7</ConsumerCity>
  <ConsumerEmail>sample string 11</ConsumerEmail>
  <ConsumerFirstName>sample string 3</ConsumerFirstName>
  <ConsumerLastName>sample string 4</ConsumerLastName>
  <ConsumerPhoneNumber>sample string 10</ConsumerPhoneNumber>
  <ConsumerState>sample string 8</ConsumerState>
  <ConsumerZip>sample string 9</ConsumerZip>
  <CouponCode>sample string 2</CouponCode>
  <InstallerAccountNo>sample string 14</InstallerAccountNo>
  <InvoiceNo>sample string 13</InvoiceNo>
  <ReceivedMethod>1</ReceivedMethod>
  <ServiceDate>2025-01-09T20:03:42.4414267-06:00</ServiceDate>
  <ValvolineDrivesKeyword>sample string 1</ValvolineDrivesKeyword>
</CouponRedeemedMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A response indicating success or failure and why the call failed

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.