|
Important note: The Portal Data WS is going to be replaced by the new Shipment Data API. The new API is using a newer, faster and more secure technology and we recommend that you use this API going forward. Read more: Using the Shipment Data API |
In order to use the Portal Data web service, you need an account for Portal. If you do not have an account yet, please contact nshift Customer Service to get one. The user name and password for Consignor Portal is used as credentials in the Portal Data web service.
Some of the methods in Portal Data uses additional filters for the data. Some methods require your installation ID (11 digits) to filter the data set. You can find your installation ID in Consignor by clicking on Help > About nShift On-premises in the top menu.
In addition some methods also allow for further filtering using the actor ID. The actor ID is useful when you have more than one actor on your installation and want to limit your search to only one actor (or a list of actors) instead of all actors at once. If you only have one actor, you can use an empty value in the input array. Actor ID can be found in the Consignor database in the table Actor and the field Actor ID.
URL to Portal Data web service:
https://customer-api.consignorportal.com/PortalData/PortalData.svc
Overview of the methods for the Portal Data WS:
https://nshift.zendesk.com/hc/en-us/articles/360006024874