Webhook - Updating Consignment Price via Webhook

Summary

We have created API Endpoint within our QuoteProcess API  {POST} api/QuoteProcess/UpdateFreightCost.

This endpoint works in with the CreateConsignment webhook also added to printIQ.

Contact our support team for more information on this function or to create the CreateConsignment Webhook

This webhook will allow you to overwrite/update the freight price on the job details page.

How it works

You need to subscribe to our IQ Integrate module to use this function

1. When you generate consignment via the printIQ job details page, printIQ will trigger the CreateConsignment webhook.
   CreateConsignment Webhook will have the dispatch details (eg. Weight, quantity, etc) data and Quoted Value (Quoted value might be different with actual value)
2. Your 3rd party application that receives the CreateConsignment payload will then have the data to POST back to the QuoteProcess Endpoint UpdateFreightCost to printIQ application.
   
3. The consignment will be created in printIQ job details including the updated price from 3rd Party Application.
    

CreateConsigment Payload

2. {
3.     "ConsignmentNumber": "PIQCONSIGN000833",
4.     "FSKey": 7140,
5.     "DeliveryType": "Driver (Require SignOff)",
6.     "ConsignmentCreatedBy": "printiq.matthew.hausler",
7.     "SalesPrice": 20.0000,
8.     "SalesPricetax": 2.0000,
9.     "OriginAddressLine1": "6 Colebard Street West",
10.     "OriginAddressLine2": null,
11.     "OriginAddressLine3": null,
12.     "OriginAddressCity": "Acacia Ridge",
13.     "OriginAddressStateName": "Queensland",
14.     "OriginAddressPostCode": "4110",
15.     "OriginAddressCountry": "Australia",
16.     "ContactName": "Nevelle Brown",
17.     "DestAddressLine1": "South Main Street",
18.     "DestAddressLine2": null,
19.     "DestAddressLine3": null,
20.     "DestAddressCity": "Los Angeles",
21.     "DestAddressStateName": "California",
22.     "DestAddressCountry": "United States",
23.     "DestAddressPostCode": "50210",
24.     "ConsignmentFreightDeliveryLines": [
25.         {
26.             "JobNumber": "AZJ001980",
27.             "SONumber": null,
28.             "ItemFDKey": 9588,
29.             "LoKey": 464,
30.             "LOIdentifier": "AZJ001980_LFRY0WAPL",
31.             "LOTKey": 1,
32.             "LOText": "Standard Banners",
33.             "LOCreatedDate": "2021-09-08T14:58:01.173",
34.             "LOCreatedUser": "",
35.             "LOPrintedQuantity": 1,
36.             "LOWidthCM": 10.1000000000,
37.             "LOHeightCM": 5.4000000000,
38.             "LOActive": true,
39.             "LOLastPrintedDate": "2021-09-08T14:58:01.173",
40.             "LOLastPrintedUser": "",
41.             "LOPrefix": null,
42.             "LOSuffix": null,
43.             "LOMinimumDigits": null,
44.             "FPDKey": null
45.         }
46.     ]
47. }

Internal Notes

Misc charges: This setting is vital for this functionality to work.

The setting should be either "Misc Charges created after Invoiced" or "Misc charges always created".

If the setting is set to No Misc Charges created then the UI doesn't reflect any changes made through the API.

• Related Articles

• Option to correct addresses via a webhook

  v47 - webservice/webhook.svc/json/customers/addresses Short Summary: We have a JSON endpoint to create and update addresses. When creating and updating addresses this way you need to reference via the IntegrationID. You can get the Address by calling ...

• 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": ...

• Webhook - Create Consignment

  If CreateConsigment webhook is enabled in printIQ, the payload will be sent immediately after a consignment is created. You can download the sample payload via the attachments. Update history: v47.2 (4th quarter 2023): Add 3 fields to the ...

• printIQ Integration toolbox

  Integration Toolbox Getting started with integration and API overview Access printable attachment at the top or bottom of this article depending on your browser. Introduction  When it comes to workflow and integration, everyone’s requirements are ...

• v48 - Webhook - Versioning Quote Via Edit Job

  In v48/release/05.00, we have included EditingQQAdKey to the “QuoteCreated” payload. Prior to this release, IQ won't trigger QuoteCreated Webhook, when versioning quote via edit job This will allow systems to ignore the “QuoteCreated” if it’s for an ...