POST api/Retailer/QuotationSearch

Create quotation search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FinanceDetails	ProductRequestModel	None.
CustomerDetails	CustomerDetailsModel	None.
EmploymentDetails	EmploymentRequestModel	None.
BankDetails	NotRequiredBankDetailsModel	None.

Request Formats

application/json, text/json

Sample:

{
  "FinanceDetails": {
    "RateCardProductId": "c95cf66c-3529-4b01-b5b3-2ab552d96296",
    "DescriptionOfGoods": "sample string 1",
    "RetailersReference": "sample string 2",
    "Price": 1.0,
    "Deposit": 1.0
  },
  "CustomerDetails": {
    "IPAddress": "sample string 1",
    "Gender": "sample string 2",
    "Title": "sample string 3",
    "ResidentialStatus": "sample string 4",
    "MaritalStatus": "sample string 5",
    "NumberOfDependants": 1,
    "CurrentAddress": {
      "YearsAtAddress": 1,
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "PreviousAddress1": {
      "YearsAtAddress": 1,
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "PreviousAddress2": {
      "YearsAtAddress": 1,
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "GoodsDeliveryAddress": {
      "YearsAtAddress": 1,
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "CustomerEmail": "sample string 6",
    "FirstName": "sample string 7",
    "LastName": "sample string 8",
    "Telephone": "sample string 9",
    "MobileNumber": "sample string 10",
    "DateOfBirth": "2025-11-05T17:11:12.2171043+00:00",
    "MonthlyRentAmount": 1.0,
    "GoodsDeliveryAddressIsTheSameAsCurrentAddress": true
  },
  "EmploymentDetails": {
    "SourceOfIncome": "sample string 1",
    "EmploymentStatus": "sample string 2",
    "YearsSelfEmployed": 1,
    "YearsWithEmployer": 1,
    "TypeOfBusiness": "sample string 3",
    "BusinessName": "sample string 4",
    "MainOccupation": "sample string 5",
    "EmployerName": "sample string 6",
    "GrossAnnualIncome": 1.0,
    "HouseholdAnnualIncome": 1
  },
  "BankDetails": {
    "BankAccountNumber": "sample string 1",
    "BankSortCode": "sample string 2"
  }
}

text/html

Sample:

{"FinanceDetails":{"RateCardProductId":"c95cf66c-3529-4b01-b5b3-2ab552d96296","DescriptionOfGoods":"sample string 1","RetailersReference":"sample string 2","Price":1.0,"Deposit":1.0},"CustomerDetails":{"IPAddress":"sample string 1","Gender":"sample string 2","Title":"sample string 3","ResidentialStatus":"sample string 4","MaritalStatus":"sample string 5","NumberOfDependants":1,"CurrentAddress":{"YearsAtAddress":1,"PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"PreviousAddress1":{"YearsAtAddress":1,"PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"PreviousAddress2":{"YearsAtAddress":1,"PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"GoodsDeliveryAddress":{"YearsAtAddress":1,"PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"CustomerEmail":"sample string 6","FirstName":"sample string 7","LastName":"sample string 8","Telephone":"sample string 9","MobileNumber":"sample string 10","DateOfBirth":"2025-11-05T17:11:12.2171043+00:00","MonthlyRentAmount":1.0,"GoodsDeliveryAddressIsTheSameAsCurrentAddress":true},"EmploymentDetails":{"SourceOfIncome":"sample string 1","EmploymentStatus":"sample string 2","YearsSelfEmployed":1,"YearsWithEmployer":1,"TypeOfBusiness":"sample string 3","BusinessName":"sample string 4","MainOccupation":"sample string 5","EmployerName":"sample string 6","GrossAnnualIncome":1.0,"HouseholdAnnualIncome":1},"BankDetails":{"BankAccountNumber":"sample string 1","BankSortCode":"sample string 2"}}

application/xml, text/xml

Sample:

<QuotationSearchRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.QuotationSearchRequestModels">
  <BankDetails>
    <BankAccountNumber>sample string 1</BankAccountNumber>
    <BankSortCode>sample string 2</BankSortCode>
  </BankDetails>
  <CustomerDetails>
    <CustomerEmail xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</CustomerEmail>
    <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">2025-11-05T17:11:12.2171043+00:00</DateOfBirth>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 7</FirstName>
    <GoodsDeliveryAddressIsTheSameAsCurrentAddress xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">true</GoodsDeliveryAddressIsTheSameAsCurrentAddress>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 8</LastName>
    <MobileNumber xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 10</MobileNumber>
    <MonthlyRentAmount xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">1</MonthlyRentAmount>
    <Telephone xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 9</Telephone>
    <CurrentAddress>
      <City xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 2</City>
      <Flat xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 3</Flat>
      <HouseName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 5</HouseName>
      <HouseNumber xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</HouseNumber>
      <PostCode xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 1</PostCode>
      <Street xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</Street>
      <YearsAtAddress>1</YearsAtAddress>
    </CurrentAddress>
    <Gender>sample string 2</Gender>
    <GoodsDeliveryAddress>
      <City xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 2</City>
      <Flat xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 3</Flat>
      <HouseName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 5</HouseName>
      <HouseNumber xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</HouseNumber>
      <PostCode xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 1</PostCode>
      <Street xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</Street>
      <YearsAtAddress>1</YearsAtAddress>
    </GoodsDeliveryAddress>
    <IPAddress>sample string 1</IPAddress>
    <MaritalStatus>sample string 5</MaritalStatus>
    <NumberOfDependants>1</NumberOfDependants>
    <PreviousAddress1>
      <City xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 2</City>
      <Flat xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 3</Flat>
      <HouseName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 5</HouseName>
      <HouseNumber xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</HouseNumber>
      <PostCode xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 1</PostCode>
      <Street xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</Street>
      <YearsAtAddress>1</YearsAtAddress>
    </PreviousAddress1>
    <PreviousAddress2>
      <City xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 2</City>
      <Flat xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 3</Flat>
      <HouseName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 5</HouseName>
      <HouseNumber xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</HouseNumber>
      <PostCode xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 1</PostCode>
      <Street xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</Street>
      <YearsAtAddress>1</YearsAtAddress>
    </PreviousAddress2>
    <ResidentialStatus>sample string 4</ResidentialStatus>
    <Title>sample string 3</Title>
  </CustomerDetails>
  <EmploymentDetails>
    <BusinessName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</BusinessName>
    <EmployerName xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 6</EmployerName>
    <GrossAnnualIncome xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">1</GrossAnnualIncome>
    <HouseholdAnnualIncome xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">1</HouseholdAnnualIncome>
    <MainOccupation xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 5</MainOccupation>
    <TypeOfBusiness xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 3</TypeOfBusiness>
    <EmploymentStatus>sample string 2</EmploymentStatus>
    <SourceOfIncome>sample string 1</SourceOfIncome>
    <YearsSelfEmployed>1</YearsSelfEmployed>
    <YearsWithEmployer>1</YearsWithEmployer>
  </EmploymentDetails>
  <FinanceDetails>
    <Deposit xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">1</Deposit>
    <DescriptionOfGoods xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 1</DescriptionOfGoods>
    <Price xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">1</Price>
    <RetailersReference xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 2</RetailersReference>
    <RateCardProductId>c95cf66c-3529-4b01-b5b3-2ab552d96296</RateCardProductId>
  </FinanceDetails>
</QuotationSearchRequestModel>

Response Information

Resource Description

If the credit check is with status declined there will be no offer details.

QuotationSearchResponse

Name	Description	Type	Additional information
QuotationSearchId		globally unique identifier	None.
Status		string	None.

Response Formats

application/json, text/json

Sample:

{
  "QuotationSearchId": "c6b97b04-e2ef-4bed-9321-2fbec5103e9b",
  "Status": "sample string 2"
}

text/html

Sample:

{"QuotationSearchId":"c6b97b04-e2ef-4bed-9321-2fbec5103e9b","Status":"sample string 2"}

application/xml, text/xml

Sample:

<QuotationSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.QuotationSearchResponses">
  <QuotationSearchId>c6b97b04-e2ef-4bed-9321-2fbec5103e9b</QuotationSearchId>
  <Status>sample string 2</Status>
</QuotationSearchResponse>