POST api/Submission/PostSubmission

Handles a promotion submission and validates the consumer's eligibility.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Submission ID	Submission ID (GUID): The unique id that is used to tie together all entries to 1 consumer submisison event.	globally unique identifier	Required
Confirmation Number		string	None.
Promotion Number	Promotion Number (string): The identifying id that is associated to the promotion.	string	Required Max length: 5
Company Name	Company Name: The name of the company related to the Consumer.	string	None.
Number of Invoice Images	Number of Invoice Images (int): The number of images submitted with the submission.	integer	None.
Submission Date	Submission Date (DateTime): The date and time the submission was submitted.	string	Required Max length: 8
Expedite Status		string	Max length: 1 String length: inclusive between 0 and 1
First Name	First Name (string): The Consumer's first name.	string	Required Max length: 20
Last Name	Last Name (string): The Consumer's last name.	string	Required Max length: 20
Address Line 1	Address Line 1 (string): The first line of the Consumer's address.	string	Required Max length: 32
Address Line 2	Address Line 2 (string ): The second line of the Consumer's address.	string	Max length: 32
City	City (string): The city associated with the Consumer's address.	string	Required Max length: 20
State	State (string): The two letter state code associated with the Consumer's address.	string	Required Max length: 2
Postal Code	Postal Code (string): The postal code associated with the Consumer's address.	string	Required Max length: 7
Country	Country (string): The 2 or 3 letter country code associated with the Consumer's address.	string	Max length: 3
Email Address	Email address (string): The Consumer's email address	string	Max length: 40
Home Phone	Home Phone (string): The Consumer's home phone number without dashes or spaces.	string	Max length: 14
Work Phone	Work Phone (string): The Consumer's work phone number without dashes or spaces.	string	Max length: 14
Mobile Phone	Mobile Phone (string): The Consumer's mobile phone number without dashes or spaces.	string	Max length: 14
Birthday	Birthday: The Consumer's date of birth.	date	None.
Submission Method		string	None.
Invoice Number		string	None.
Store Number		string	None.
SalesRep		string	None.
AccountNumber		string	None.
PaymentType		string	None.
Distributer		Distributer	None.
OptIns		Collection of OptIn	None.
Rewards		Collection of Reward	None.
Invoices		Collection of Invoice	None.
Surveys		Collection of Survey	None.
Purchases		Collection of Purchase	None.
MiscellaneousHeaderFields		Collection of MiscellaneousHeaderField	None.
MiscellaneousDetailFields		Collection of MiscellaneousDetailField	None.

Request Formats

application/json, text/json

Sample:

