Retrieve RFQ Details

This API endpoint allows you to retrieve details of an RFQ (Request for Quotation) submitted by the customer.

Endpoint Details

• Method: GET
• URL: /api/v2/customer/{CUSTOMER_ID}/rfq/{RFQ_ID}
• Authentication: Requires an API Key in the request header.

Headers

Header	Type	Required	Description
X-Api-Key	String	✅	Your API key for authentication

---

Response Parameters

Top-Level Fields

Field	Type	Description
id	String	Unique identifier for the RFQ
status	Enum (RFQStatus)	Current status of the RFQ
request	Object	RFQ request details (what the customer originally submitted)
requester	Object	Contact details of the RFQ requester
teamMembers	Array of Strings	List of emails of additional team members
referral	String	Referral link related to the RFQ
createDate	String (ISO 8601)	Date when the RFQ was created
clientData	Object (Optional)	Additional client information
attachments	Array (Optional)	List of attached documents
paid	Boolean	Indicates if the RFQ invoice has been paid
paidAt	String (ISO 8601)	Timestamp of the payment
sales	Object (Optional)	Sales representative details

Sales Representative Object Fields

Field	Type	Description
firstName	String	Salesperson's first name
lastName	String	Salesperson's last name
email	String	Salesperson's email
phone	String	Salesperson's phone number

RFQ Request Object Fields

Field	Type	Description
servicesNeeded	Array of Strings	List of required services
freightEnvironment	String	Freight environment type
certifications	Array of Strings (Optional)	Certifications required
hazmatClasses	Array of Strings (Optional)	Hazmat classes (if applicable)
serviceLocation	Object	Location details
startDate	String (ISO 8601)	Start date of service
endDate	String (ISO 8601)	End date of service
commodity	String (Optional)	Type of commodity
loadNumber	String (Optional)	Load or container number
unitType	String	Type of unit
numberOfUnits	Integer	Number of units
notes	String (Optional)	Additional notes
lowTempControlled	Number (Optional)	Low temperature control
highTempControlled	Number (Optional)	High temperature control
spaceNeeded	Number (Optional)	Space required
targetRate	Number (Optional)	Target rate
metadata	Object (Optional)	Additional metadata

Requester Object Fields

Field	Type	Description
firstName	String	Requester's first name
lastName	String	Requester's last name
title	String (Optional)	Requester's title
location	Object	Requester's location details
email	String	Requester's email address
phone	String	Requester's phone number

Location Object Fields

Field	Type	Description
streetAddress	String	Street address
city	String	City name
state	String	State name
country	String	Country name
postalCode	String	Postal code
lat	Number (Optional)	Latitude
lng	Number (Optional)	Longitude

---

Example Response

{
  "id": "RFQ123456",
  "status": "Pending",
  "request": {
    "servicesNeeded": ["Cross-Docking", "Storage"],
    "freightEnvironment": "Dry",
    "certifications": ["Bonded", "Hazmat"],
    "serviceLocation": {
      "streetAddress": "1234 Warehouse Drive",
      "city": "Logistics City",
      "state": "Transport",
      "country": "SupplyLand",
      "postalCode": "123456",
      "lat": 40.7128,
      "lng": -74.0060
    },
    "startDate": "2024-04-01",
    "endDate": "2024-04-10",
    "commodity": "Electronics",
    "loadNumber": "LC123456789",
    "unitType": "Pallet - Standard",
    "numberOfUnits": 50,
    "notes": "Please handle with care, fragile items."
  },
  "requester": {
    "firstName": "John",
    "lastName": "Doe",
    "title": "Procurement Manager",
    "location": {
      "streetAddress": "1234 Warehouse Drive",
      "city": "Logistics City",
      "state": "Transport",
      "country": "SupplyLand",
      "postalCode": "123456"
    },
    "email": "johndoe@techgadgetsinc.com",
    "phone": "+12034567890"
  },
  "teamMembers": ["teammember@example.com"],
  "referral": "https://api.olimpwarehousing.com/api/v2/customer/RFQ123456",
  "type": "DEMAND",
  "createDate": "2024-04-01T12:00:00Z",
  "clientData": {
    "account": "Account123",
    "company": "Tech Gadgets Inc."
  },
  "attachments": ["file1.pdf", "file2.png"],
  "paid": false,
  "paidAt": null,
  "sales": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane.smith@example.com",
    "phone": "+12035551234"
  }
}

Error Handling

Status Code	Description
401 Unauthorized	Missing or invalid API Key
404 Not Found	RFQ not found
400 Bad Request	Invalid request format