POST api/Offer/CheckUPCForOffer
Validate a UPC against an offer ID to ensure the consumer made a valid purchase for the offer
Request Information
URI Parameters
None.
Body Parameters
The offer ID and UPCs to validate
ValidateUPCRequestName | Description | Type | Additional information |
---|---|---|---|
OfferId | globally unique identifier |
None. |
|
UPCCodes | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "OfferId": "5d199cd7-3653-480e-9afb-9e38ed3f245a", "UPCCodes": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<ValidateUPCRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models"> <OfferId>5d199cd7-3653-480e-9afb-9e38ed3f245a</OfferId> <UPCCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </UPCCodes> </ValidateUPCRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A boolean reflecting whether or not all UPCs in the list are valid for the offer
HttpResponseMessageName | Description | 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. |