Skip to main content
Omnitracs Knowledge Base


Add (Carrier Function, North America)

This function adds a single Carrier record. Name is a required field that may not be either empty strings or null.
If any other request fields are null, corresponding Carrier table fields will be set to null.
If a request field value is an empty string, corresponding field in the database will be updated with it.

XML Request


  • null fields are the fields that are either omitted or initialized to a special value - string "NULL".
    • E.g., <Street>NULL<Street/> will be interpreted as a null field.
  • Empty string fields are, e.g., <Street /> or <Street></Street>

The Add function takes the following request parameters:

Parameter Type Optional Description
MiscInfo String Yes Additional information. This can be used to match the corresponding company's office information field
Name String No Carrier name, must be unique, or 'Record already exists' will be returned. Must be at least 4 characters.
City String Yes City segment of Carrier address
USDotNumber String Yes Identifying number issued by DOT
Postal String Yes Postal code segment of Carrier address
State String Yes State segment of Carrier address
Street String Yes Street segment of Carrier address
Street2 String Yes Street segment of Carrier address - line 2


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="" xmlns:xsd=" /XMLSchema"  xmlns:soap="">
    <Add xmlns="">

XML Response

The return result indicates success or failure via SOAP exceptions.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="" xmlns:xsd=" /XMLSchema" xmlns:soap="">
        <AddResponse xmlns="" />

  • Was this article helpful?