POST api/customdata/oliverslabels/LogPurchase

Provides an endpoint for Oliver's Labels to report back which orders resulted in purchases

Request Information

URI Parameters

None.

Body Parameters

A wrapper object that contains the necessary parameters needed to specify the information for which the new information should be associated

LogPurchaseRequest

Name	Description	Type	Additional information
ClientID	ClientID of the participant	integer	None.
OID	The OID of the request to be logged to	string	None.
PurchaseInfo	Information regarding the purchase made	PurchaseInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "OID": "sample string 2",
  "PurchaseInfo": {
    "EmailOL": "sample string 1",
    "ReferenceID": "sample string 2",
    "PurchaseAmount": "sample string 3",
    "CurrencyType": "sample string 4"
  }
}

application/javascript

Sample:

{"ClientID":1,"OID":"sample string 2","PurchaseInfo":{"EmailOL":"sample string 1","ReferenceID":"sample string 2","PurchaseAmount":"sample string 3","CurrencyType":"sample string 4"}}

application/xml, text/xml

Sample:

<LogPurchaseRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>1</ClientID>
  <OID>sample string 2</OID>
  <PurchaseInfo>
    <EmailOL>sample string 1</EmailOL>
    <ReferenceID>sample string 2</ReferenceID>
    <PurchaseAmount>sample string 3</PurchaseAmount>
    <CurrencyType>sample string 4</CurrencyType>
  </PurchaseInfo>
</LogPurchaseRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LogPurchaseRequest'.

Response Information

Resource Description

WebMethodResult

Name	Description	Type	Additional information
Success		boolean	None.
ErrorText		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
</WebMethodResult>