GET api/{siteCode}/Quote/GetQuoteByQuoteReference?quoteRef={quoteRef}

Gets the quote by quote reference.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required
quoteRef	The quote reference.	string	Required

Body Parameters

None.

Response Information

Resource Description

ApiModels.QuoteRequest.

QuoteResponseInclCharges

Name	Type	Additional information
QuoteResponseCharges	Collection of QuoteResponseCharge	None.
QuoteReference	string	None.
QuoteDate	date	None.
QuoteType	string	None.
CustomerAccountNumber	string	None.
CompanyName	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
PostCode	string	None.
County	string	None.
Country	string	None.
Contact	string	None.
Title	string	None.
FirstName	string	None.
Surname	string	None.
Phone	string	None.
Email	string	None.
CustomerReference	string	None.
TransportMode	string	None.
PlaceOfReceipt	string	None.
OriginPort	string	None.
FinalDestination	string	None.
DestinationPort	string	None.
ShipDate	date	None.
DeliveryDate	date	None.
GoodsDescription	string	None.
Hazardous	boolean	None.
HazardousClass	string	None.
NOP	integer	None.
GrossWeight	decimal number	None.
VolumetricWeight	decimal number	None.
CBM	decimal number	None.
ChargeableWeight	decimal number	None.
Value	decimal number	None.
ValueCurrency	string	None.
Insurance	boolean	None.
IncoTerms	string	None.
AdditionalInformation	string	None.
EquipmentType	string	None.

Response Formats

application/json, text/json

Sample:

{
  "QuoteResponseCharges": [
    {
      "Description": "sample string 1",
      "Charge": 1.0,
      "ChargeCurrency": "sample string 2",
      "TaxCode": "sample string 3",
      "Taxable": 1,
      "Tax": 1.0,
      "Chapter": "sample string 4",
      "SecondDescription": "sample string 5"
    },
    {
      "Description": "sample string 1",
      "Charge": 1.0,
      "ChargeCurrency": "sample string 2",
      "TaxCode": "sample string 3",
      "Taxable": 1,
      "Tax": 1.0,
      "Chapter": "sample string 4",
      "SecondDescription": "sample string 5"
    }
  ],
  "QuoteReference": "sample string 1",
  "QuoteDate": "2025-02-05T07:01:55.4159258+00:00",
  "QuoteType": "sample string 2",
  "CustomerAccountNumber": "sample string 3",
  "CompanyName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "PostCode": "sample string 8",
  "County": "sample string 9",
  "Country": "sample string 10",
  "Contact": "sample string 11",
  "Title": "sample string 12",
  "FirstName": "sample string 13",
  "Surname": "sample string 14",
  "Phone": "sample string 15",
  "Email": "sample string 16",
  "CustomerReference": "sample string 17",
  "TransportMode": "sample string 18",
  "PlaceOfReceipt": "sample string 19",
  "OriginPort": "sample string 20",
  "FinalDestination": "sample string 21",
  "DestinationPort": "sample string 22",
  "ShipDate": "2025-02-05T07:01:55.4159258+00:00",
  "DeliveryDate": "2025-02-05T07:01:55.4159258+00:00",
  "GoodsDescription": "sample string 23",
  "Hazardous": true,
  "HazardousClass": "sample string 25",
  "NOP": 26,
  "GrossWeight": 1.1,
  "VolumetricWeight": 1.1,
  "CBM": 1.1,
  "ChargeableWeight": 1.1,
  "Value": 1.0,
  "ValueCurrency": "sample string 27",
  "Insurance": true,
  "IncoTerms": "sample string 29",
  "AdditionalInformation": "sample string 30",
  "EquipmentType": "sample string 31"
}

application/xml, text/xml

Sample:

<QuoteResponseInclCharges xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerAccountNumber>sample string 3</CustomerAccountNumber>
  <CompanyName>sample string 4</CompanyName>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <City>sample string 7</City>
  <PostCode>sample string 8</PostCode>
  <County>sample string 9</County>
  <Country>sample string 10</Country>
  <Contact>sample string 11</Contact>
  <Title>sample string 12</Title>
  <FirstName>sample string 13</FirstName>
  <Surname>sample string 14</Surname>
  <Phone>sample string 15</Phone>
  <Email>sample string 16</Email>
  <CustomerReference>sample string 17</CustomerReference>
  <TransportMode>sample string 18</TransportMode>
  <PlaceOfReceipt>sample string 19</PlaceOfReceipt>
  <OriginPort>sample string 20</OriginPort>
  <FinalDestination>sample string 21</FinalDestination>
  <DestinationPort>sample string 22</DestinationPort>
  <ShipDate>2025-02-05T07:01:55.4159258+00:00</ShipDate>
  <DeliveryDate>2025-02-05T07:01:55.4159258+00:00</DeliveryDate>
  <GoodsDescription>sample string 23</GoodsDescription>
  <Hazardous>true</Hazardous>
  <HazardousClass>sample string 25</HazardousClass>
  <NOP>26</NOP>
  <GrossWeight>1.1</GrossWeight>
  <VolumetricWeight>1.1</VolumetricWeight>
  <CBM>1.1</CBM>
  <ChargeableWeight>1.1</ChargeableWeight>
  <Value>1</Value>
  <ValueCurrency>sample string 27</ValueCurrency>
  <Insurance>true</Insurance>
  <IncoTerms>sample string 29</IncoTerms>
  <AdditionalInformation>sample string 30</AdditionalInformation>
  <EquipmentType>sample string 31</EquipmentType>
  <QuoteReference>sample string 1</QuoteReference>
  <QuoteDate>2025-02-05T07:01:55.4159258+00:00</QuoteDate>
  <QuoteType>sample string 2</QuoteType>
  <QuoteResponseCharges>
    <QuoteResponseCharge>
      <Description>sample string 1</Description>
      <Charge>1</Charge>
      <ChargeCurrency>sample string 2</ChargeCurrency>
      <TaxCode>sample string 3</TaxCode>
      <Taxable>1</Taxable>
      <Tax>1</Tax>
      <Chapter>sample string 4</Chapter>
      <SecondDescription>sample string 5</SecondDescription>
    </QuoteResponseCharge>
    <QuoteResponseCharge>
      <Description>sample string 1</Description>
      <Charge>1</Charge>
      <ChargeCurrency>sample string 2</ChargeCurrency>
      <TaxCode>sample string 3</TaxCode>
      <Taxable>1</Taxable>
      <Tax>1</Tax>
      <Chapter>sample string 4</Chapter>
      <SecondDescription>sample string 5</SecondDescription>
    </QuoteResponseCharge>
  </QuoteResponseCharges>
</QuoteResponseInclCharges>