POST api/v7/TransactionLookups/TrustedCustomerCheck

This method will check if the specified customer has exceeded the specified number of non-receipted returns in the specified period. The customer will be added if it does not exist.

Request Information

URI Parameters

None.

Body Parameters

The lookup request data containing the customer ID, maximum number of non-receipted returns and the time period.

TrustedCustomerRequest
NameDescriptionTypeRequired?Additional information
MessageContent

string

No

None.
MessageType

string

No

None.
Request

TrustedCustomerRequestData

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "MessageContent": "sample string 1",
  "MessageType": "sample string 2",
  "Request": {
    "Customer": {
      "CustomerID": "sample string 1",
      "CustomerIDType": "sample string 2"
    },
    "ReturnsThreshold": "sample string 1",
    "ReceiptRetentionDays": "sample string 2",
    "ReceiptRetentionTime": "sample string 3",
    "ReceiptDateTime": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<Lookup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" content="sample string 1" type="sample string 2">
  <RequestData>
    <Customer>
      <CustomerID>sample string 1</CustomerID>
      <CustomerIDType>sample string 2</CustomerIDType>
    </Customer>
    <ReturnsThreshold>sample string 1</ReturnsThreshold>
    <ReceiptRetentionDays>sample string 2</ReceiptRetentionDays>
    <ReceiptRetentionTime>sample string 3</ReceiptRetentionTime>
    <ReceiptDateTime>sample string 4</ReceiptDateTime>
  </RequestData>
</Lookup>

Response Information

Resource Description

A lookup response data including an Allowed element indicating if the customer is allowed to perform a non-receipted return.

TrustedCustomerResponse
NameDescriptionType
Trusted

string
Success

string
Error

ErrorData
MessageContent

string
MessageType

string
Request

TrustedCustomerRequestData

Response Formats

application/json, text/json

Sample: 
{
  "Trusted": "sample string 1",
  "Success": "sample string 2",
  "Error": {
    "errorCode": "sample string 1",
    "ErrorMessage": "sample string 2"
  },
  "MessageContent": "sample string 3",
  "MessageType": "sample string 4",
  "Request": {
    "Customer": {
      "CustomerID": "sample string 1",
      "CustomerIDType": "sample string 2"
    },
    "ReturnsThreshold": "sample string 1",
    "ReceiptRetentionDays": "sample string 2",
    "ReceiptRetentionTime": "sample string 3",
    "ReceiptDateTime": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<Lookup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" content="sample string 3" type="sample string 4">
  <RequestData>
    <Customer>
      <CustomerID>sample string 1</CustomerID>
      <CustomerIDType>sample string 2</CustomerIDType>
    </Customer>
    <ReturnsThreshold>sample string 1</ReturnsThreshold>
    <ReceiptRetentionDays>sample string 2</ReceiptRetentionDays>
    <ReceiptRetentionTime>sample string 3</ReceiptRetentionTime>
    <ReceiptDateTime>sample string 4</ReceiptDateTime>
  </RequestData>
  <Trusted>sample string 1</Trusted>
  <Success>sample string 2</Success>
  <Error errorCode="sample string 1">sample string 2</Error>
</Lookup>