Add External Consignment

Add External Consignment

How to use this endpoint


You can add an Consignment in IQ via AddExternalConsignments Endpoint.
/api/QuoteProcess/AddExternalConsignment

Required payload to Postback to AddExternalConsignment Endpoint
{
  "ExternalConsignment": {
    "ConsignmentNo": "string",
    "ConsignmentPrice": 0,
    "ConsignmentTrackingCode": "string",
    "ConsignmentTrackingURL": "string",
    "ExternalConsignmentDeliveries": [
      {
        "DeliveryKey": 0,
        "DeliveryTrackingCode": "string",
        "DeliveryTrackingURL": "string"
      }
    ]
  }
}

However in order to do so, you will required to grab the Delivery Key from GetAcceptanceDetails Endpoint.
/api/QuoteProcess/GetAcceptanceDetails

To run above method, you will required to get either JobNo, AcceptanceKey or AcceptanceDetailKey

In this example, we will utilize JobNo and map the returned JSON value to AddExternalConsignment Endpoint.

I will post this payload below as an example.
{
  "ExternalConsignment": {
    "ConsignmentNo": "TBC",
    "ConsignmentPrice": 10,
    "ConsignmentTrackingCode": "ConsignmentTrackingCode",
    "ConsignmentTrackingURL": "ConsignmentTrackingURL",
    "ExternalConsignmentDeliveries": [
      {
        "DeliveryKey": 14477,
        "DeliveryTrackingCode": "DeliveryTrackingCode",
        "DeliveryTrackingURL": "DeliveryTrackingURL"
      }
    ]
  }
}

Where do I get DeliveryKey?

After you run GetAcceptanceDetailsEndPoint, IQ will return JSON object.

For Job

DeliveryKey is FDKey inside the AcceptanceProductDeliveryDetails Object.




For Sales order

You'll need to run this endpoint.
QuoteProcess/QuoteProcess_GetQQAKeyFromSONumber
by passing Login Token and SO Number

After that use the AcceptanceKey of the Sales Order, and run this GetAcceptanceDetailsEndPoint.
DeliveryKey is FDKey inside the AcceptanceItemDeliveryDetails Object.

After passing the Consignment Number to the correct FD Key,
this is how it will look like on the screen


If I click the "TBC" Button, we can pass on the Consignment Price.




and if you click the Magnifying Glass, the Tracking code and Tracking URL will be listed as per below.