Kleinschmidt is a supply chain and logistics data integration solution that allows brokers and shippers to electronically share documents. Refer to the Kleinschmidt website for more information about the product features.
This document walks you through the process of enabling a Turvo integration with Kleinschmidt. Several steps are required to provide Kleinschmidt the necessary access to build an integration.
Before proceeding, you’ll need a contracted agreement directly with Kleinschmidt. Their contact information is available on their website.
Set up EDI integration with a Customer account (Shipper)
Follow the steps below to set up a new EDI integration with a Shipper customer account. Turvo supports the following EDI messages:
- 204
- 214
- 210
- 990
- 997
Note: 210’s can only be processed if a 204 has already been received.
Step 1:
Create a Kleinschmidt specific user profile. For more information, see How to create users. You must use a valid company email. The user must have Admin privileges or above and should be added to both my-sandbox and production environments. Kleinschmidt requires the creation of the email ID and the password when logging in.
Protip: Name the user something you’ll recognize as EDI updates. The user name will be displayed for any updates that result from the integration.
Step 2:
After you create an API user, you must give the user access to the public API. This can be done in the admin console API and Webhooks card (see How to create API User). After access is granted for that user, share the Client_id, Secret, and email ID and password Kleinschmidt. Kleinschmidt requires this to configure the integration.
Step 3:
Generate a PublisherID for use by Kleinschmidt. To begin this process, create a support ticket with the following text.
- Title:
<Turvo Enterprise customer name>: EDI Setup with Kleinschmidt. PublisherID request - Description: We would like to enable a publisherID for our Broker tenant to use the connect Shipment API. This will be needed for both our my-sandbox and production tenants.
Include the My-sandbox tenant name and IDProduction tenant name and ID in the ticket description (Note: if you do not have these, your CXM or Delivery manager can assist in providing).
Once completed, Turvo will provide a publisher ID which can be shared with Kleinschmidt. A publisher ID displays:
<Customer Name> - KS”.>
You only need to complete Steps 1-3 one time per tenant.
Step 4:
Turvo will enable a webhook for Kleinschmidt to receive Turvo generated updates. Because of the technical aspects of this integration, this webhook can’t be generated from Turvo’s API/Webhook admin counsel and must be created by Turvo. You must create a second support ticket for this. Include the following text in the support ticket:
- Title: Kleinschmidt Webhook configuration for customer account <customer account name>
- Description: Please enable a Kleinschmidt webhook for customer account <customer account name> with the following events for both my-sandbox and production.
Shipment_Status_Update
Document_Create
Document_Update
Note: You must complete this step for each customer you wish to do EDI with.
Include the following details in the ticket description (if you do not have these, your CXM or Delivery manager can assist in providing):
- My-sandbox tenant name and ID.
- Production tenant name and ID.
- Customer Account name and ID you plan to do EDI with (ID’s can be found in the URL of the account profile (Below example ID is equal to “273949”).Include both my-sandbox and production account IDs.
Once Webqueue is established, Kleinschmidt first tests and validates the integration in my-sandbox. Customers are responsible for UAT prior to Kleinschmidt updating production. Once validated in production, the integration is complete.
The Turvo customer must provide the following information to Kleinschmidt
- Public API credentials including client ID and secret (this is only needed once per tenant).
- PublisherID (this is only needed once per tenant).
- Customer account IDs for the accounts that are to be set up with EDI. IDs for both sandbox and production shall be provided.
Important note: Turvo’s EDI integration with Kleinschmidt will not process correctly until you fully configure the publisherID and webhooks.
Set up additional Customer account (Shipper) EDI Integrations for a Broker Tenant
If the Broker has already integrated with Kleinschmidt and only needs to set up an EDI integration with a new Customer account, then the customer can repeat step 4 above.
Set up EDI integration with a Carrier account
The following steps detail how to set up a new Kleinschmidt EDI integration for a Turvo Broker customer with one of their Carriers. It is important to remember that Kleinschmidt does not support the offer flow. For more information, reach out to your Turvo representative.
Step 1:
Customer: Create an API login to provide to your integration partner.
- Create a Kleinschmidt specific user profile. For more information, see How to create users. You must use a valid company email. The user must have Admin privileges or above and should be added to both my-sandbox and production environments. Kleinschmidt requires the creation of the email ID and the password when logging in.
Protip: Name the user something you’ll recognize as EDI updates. The user name will be displayed for any updates that result from the integration. - After you create an API user, you must give the user access to the public API. This can be done in the admin console API and Webooks card (see How to create API User).
After access is granted for that user, share the Client_id, Secret, and email ID and password Kleinschmidt. Kleinschmidt requires this to configure the integration.
Step 2:
Customer: Set up the following webhooks to Kleinschmidt via the Turvo admin console API & Webhooks setup. Make sure to include the Shipment, Create, Update, and Status events.
Step 3:
Customer: Provide the Carrier Account ID to your integration partner. The Carrier ID can be found in the URL of the account profile.
<%= heading %>