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.
DeliveryKey is FDKey inside the AcceptanceProductDeliveryDetails Object.

and 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.

    • Related Articles

    • Save Quote Question endpoint

      Where to get the Value of SaveQuoteQuestion Endpoint? If you are experimenting on how to run POST Method to SaveQuoteQuestion Endpoint. You can use this method to check the Payload required. Console --> Network Tab --> Check Arrow Using this example, ...

    • User Positions

      User Positions, Roles and Details Setup & Admin This article describes the tools available for managing user accesses. It covers User Positions, User Details and User Roles. There are three user types – Staff, Customer and Supplier: Customer users ...

    • IQlink - Configure Connection

      IQ Link – Configure Connection Outline: Creating a new ‘Supplier’ in your IQ site Creating a new ‘Customer’ and ‘User’ in supplier's IQ site Add ‘Remote Instance Mapping’ and ‘Mapping to user account’ to appropriate supplier account Create a product ...

    • Delete External Consignment

      How to use this Endpoint Endpoint to Post to run this endpoint /api/QuoteProcess/DeleteExternalConsignment Consignment generated by IQ and Courier company are unique. Hence posting the Consignment via this payload, will remove the Consignment in ...

    • Restricted Sales User - Seeing Their Clients Only

      Many companies want to isolate a specific sales person to see only their own customers for multiple reasons. IQ allows you to do this within the User Settings. Restricting the Sales Users's Position First, you might want to consider restricting the ...