Set up Clients to TMS

Owned by Dean Bazeley
Last updated: May 25, 2023 by James Seabrook

How To set Up Clients to TMS.doc


URL_UAT: https://tmsuat.supplystream.com

URL Live: https://tms.supplystream.com


Requirements:

Carriers

Integration ID code: (Code must match the CompanyIntegration Integration ID in SupplyStream)


To Select Intergration Partner

My Account -> Default Integration Partner -> Select @  Set Default Integration Partner list



Change Client > Select @ Change Client List - you wish to connect to TMS


Entity Setup -> Client Setup -> Maintain Clients

Click the "Create New Client" button


Enter the details for the new client (leave the email empty) then save.



To Add Carrier to Customer

System Admin -> Security -> Client Entitlements

Select each new client you added and give them access to "DPD NL, TNT NL, DPD, Hermes, Interpost, Omni Parcel, Royal Mail"



System Admin -> Settings -> API Credentials

Note down the API Key then log into Supplystream to continue the set up


SUPPLY STREAM SET UP


Logged as Admin

Admin -> Company -> Client Mapping

Click the Create New button


Select the client then click save


Admin -> Carriers -> Carrier Company Access

Make sure new client has access to the carrier that has been linked or set up in the TMS


To Add the Interface Type Settings 

Admin -> Carrier Providers -> Provider Interface Settings


Run the bellow script:

UAT Script

DECLARE @ReleaseProfile int = 0,
@APIToken nvarchar(100) = 'eipnqgvazhdvqcfsgidyhfu0ebmzd1aye29h0kj0',
@ClientID uniqueidentifier = 'A431F2ED-A827-E411-B3F4-000C29DA324D', -- M&S School Uniforms
@UserID uniqueidentifier = '4C95B030-6B07-DF11-B335-000C2989186B', -- admin@supplystream.com
@NEWID1 uniqueidentifier,
@NEWID2 uniqueidentifier,
@NEWID3 uniqueidentifier,
@NEWID4 uniqueidentifier,
@NEWID5 uniqueidentifier,
@NEWID6 uniqueidentifier

SET @NEWID1 = NEWID()
SET @NEWID2 = NEWID()
SET @NEWID3 = NEWID()
SET @NEWID4 = NEWID()
SET @NEWID5 = NEWID()
SET @NEWID6 = NEWID()


INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID1, '1D2616E1-3AAC-4C4A-B604-37F6A631C08C', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/Tms/CreateManifestV2?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)


INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID2, 'FFF30BD5-E2BD-4F38-B9C7-C567AF52D881', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/Tms?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID3, '6FFA4273-7543-402B-8EFE-95B0FFA78A71', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/Tms/Delete?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID4, 'FEE2726A-E384-4FE0-8CA6-DEC54018C2DB', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/Tms/PrintManifest?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID5, 'D0143356-0418-45A7-B0F8-9438B47711D2', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/Tms/Update?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID6, 'C7D50385-1A3D-40CC-B580-10247E3434CB', @ReleaseProfile, 'https://tmsuat.supplystream.com:8081/api/TMS/Shipments/{0}?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @ClientID, GETUTCDATE(), @UserID)


Live Script

DECLARE @ReleaseProfile int = 1,
@APIToken nvarchar(100) = 'twvek0p1vwqqfedxtztoeb8knsatp8jzs0ontspo', -- Api Token on the TMS site
@ClientID uniqueidentifier = 'A431F2ED-A827-E411-B3F4-000C29DA324D', -- CompanyID
@UserID uniqueidentifier = '4C95B030-6B07-DF11-B335-000C2989186B', -- admin@supplystream.com
@DCID uniqueidentifier = '18835ACA-CD37-E211-8B11-000C29E98746', --DCID
@NEWID1 uniqueidentifier,
@NEWID2 uniqueidentifier,
@NEWID3 uniqueidentifier,
@NEWID4 uniqueidentifier,
@NEWID5 uniqueidentifier,
@NEWID6 uniqueidentifier

SET @NEWID1 = NEWID()
SET @NEWID2 = NEWID()
SET @NEWID3 = NEWID()
SET @NEWID4 = NEWID()
SET @NEWID5 = NEWID()
SET @NEWID6 = NEWID()

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID1, '1D2616E1-3AAC-4C4A-B604-37F6A631C08C', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/Tms/CreateManifestV2?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID2, 'FFF30BD5-E2BD-4F38-B9C7-C567AF52D881', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/Tms?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID3, '5388749C-89C8-4612-AF12-19201797F0D6', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/Tms/Delete?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID4, 'FEE2726A-E384-4FE0-8CA6-DEC54018C2DB', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/Tms/PrintManifest?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID5, 'D0143356-0418-45A7-B0F8-9438B47711D2', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/Tms/Update?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)

INSERT INTO CarrierProviderInterfaceTypeSetting (CarrierProviderInterfaceTypeSettingID, CarrierProviderInterfaceTypeID, ReleaseProfile, [Address], UserName, [Password], CreateDate, CreateUserID, DisableLevel, DCID, CustomerID, LastModifiedDate, LastModifiedUserID)
VALUES (@NEWID6, 'C7D50385-1A3D-40CC-B580-10247E3434CB', @ReleaseProfile, 'https://tms.supplystream.com:8081/api/TMS/Shipments/{0}?token=', @APIToken, '', GETUTCDATE(), @UserID, 0, @DCID, @ClientID, GETUTCDATE(), @UserID)


Notes:

Change the below parameter:

@ReleaseProfile int = 0

If value is 0, This is QA

If value is 1, This is Live


@APIToken nvarchar(100) = 'eipnqgvazhdvqcfsgidyhfu0ebmzd1aye29h0kj0',

It is visible on the TMS site for each customer as per URL below:

URL_UAT: https://tmsuat.supplystream.com

URL Live: https://tms.supplystream.com


@ClientID uniqueidentifier = 'A431F2ED-A827-E411-B3F4-000C29DA324D', -- M&S School Uniforms

It is a unique identifier value for each customer. Get the CompanyID of the customer on the Company table.


@UserID uniqueidentifier = '4C95B030-6B07-DF11-B335-000C2989186B', -- admin@supplystream.com

It is a default user for reference.