GET api/v1/Shipments/{shipmentid}/RFQs/{id}

Retrieves the RFQ identified by id.

Request Information

Parameters

NameDescriptionAdditional information
shipmentid

Define this parameter in the request URI.

id

Define this parameter in the request URI.

Response Information

RFQDTO

Response body formats

application/json, text/json

Sample:
{
  "RFQID": 1,
  "ShipmentID": 2,
  "Status": "sample string 3",
  "RequiredDate": "2025-04-24T13:08:42.379476Z",
  "Comments": "sample string 5",
  "Sender": {
    "AgentID": 1,
    "AgentName": "sample string 2",
    "EYProgram": true,
    "Limits": {
      "UCTSearchesRemaining": 1,
      "UATSearchesRemaining": 1,
      "Addressbook": {
        "CurrentCount": 1,
        "MaxLimit": 1,
        "ValidTill": "2025-04-24T13:08:42.379476Z"
      }
    },
    "City": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Country": {
      "Code": "sample string 1",
      "Name": "sample string 1 - sample string 2"
    },
    "Networks": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Services": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      }
    ]
  },
  "Recipient": {
    "AgentID": 1,
    "AgentName": "sample string 2",
    "EYProgram": true,
    "Limits": {
      "UCTSearchesRemaining": 1,
      "UATSearchesRemaining": 1,
      "Addressbook": {
        "CurrentCount": 1,
        "MaxLimit": 1,
        "ValidTill": "2025-04-24T13:08:42.379476Z"
      }
    },
    "City": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Country": {
      "Code": "sample string 1",
      "Name": "sample string 1 - sample string 2"
    },
    "Networks": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Services": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2"
      }
    ]
  },
  "RecipientCount": 6,
  "IsRead": true,
  "CreatedBy": 8,
  "CreatedOn": "2025-04-24T13:08:42.379476Z",
  "UpdatedBy": 10,
  "UpdatedOn": "2025-04-24T13:08:42.379476Z",
  "Discussions": [
    {
      "DiscussionID": 1,
      "RFQID": 2,
      "Status": "sample string 3",
      "RecipientID": 4,
      "Comments": "sample string 5",
      "IsRead": true,
      "CreatedBy": 7,
      "CreatedOn": "2025-04-24T13:08:42.379476Z"
    },
    {
      "DiscussionID": 1,
      "RFQID": 2,
      "Status": "sample string 3",
      "RecipientID": 4,
      "Comments": "sample string 5",
      "IsRead": true,
      "CreatedBy": 7,
      "CreatedOn": "2025-04-24T13:08:42.379476Z"
    },
    {
      "DiscussionID": 1,
      "RFQID": 2,
      "Status": "sample string 3",
      "RecipientID": 4,
      "Comments": "sample string 5",
      "IsRead": true,
      "CreatedBy": 7,
      "CreatedOn": "2025-04-24T13:08:42.379476Z"
    }
  ],
  "Feedback": {
    "FeedbackID": 1,
    "RFQID": 2,
    "Status": "sample string 3",
    "RecipientID": 4,
    "Comments": "sample string 5",
    "IsRead": true,
    "CreatedBy": 7,
    "CreatedOn": "2025-04-24T13:08:42.379476Z"
  },
  "Quotes": [
    {
      "QuotesID": 1,
      "Status": "sample string 2"
    },
    {
      "QuotesID": 1,
      "Status": "sample string 2"
    },
    {
      "QuotesID": 1,
      "Status": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<RFQDTO>
  <RFQID>1</RFQID>
  <ShipmentID>2</ShipmentID>
  <Status>sample string 3</Status>
  <RequiredDate>2025-04-24T13:08:42.379476+00:00</RequiredDate>
  <Comments>sample string 5</Comments>
  <Sender>
    <AgentID>1</AgentID>
    <AgentName>sample string 2</AgentName>
    <EYProgram>true</EYProgram>
    <Limits>
      <UCTSearchesRemaining>1</UCTSearchesRemaining>
      <UATSearchesRemaining>1</UATSearchesRemaining>
      <Addressbook>
        <CurrentCount>1</CurrentCount>
        <MaxLimit>1</MaxLimit>
        <ValidTill>2025-04-24T13:08:42.379476+00:00</ValidTill>
      </Addressbook>
    </Limits>
    <City>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </City>
    <Country>
      <Code>sample string 1</Code>
      <Name>sample string 1 - sample string 2</Name>
    </Country>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
  </Sender>
  <Recipient>
    <AgentID>1</AgentID>
    <AgentName>sample string 2</AgentName>
    <EYProgram>true</EYProgram>
    <Limits>
      <UCTSearchesRemaining>1</UCTSearchesRemaining>
      <UATSearchesRemaining>1</UATSearchesRemaining>
      <Addressbook>
        <CurrentCount>1</CurrentCount>
        <MaxLimit>1</MaxLimit>
        <ValidTill>2025-04-24T13:08:42.379476+00:00</ValidTill>
      </Addressbook>
    </Limits>
    <City>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </City>
    <Country>
      <Code>sample string 1</Code>
      <Name>sample string 1 - sample string 2</Name>
    </Country>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Networks>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Networks>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
    <Services>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Services>
  </Recipient>
  <RecipientCount>6</RecipientCount>
  <IsRead>true</IsRead>
  <CreatedBy>8</CreatedBy>
  <CreatedOn>2025-04-24T13:08:42.379476+00:00</CreatedOn>
  <UpdatedBy>10</UpdatedBy>
  <UpdatedOn>2025-04-24T13:08:42.379476+00:00</UpdatedOn>
  <Discussions>
    <DiscussionID>1</DiscussionID>
    <RFQID>2</RFQID>
    <Status>sample string 3</Status>
    <RecipientID>4</RecipientID>
    <Comments>sample string 5</Comments>
    <IsRead>true</IsRead>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2025-04-24T13:08:42.379476+00:00</CreatedOn>
  </Discussions>
  <Discussions>
    <DiscussionID>1</DiscussionID>
    <RFQID>2</RFQID>
    <Status>sample string 3</Status>
    <RecipientID>4</RecipientID>
    <Comments>sample string 5</Comments>
    <IsRead>true</IsRead>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2025-04-24T13:08:42.379476+00:00</CreatedOn>
  </Discussions>
  <Discussions>
    <DiscussionID>1</DiscussionID>
    <RFQID>2</RFQID>
    <Status>sample string 3</Status>
    <RecipientID>4</RecipientID>
    <Comments>sample string 5</Comments>
    <IsRead>true</IsRead>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2025-04-24T13:08:42.379476+00:00</CreatedOn>
  </Discussions>
  <Feedback>
    <FeedbackID>1</FeedbackID>
    <RFQID>2</RFQID>
    <Status>sample string 3</Status>
    <RecipientID>4</RecipientID>
    <Comments>sample string 5</Comments>
    <IsRead>true</IsRead>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2025-04-24T13:08:42.379476+00:00</CreatedOn>
  </Feedback>
  <Quotes>
    <QuotesID>1</QuotesID>
    <Status>sample string 2</Status>
  </Quotes>
  <Quotes>
    <QuotesID>1</QuotesID>
    <Status>sample string 2</Status>
  </Quotes>
  <Quotes>
    <QuotesID>1</QuotesID>
    <Status>sample string 2</Status>
  </Quotes>
</RFQDTO>