In order to access the "Shipping Agent Card" you will need to select the Shipping Agent Card option from the menu ribbon on the "Shipping Agents" screen, as shown below.
If you are setting up the Integration for the first time the "Shipping Agent Card" will have a set of blank attribute values (like the below example) and therefore you will need to click on the New (+) Button in order to create a new card before populating any information.
With the new record created you can then update the attributes on the "Shipping Agent Card" as detailed below.
General FastTab
Shipping Agent Code |
This should have been automatically completed as the shipping agent you had selected from the "Shipping Agents" screen |
Shipping Agent Name |
This field is un-editable and will be automatically populated with the name linked to the Shipping Agent Code |
Account No. |
In this field, enter in your account number, as provided by the Shipping Agent |
Integration Interface |
In this field, you will need to select the Interfaces list that you will have previously setup (if following this guide) for the Shipping Agent |
Check Items on Document Release |
If this field is enabled, when releasing a document in Business Central, a number of checks will be implemented against the Items to ensure that all the required fields have been populated. If they haven’t, then an error will appear advising you on what detail is missing |
Submit Consignment on Warehouse Posting |
You should enable this Field if you want Consignments to be automatically submitted when a Warehouse Shipment is posted for the Shipping Agent |
Open Consignment After Posting |
With this option enabled, the "Consignment" screen will be created and opened after the Warehouse Shipment is posted. You can then review and submit the Consignment independently |
Document Upload Process Type |
This field relates to the uploading of documents against a Consignment |
Shipping FastTab
Shipping Agent Integration Code |
Select the Shipping Agent you are Integrating with from the list of available options. After setting the Shipping Agent Integration Code you the Packaging and Labels FastTabs will be populated with the options for the selected Shipping Agent automatically. These can be changed if required |
Label Code |
Select the format of the shipping label you want to use for this Shipping Agent from the list of possible options. This will depend on the printer that you are planning to use to print the shipping labels. Which label code you require depends on the printer you are going to use to print your shipping labels. While PDF will work for standard ‘laser printer’ type printers, Zebra’s ZPL or EPL is better for use with their specialist label printers. Eltron v2 is used on older label printers from companies now also owned by Zebra. To be sure you select the right option please consult your printer documentation or your Shipping Agent. |
Packaging Code |
This attribute defines the default packaging you intend to use with this Shipping Agent. While there is a long list of Shipping Agent specified options for many of the supported Shipping Agents, if you consign the packages in your own packaging you should select the Your Packaging option |
Weight Unit of Measure |
Select the unit of measure that will be used to submit Consignments to the Shipping Agent. Usually this will be KG |
Max. Expected Packages |
Enter the maximum number of expected packages you will be submitting via the API. This is to prevent typing errors resulting in excessive Consignments where for instance mistyping 2 could create 22 packages |
Default Export Reason Code |
Enter in a default value for Exports, if required. Please refer to the Export Reason Codes help guide for more information |
Packaging FastTab
Please refer to the Packaging Definitions section for how to setup this section of the "Shipping Agent Card".
Labels FastTab
Please refer to the Label Definitions section for how to setup this section of the "Shipping Agent Card".
Documents FastTab
The options available on this FastTab all relate to the uploading of documents against a Consignment.
Notifications FastTab
The options on this FastTab currently are only relevant when integrating with Parcelforce and should be used to define which type of Notifications you would like to use. The Enabled Field should be ticked against the relevant options.
If there are any Customers which do not require Notifications to be sent then they can be excluded by selecting the Prevent Sending Shipping Agent Notifications attribute found on the Customer setup, as detailed here.
Ribbon Options
The following options are all available to select under the ‘Related’ Menu.
Services |
Please refer to this section for more information Shipping Agent Integration Services |
Parameters |
Please refer to this section for more information Shipping Agent Specific Parameters |
Document Types |
The options available here all relate to the uploading of documents against a Consignment. |