POST api/Submission/AddPurchase?submissionID={submissionID}

Add a purchase record to an in-progress submission. This information will not get processed until CompleteSubmission is called.

Request Information

URI Parameters

Name	Description	Type	Additional information
submissionID	The submissionID of the existing consumer record to which the invoice will be attached.	globally unique identifier	Required

Body Parameters

The purchase object to add to the consumer record.

Purchase

Name	Description	Type	Additional information
Purchase Date	The date the item was purchased	date	None.
Retailer	The retailer from whom the product was purchased	string	None.
Quantity	The quantity of this item that was purchased	decimal number	None.
Item Description	The description of the item purchased	string	None.
UPC Code	The UPC of the item purchased	string	Required
Purchase Price	The amount paid for the item	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Purchase Date": "2025-01-08T23:31:45.8060903-06:00",
  "Retailer": "sample string 2",
  "Quantity": 3.1,
  "Item Description": "sample string 4",
  "UPC Code": "sample string 5",
  "Purchase Price": 6.0
}

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.