POST api/Coupon/HWCouponPrizeCreated

Notifies PFC that a coupon was created for an installer

Request Information

URI Parameters

None.

Body Parameters

The details about the coupon that was created

Name	Description	Type	Additional information
ConsumerFirstName	Consumer's First Name	string	Required Max length: 100
ConsumerLastName	Consumer's Last Name	string	Required Max length: 100
ConsumerAddress1	Consumer's Address: Line 1	string	Max length: 100
ConsumerAddress2	Consumer's Address: Line 2	string	Max length: 100
ConsumerCity	Consumer's City	string	Max length: 100
ConsumerState	Consumer's State/Prov.	string	Max length: 4
ConsumerZip	Consumer's Zip Code	string	Max length: 12
ConsumerPhoneNumber	Consumer's Mobile Number	string	Max length: 50
ConsumerEmail	Consumer's Email Address	string	Required Max length: 150
OpCode	PFC defined 3 character code that identifies the type of coupon/dollar amount	string	Required Max length: 6
ServiceDate	The date the Valvoline service was completed at the installer	date	Required
InvoiceNo	The Invoice Number of the consumer's service visit.	string	Max length: 50
ProgramCode	The PFC defined code that specifies the valid promotion for the coupon	string	Required Max length: 40
InstallerAccountNo	The account number of the installer that provided the Vavloline service	string	Max length: 50
InstallerName	The name of the installer that provided the Valvoline service	string	Max length: 100
CustomerRewardCardLink	A link to the created reward card	string	Max length: 255
CouponCode	The coupon code that was redeemed at the Valvoline Service Installer	string	Required Max length: 20
CouponAmt	If supllied create the coupon using this dollar amount as the issued amount.	decimal number	None.
CouponIssueDate	The date the coupon was issued to the consumer	date	Required
CouponExpirationDate	The last day the consumer can redeem the coupon	date	Required
ValvolineDrivesKeyword	The keyword the coupon is valid for. This will define the installer that gets payment at the installer location	string	Max length: 25
ProofCode		string	None.
SubmissionID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ConsumerFirstName": "sample string 1",
  "ConsumerLastName": "sample string 2",
  "ConsumerAddress1": "sample string 3",
  "ConsumerAddress2": "sample string 4",
  "ConsumerCity": "sample string 5",
  "ConsumerState": "sample string 6",
  "ConsumerZip": "sample string 7",
  "ConsumerPhoneNumber": "sample string 8",
  "ConsumerEmail": "sample string 9",
  "OpCode": "sample string 10",
  "ServiceDate": "2025-01-09T19:50:10.1846476-06:00",
  "InvoiceNo": "sample string 12",
  "ProgramCode": "sample string 13",
  "InstallerAccountNo": "sample string 14",
  "InstallerName": "sample string 15",
  "CustomerRewardCardLink": "sample string 16",
  "CouponCode": "sample string 17",
  "CouponAmt": 1.0,
  "CouponIssueDate": "2025-01-09T19:50:10.1846476-06:00",
  "CouponExpirationDate": "2025-01-09T19:50:10.1846476-06:00",
  "ValvolineDrivesKeyword": "sample string 20",
  "ReimbursementAmount": 1.0,
  "ProofCode": "sample string 21",
  "SubmissionID": "sample string 22"
}

application/xml, text/xml

Sample:

<CouponCreatedMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models">
  <ConsumerAddress1>sample string 3</ConsumerAddress1>
  <ConsumerAddress2>sample string 4</ConsumerAddress2>
  <ConsumerCity>sample string 5</ConsumerCity>
  <ConsumerEmail>sample string 9</ConsumerEmail>
  <ConsumerFirstName>sample string 1</ConsumerFirstName>
  <ConsumerLastName>sample string 2</ConsumerLastName>
  <ConsumerPhoneNumber>sample string 8</ConsumerPhoneNumber>
  <ConsumerState>sample string 6</ConsumerState>
  <ConsumerZip>sample string 7</ConsumerZip>
  <CouponAmt>1</CouponAmt>
  <CouponCode>sample string 17</CouponCode>
  <CouponExpirationDate>2025-01-09T19:50:10.1846476-06:00</CouponExpirationDate>
  <CouponIssueDate>2025-01-09T19:50:10.1846476-06:00</CouponIssueDate>
  <CustomerRewardCardLink>sample string 16</CustomerRewardCardLink>
  <InstallerAccountNo>sample string 14</InstallerAccountNo>
  <InstallerName>sample string 15</InstallerName>
  <InvoiceNo>sample string 12</InvoiceNo>
  <OpCode>sample string 10</OpCode>
  <ProgramCode>sample string 13</ProgramCode>
  <ProofCode>sample string 21</ProofCode>
  <ReimbursementAmount>1</ReimbursementAmount>
  <ServiceDate>2025-01-09T19:50:10.1846476-06:00</ServiceDate>
  <SubmissionID>sample string 22</SubmissionID>
  <ValvolineDrivesKeyword>sample string 20</ValvolineDrivesKeyword>
</CouponCreatedMessage>

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.