{
  "Submission ID": "f128ec40-3a08-459d-84b0-a1fc0b3e5903",
  "Confirmation Number": "sample string 2",
  "Promotion Number": "sample string 3",
  "Company Name": "sample string 4",
  "Number of Invoice Images": 5,
  "Submission Date": "sample string 6",
  "Expedite Status": "sample string 7",
  "First Name": "sample string 8",
  "Last Name": "sample string 9",
  "Address Line 1": "sample string 10",
  "Address Line 2": "sample string 11",
  "City": "sample string 12",
  "State": "sample string 13",
  "Postal Code": "sample string 14",
  "Country": "sample string 15",
  "Email Address": "sample string 16",
  "Home Phone": "sample string 17",
  "Work Phone": "sample string 18",
  "Mobile Phone": "sample string 19",
  "Birthday": "2025-01-09T19:33:38.2846095-06:00",
  "Submission Method": "sample string 20",
  "Invoice Number": "sample string 21",
  "Store Number": "sample string 22",
  "SalesRep": "sample string 23",
  "AccountNumber": "sample string 24",
  "PaymentType": "sample string 28",
  "Distributer": {
    "Name": "sample string 2",
    "Contact Name": "sample string 3",
    "Contact Phone Number": "sample string 4",
    "Contact Email": "sample string 5"
  },
  "OptIns": [
    {
      "Opt In Type": 2,
      "Reward Type": "sample string 3",
      "Opt In Value": 4.0,
      "Reward SKU": "sample string 5"
    },
    {
      "Opt In Type": 2,
      "Reward Type": "sample string 3",
      "Opt In Value": 4.0,
      "Reward SKU": "sample string 5"
    }
  ],
  "Rewards": [
    {
      "Reward Type": 2,
      "Cash Value": 3.0,
      "Product SKU": "sample string 4",
      "Quantity": 5
    },
    {
      "Reward Type": 2,
      "Cash Value": 3.0,
      "Product SKU": "sample string 4",
      "Quantity": 5
    }
  ],
  "Invoices": [
    {
      "InvoiceID": 1,
      "Image File Name": "sample string 2",
      "Amount": 3.0,
      "Retailer": "sample string 4",
      "InvoiceImage": "QEA=",
      "Date": "sample string 5",
      "InvoiceNumber": "sample string 6",
      "Files": [
        {
          "DateCreated": "2025-01-09T19:33:38.2846095-06:00",
          "FileName": "sample string 3",
          "File": "QEA=",
          "ImageDataURL": "sample string 4"
        },
        {
          "DateCreated": "2025-01-09T19:33:38.2846095-06:00",
          "FileName": "sample string 3",
          "File": "QEA=",
          "ImageDataURL": "sample string 4"
        }
      ],
      "Purchases": [
        {
          "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
          "Retailer": "sample string 2",
          "Quantity": 3.1,
          "Item Description": "sample string 4",
          "UPC Code": "sample string 5",
          "Purchase Price": 6.0
        },
        {
          "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
          "Retailer": "sample string 2",
          "Quantity": 3.1,
          "Item Description": "sample string 4",
          "UPC Code": "sample string 5",
          "Purchase Price": 6.0
        }
      ]
    },
    {
      "InvoiceID": 1,
      "Image File Name": "sample string 2",
      "Amount": 3.0,
      "Retailer": "sample string 4",
      "InvoiceImage": "QEA=",
      "Date": "sample string 5",
      "InvoiceNumber": "sample string 6",
      "Files": [
        {
          "DateCreated": "2025-01-09T19:33:38.2846095-06:00",
          "FileName": "sample string 3",
          "File": "QEA=",
          "ImageDataURL": "sample string 4"
        },
        {
          "DateCreated": "2025-01-09T19:33:38.2846095-06:00",
          "FileName": "sample string 3",
          "File": "QEA=",
          "ImageDataURL": "sample string 4"
        }
      ],
      "Purchases": [
        {
          "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
          "Retailer": "sample string 2",
          "Quantity": 3.1,
          "Item Description": "sample string 4",
          "UPC Code": "sample string 5",
          "Purchase Price": 6.0
        },
        {
          "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
          "Retailer": "sample string 2",
          "Quantity": 3.1,
          "Item Description": "sample string 4",
          "UPC Code": "sample string 5",
          "Purchase Price": 6.0
        }
      ]
    }
  ],
  "Surveys": [
    {
      "Survey ID": 2,
      "Question": "sample string 3",
      "Answer": "sample string 4"
    },
    {
      "Survey ID": 2,
      "Question": "sample string 3",
      "Answer": "sample string 4"
    }
  ],
  "Purchases": [
    {
      "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
      "Retailer": "sample string 2",
      "Quantity": 3.1,
      "Item Description": "sample string 4",
      "UPC Code": "sample string 5",
      "Purchase Price": 6.0
    },
    {
      "Purchase Date": "2025-01-09T19:33:38.2846095-06:00",
      "Retailer": "sample string 2",
      "Quantity": 3.1,
      "Item Description": "sample string 4",
      "UPC Code": "sample string 5",
      "Purchase Price": 6.0
    }
  ],
  "MiscellaneousHeaderFields": [
    {
      "Id": "4922bb64-7c26-40c6-a0d4-ef2b278e4191",
      "FieldName": "sample string 2",
      "FieldValue": "sample string 3",
      "Order": 5
    },
    {
      "Id": "4922bb64-7c26-40c6-a0d4-ef2b278e4191",
      "FieldName": "sample string 2",
      "FieldValue": "sample string 3",
      "Order": 5
    }
  ],
  "MiscellaneousDetailFields": [
    {
      "Id": "8c0d1aa6-0b41-429c-a024-696f88f247d7",
      "FieldName": "sample string 2",
      "FieldValue": "sample string 3",
      "Order": 5,
      "RowNumber": 6
    },
    {
      "Id": "8c0d1aa6-0b41-429c-a024-696f88f247d7",
      "FieldName": "sample string 2",
      "FieldValue": "sample string 3",
      "Order": 5,
      "RowNumber": 6
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A response model indicating success or failure and a list of errors as applicable.

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.