Carrier in Main(TMSCarrier)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | TMSCarrier/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "1.1" | string | semantic version number of the entity |
is.application.releaseVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
isPrimaryKey | true |
dataFormat | int64 |
isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | TMSCarrier/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
Active
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
displayName | Activate shipping carrier |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the Active attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
CarrierCode
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the CarrierCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
IsBroker
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
displayName | Designate carrier as a broker |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the IsBroker attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
LoadTender
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the LoadTender attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ModeCode
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ModeCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
Name
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the Name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ProNumberCode
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ProNumberCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
RatingEnabled
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
displayName | Activate carrier rating |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the RatingEnabled attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
SCAC
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the SCAC attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
TrackingURL
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
displayName | Tracking URL |
dataFormat | string |
isNullable | true |
Traits
List of traits for the TrackingURL attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
VendorCode
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the VendorCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
WebsiteURL
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
displayName | Website URL |
dataFormat | string |
isNullable | true |
Traits
List of traits for the WebsiteURL attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
AverageContainerWeight
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the AverageContainerWeight attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
DataAreaId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
Traits
List of traits for the DataAreaId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
Relationship_TMSModeRelationshipId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_TMSModeRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_TMSNumberSequenceRelationshipId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_TMSNumberSequenceRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_VendTableRelationshipId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_VendTableRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_CompanyRelationshipId
First included in: Main/TMSCarrier (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_CompanyRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array