Skip to navigation
IntegrationsTMS Connections

Create Tms Connection

Create a new TMS connection.

This will validate the credentials with the TMS before creating the connection. If the credentials are invalid, the connection will not be created and an error will be returned.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
tms_idstringRequiredformat: "uuid"

The ID of the Transportation Management System (TMS) that the TMS account uses.

credentialsobjectRequired
The connection credentials required to authenticate with the TMS on behalf of the TMS account.
descriptionstring or nullOptional
A description of the connection. Useful when the TMS account has multiple connections to the same TMS.

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the TMS connection.
created_atdatetime
Timestamp when the connection was created.
updated_atdatetime
Timestamp when the connection was last updated.
tms_account_idstringformat: "uuid"
The Catena ID of the TMS account that owns this connection.
tms_idstringformat: "uuid"

The ID of the Transportation Management System (TMS).

source_nameenum
The name of the TMS integration used for this connection.
Allowed values:
credentialsobject
The connection credentials used to authenticate with the TMS.
statusenum
The current status of the connection.
descriptionstring or null
A description of the connection. Useful when the TMS account has multiple connections to the same TMS.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error