Traditionally, labs needed to logon to a carrier’s web site to schedule a pick-up. Additionally, when invoicing cases, they also had to go to another computer provided by the carrier to create shipments. These processes are time consuming and the information such as pick-up requests and tracking numbers are not recorded with the customer account. DLCPM provides integration to resolve these issues and optimizes the processes.
The integration with FedEx & UPS will provide a number of benefits: ➢Ability to schedule pick-ups and create labels from within DLCPM ➢Create shipments including shipping labels while invoicing cases ➢Provide your customers with the option to schedule their own pick-ups directly from the web (requires Customer Web Portal service) ➢Track all transactions with the customer accounts for future reference Requirements: In order to use the integration services, you must register with the respective carriers. This registration is required even if you already have an account. It is strongly recommended that you contact your account representative for assistance.
*Pickups: Once the integration is set up, call the FedEx Help Desk to make sure pick-ups are enabled on your account. Without this step, you may not be able to schedule pickups from DLCPM Enterprise. Ask for Web Services: 877-339-2774
***Important: When contacting your Carrier, please be sure to tell them you have hired a third-party developer to create a custom application for you. Please do NOT tell them that you have purchased a program that has the integration features built-in as it will prolong your approval process by several months. |
|
FedEx Integration
The FedEx integration uses FedEx RESTful API. You must register with FedEx and obtain a “Developer Test Key” before you can use this service.
1.Go to FedEx’s developer portal at https://developer.fedex.com/api/en-us/home.html 2.Click the ‘Log In’ button. 3.Enter your FedEx User ID and Password, then click ‘Log In’. 4.Once you are logged in, click the ‘My Projects’ button on the left-hand sidebar. 5.Click the ‘Create API Project’ button, and a popup window will appear.
6.In this window, select the first option in the drop-down menu, then click ‘Next’. 7.Click the ‘Select’ button for ‘Ship, Rate & other APIs’. 8.Select all APIs that appear, then click ‘Next’.
9.Enter a project name, select your country, make your desired selections for ‘FedEx SmartPost Returns’ and ‘FedEx Freight LTL’, and then click ‘Next’. If you’re not sure about these selections, we would recommend reaching out to your account representative for assistance. 10. Accept the terms, and then click ‘Create’.
11. At this point, you should see a message indicating that your project was created. Click ‘Okay’, and you will be taken to the project overview page. 12. On this overview page you can access your test credentials. The fields you’ll need later on are the API Key, Secret Key, and Account.
13. FedEx now separates its Tracking API and Shipping API, so you will need to create an additional Tracking account if you would like to take advantage of this feature. If you want to enable FedEx tracking through DLCPM, complete steps 5-10 again, but in step 7 select ‘Track API’ instead of ‘Ship, Rate & other APIs’. |
Once you have your test credentials, you are ready to create your production keys. These are the keys that you will be using to create actual shipments.
1.First, check if you have an existing ‘Shipping Account’. You can see this by clicking ‘Manage Organization’ on the left-hand sidebar and then selecting the ‘Shipping Accounts’ tab. If there are no Shipping Accounts listed, create one by clicking ‘Add Account’.
2.If you have an account number from an old shipping account, enter it here and fill out the rest of the details. If you do not have an account number, click the ‘create an account’ text. 3.Once you have created a valid Shipping Account, navigate back to the API project overview page and select the ‘Production Key’ tab. Enter a name and select the Account number from the drop-down list, then click the ‘Next’ button.
4. You will be taken to a screen containing your production keys. Be sure to save these keys somewhere, as you won’t be able to access the secret key again after navigating away from the page.
5. If you plan to use the FedEx tracking feature with DLCPM, complete steps 1-4 again with the Tracking project you created in the last section.
|
FedEx requires that all customers certify their integration by printing a series of shipping labels, scanning those printed labels, and sending them in to be verified. They do this to ensure that your printer is capable of printing valid shipping labels.
1.First, fill out the FedEx Label Evaluation cover sheet. You must fill out the entire form. a.The ‘FedEx 9-Digit Account Number’ must be your Production account number, not your Test account number. b.For ‘Are you using Third Party Solution?’, select ‘No’. Leave the ‘Third Party Solution Name’ field blank. c.In the ‘Label Image Type’ field, check either ‘ZPL’ or ‘PDF’. d.In the ‘Services Requested’ field, check ‘Express’ and ‘Ground’. You can download the form at this link: https://developer.fedex.com/api/content/dam/fedex-com/irc/common/Label-Cover-Sheet-form.pdf
2. Navigate to File > Global Settings > Laboratory Lists > Laboratories in DLCPM.
3. Open your lab in the resulting list, click on the ‘Shipping Carriers’ tab, and then select the ‘FedEx’ sub-tab. Click on the ‘Fedex Settings’ button. Note: If you have an existing FedEx integration, create a new laboratory for testing instead of using your live lab. This way, you can continue to create shipments using your existing integration and credentials until the certification process is complete.
4. Enable ‘Process in Test Mode’. Additionally fill in the fields Account Number, API Key, and Secret Key with the information you obtained in the ‘Getting your Test Keys’ section of this document. Click ‘OK’.
Note: You must use your Test Keys for this step. If you enter your Production Keys, you will receive an error when you attempt to generate the certification files.
5. Click on the ‘Create Certification Files’ button. At this point, you will be prompted to either save the labels in PDF or ZPL format, or to print them directly through a ‘ZPL’ label printer. Make your selection and then press ‘Print Labels’. If you output the labels as files, you will need to then print those files physically with a label printer.
Note: Labels must be scanned at a minimum resolution of 600 DPI to ensure clear images are available.. A full list of requirements can be found on the FedEx developer portal: https://developer.fedex.com/api/en-us/certification.html
6. After printing the labels, make scans of them. Email label@fedex.com with the cover letter and all scans. Once the FedEx certification team receives and certifies your labels, your production keys will be authorized to transmit shipping information and you will be notified by email. Note: The scans must have a minimum of 600DPI. |
Once your certification has been completed by FedEx, it’s time to place your production credentials into DLCPM to finalize the integration.
1. Navigate to File > Global Settings > Laboratory Lists > Laboratories in DLCPM.
2. Open your lab in the resulting list, click on the ‘Shipping Carriers’ tab, and then select the ‘FedEx’ sub-tab. Click on the ‘Fedex Settings’ button.
3. If you did not have a previous FedEx integration, proceed to the next step.
If you had a previous FedEx integration, you should see a button that says ‘Switch to Fedex OAuth API.’ If you have your production keys and you have received certification from FedEx, you may now click this button and select ‘Yes’ on the dialog box that opens. This clears out the old keys and show the new fields to enter.
4. Enter your production account information in the Account Number, API Key, and Secret Key fields. If you’re ready for production, uncheck ‘Process in Test Mode’. If you haven’t already, check the ‘Enable FedEx Shipment’ box. If you will also be creating pickups through FedEx, check the ‘Enable FedEx Pickups’ box.
5. If you are additionally using the ‘Tracking’ FedEx API, enter the production key details for your tracking account in the ‘Tracking’ API Key and Secret Key fields.
6. If you had an existing FedEx integration and created a test laboratory to host your credentials during the certification process, you can now delete the test laboratory. 7. To test your credentials, navigate to Shipping > Create Return Labels. Select a customer, lab, and a valid FedEx service type. Click ‘Create Labels’ and verify that the return label is created successfully.
8. To test outbound shipments, navigate to Shipping > Customer Shipping Manager. Select a shipment with the carrier ‘FedEx’ and click ‘Process Shipment.’ Click ‘Create Shipment.’ After verifying that the shipment was created successfully, you can navigate to the ‘All Shipments’ tab, select the shipment you just created, and click ‘Void Shipment.’
|