Content in this article:
- Carriers retrieval
- Cost center retrieval
- Incoterms
- Mail types
- Packages
- Service Level Times
- Service Level Others
- Booking Profiles
- Account information
There are several settings related to an account. All these settings can be retrieved via a GET function and used in a booking request. These settings can also be set in your source system to be used for bookings or other actions. You will retrieve Transsmart codes and descriptions. These codes can be linked to parameters in your source system. These parameters in your system can then be used for generating a Transsmart booking.
1 Carriers retrieval
All your configured carriers can be retrieved via a GET function to the following path:
/v2/accounts/{account}/listsettings/carriers
You will receive a list of all configured carriers, their codes that are used in a booking for Transsmart and a description of the carrier.
2 Cost center retrieval
Transsmart makes use of cost centers. These cost centers can be utilized for various purposes such as booking on different accounts, implementing specific business rules set in Transsmart or activating a different sender, etc. Your Transsmart contact person can explain more about the use of a cost center and the subsequent logic that can be triggered.
You can retrieve the available cost centers via:
/v2/accounts/{account}/listsettings/costCenters
You will receive a list of available cost centers and their descriptions.
3 Incoterms
Incoterms are settings that are an agreement between a sender and a receiver. These are global agreements that make the handover and responsibility for the goods clear. A shipment is always booked with an incoterm. More information about incoterms can be found here: https://iccwbo.org/business-solutions/incoterms-rules/incoterms-2020/
Transsmart has by default a list with all 2020 incoterms. A customer can decide in the settings which incoterms are available for booking. These can be retrieved via:
/v2/accounts/{account}/listsettings/incoterms
You will receive a list with a code and a description.
4 Mail types
Mail types can be used to send out different types of emails after a shipment is booked. Your Transsmart contact person can help you with the definition and the configuration of the emails. Based on the different mail types a subsequent email can be triggered to be sent to the different email addresses which can be set in the booking.
You can retrieve the different e-mail types configured for your account:
/v2/accounts/{account}/listsettings/mailTypes
You will receive a list with a code and a description.
5 Packages
Packages can be predefined on the account. The predefined packages in Transsmart allow you to match these with the package types in your source system. Even if the source system is not able to maintain the dimensions of the packages these can be retrieved from the Transsmart database and used in a booking via the call:
/v2/accounts/{account}/listsettings/packages
You will receive a list with a code, description, unit of measures and measurements.
6 Service Level Times
Different carriers have different service levels. A service level is a condition under which the delivery of a shipment takes place. It is a service offered by a carrier where the customer and carrier agree on the terms and conditions that apply. Your Transsmart contact person will determine in the pre-investigation which service levels should be configured. You can retrieve a list of all configured service levels via:
/v2/accounts/{account}/listsettings/serviceLevelTimes
You will receive a list with a code and a description.
7 Service Level Others
Besides service levels, there are service level additions. An example is the payment to the carrier when delivering the goods. This is called COD (cash on delivery) or signatures which need to be provided by the addressee. These additions are called serviceLevelOther(s) in the Transsmart database and differ per carrier. Your Transsmart contact person has to configure these for you and once they are configured you can retrieve the options via the call below:
/v2/accounts/{account}/listsettings/serviceLevelOthers
You will receive a list with a code and a description.
8 Booking Profiles
Booking profiles can be configured to make booking easier. A booking profile consists of a combination of the settings: carrier, serviceLevelTime, serviceLevelOther, incoterms, costCenter and mailType. With a profile it is possible to retrieve the possible settings based on a code and a description. These settings can then be used for the booking. A booking profile can be connected to a shipping method in your source system. With this code, the 6 settings to be used in the booking can be retrieved. The path for the available booking profiles is:
/v2/accounts/{account}/listsettings/bookingProfiles
You will receive a list with a code, description, carrier, serviceLevelTime, serviceLevelOther, incoterms, costCenter and mailType.
9 Account information
Accounts are used to book shipments to. An account can have one or more subaccounts. More information can be found here: https://devdocs.transsmart.com/#_accounts_hierarchy
The path for the available accounts is:
/v2/accounts/{account}/structure
You will receive a list with an accountCode, accountName, organizationCode and subAccounts