AllTruckJobs API v2.0

Jobs

JSON XML

The jobs resource is used to manage job data from AllTruckJobs.

The job object

The job object represents a job posting for your account.

Attributes

referenceNumberstring

Can be any combination of letters and numbers. Must be unique for each job.

This number is used to identify if our website already has a copy of this job. If it exists, we will update the existing job with any new information provided. If not, the job will be added as a new job.

titlestring

The title of your job posting.

citystring

The city where your job posting is located.

statestring

The state where your job posting is located.

postalCodestring

The ZIP code where your job posting is located.

driverTypeenum

What type of driver your job post is looking to hire. We use this to appropriately categorize your job.

Possible enum values:

Company Driver
Owner Operator
Student

preferenceenum

Is the job a lease purchase? Is it a team or solo driver opportunity? We use this field to appropriately categorize your job. If both team and solo drivers are allowed include both in your preference.

Possible enum values:

Lease Purchase
Team
Team Solo
Lease Purchase Team
Lease Purchase Team Solo

freightTypeenum

What type of freight your job post is hauling. We use this to appropriately categorize your job.

Possible enum values:

Box
Car Hauler
Drop and Hook
Dry Bulk
Dry Van
Flatbed
Hopper Bottom
Intermodal
Oil Field
Oversize Load
Refrigerated
Tanker
Yard Spotter

payAmountMindecimal

The minimum pay provided by the Client for this Job. This is the bottom end of the pay range.

payAmountMaxdecimal

The maximum pay provided by the Client for this Job. This is the top end of the pay range.

payFrequencyenum

The frequency at which a Client pays the Employee for this Job.

Possible enum values:

Hourly
Weekly
Per Mile

employmentTypelist<enum>

The type(s) of employment applicable for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values.

Possible enum values:

Full-Time
Part-Time
Temporary
Permanent

routeTypelist<enum>

The type(s) of routes for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values.

Possible enum values:

Dedicated
Local
LTL
OTR
Regional

descriptionstring

The description of your job posting. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>

requirementsstring

The minimum requirements a driver applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>

twicOnlyboolean

Are drivers required to have a TWIC card to apply for this job?

licenseClassenum

The required CDL class for the job.

Possible enum values:

A
B
C
None

Example

{
    "id": 4,
    "date": "2024-04-25",
    "referenceNumber": "iJUpYLpi",
    "title": "Job Title",
    "city": "Lancaster",
    "state": "PA",
    "postalCode": "17603",
    "payAmountMin": "1300.00",
    "payAmountMax": "1700.00",
    "payFrequency": "Weekly",
    "driverType": "Student",
    "freightType": "Flatbed",
    "preference": "Team",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "employmentType": "Part-Time",
    "routeType": "OTR",
    "twicOnly": true,
    "licenseClass": "A"
}

<?xml version="1.0"?>
<jobs>
  <job>
    <id>4</id>
    <date>2024-04-25</date>
    <referenceNumber>iJUpYLpi</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <payAmountMin>1300.00</payAmountMin>
    <payAmountMax>1700.00</payAmountMax>
    <payFrequency>Weekly</payFrequency>
    <driverType>Student</driverType>
    <freightType>Flatbed</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>OTR</routeType>
    <twicOnly>1</twicOnly>
    <licenseClass>A</licenseClass>
  </job>
</jobs>

List all jobs

GET https://www.alltruckjobs.com/api/v2.0/jobs.json GET https://www.alltruckjobs.com/api/v2.0/jobs.xml

URL Parameters

No parameters.

Query Parameters

No parameters.

Example Request

GET https://www.alltruckjobs.com/api/v2.0/jobs.json GET https://www.alltruckjobs.com/api/v2.0/jobs.xml

Example Response

[
    {
        "id": 3,
        "date": "2024-04-25",
        "referenceNumber": "iJUpYLpi",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "payAmountMin": "1300.00",
        "payAmountMax": "1700.00",
        "payFrequency": "Weekly",
        "driverType": "Owner Operator",
        "freightType": "Tanker",
        "preference": "Team",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "employmentType": "Part-Time",
        "routeType": "Dedicated",
        "twicOnly": false,
        "licenseClass": "A"
    },
    {
        "id": 3,
        "date": "2024-04-25",
        "referenceNumber": "iJUpYLpi",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "payAmountMin": "1300.00",
        "payAmountMax": "1700.00",
        "payFrequency": "Weekly",
        "driverType": "Company Driver",
        "freightType": "Flatbed",
        "preference": "Team",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "employmentType": "Full-Time",
        "routeType": "Dedicated",
        "twicOnly": false,
        "licenseClass": "A"
    }
]

<?xml version="1.0"?>
<jobs>
  <job>
    <id>4</id>
    <date>2024-04-25</date>
    <referenceNumber>iJUpYLpi</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <payAmountMin>1300.00</payAmountMin>
    <payAmountMax>1700.00</payAmountMax>
    <payFrequency>Weekly</payFrequency>
    <driverType>Student</driverType>
    <freightType>Flatbed</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>Dedicated</routeType>
    <twicOnly>1</twicOnly>
    <licenseClass>A</licenseClass>
  </job>
  <job>
    <id>3</id>
    <date>2024-04-25</date>
    <referenceNumber>iJUpYLpi</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <payAmountMin>1300.00</payAmountMin>
    <payAmountMax>1700.00</payAmountMax>
    <payFrequency>Weekly</payFrequency>
    <driverType>Student</driverType>
    <freightType>Flatbed</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Full-Time</employmentType>
    <routeType>Dedicated</routeType>
    <twicOnly></twicOnly>
    <licenseClass>A</licenseClass>
  </job>
</jobs>

Post job(s)

POST https://www.alltruckjobs.com/api/v2.0/jobs.json POST https://www.alltruckjobs.com/api/v2.0/jobs.xml

Parameters

The maximum data payload size for requests to this endpoint is 1,000.

The maximum active jobs allowed is 10,000. Any additional jobs will be ignored.

This endpoint allows a maximum of 1 request per hour. Although single job postings are supported, it is intended that you post all jobs that you need to update on the site at one time (up to the maximum of 1,000 jobs), not one job at a time. If you need to post more than 1,000 jobs, you will need to spread this out over multiple requests, or alternatively, consider using the dedicated job import endpoint or configuring a job feed.

Field	Format/Values	Required	Description
referenceNumber	Alphanumeric	Yes	Can be any combination of letters and numbers. Must be unique for each job. This number is used to identify if our website already has a copy of this job. If it exists, we will update the existing job with any new information provided. If not, the job will be added as a new job.
title	String	Yes	The title of your job posting.
city	String	No	The city where your job posting is located.
state	USPS 2-letter abbreviation	Yes	The state where your job posting is located.
postalCode	USPS 5-digit or 9-digit ZIP code	No	The ZIP code where your job posting is located.
driverType	String One of the following allowed values: Company Driver Owner Operator Student	Yes	What type of driver your job post is looking to hire. We use this to appropriately categorize your job.
preference	String One of the following allowed values: Lease Purchase Team Team Solo Lease Purchase Team Lease Purchase Team Solo	No	Is the job a lease purchase? Is it a team or solo driver opportunity? We use this field to appropriately categorize your job. If both team and solo drivers are allowed include both in your preference.
freightType	String One of the following allowed values: Box Car Hauler Drop and Hook Dry Bulk Dry Van Flatbed Hopper Bottom Intermodal Oil Field Oversize Load Refrigerated Tanker Yard Spotter	Yes	What type of freight your job post is hauling. We use this to appropriately categorize your job.
payAmountMin	Decimal	No	The minimum pay provided by the Client for this Job. This is the bottom end of the pay range.
payAmountMax	Decimal	No	The maximum pay provided by the Client for this Job. This is the top end of the pay range.
payFrequency	String One of the following allowed values: Hourly Weekly Per Mile	No	The frequency at which a Client pays the Employee for this Job.
employmentType	Enum One of the following allowed values: Full-Time Part-Time Temporary Permanent	No	The type(s) of employment applicable for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values.
routeType	Enum One of the following allowed values: Dedicated Local LTL OTR Regional	No	The type(s) of routes for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values.
description	String	Yes	The description of your job posting. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>
requirements	String	No	The minimum requirements a driver applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>
twicOnly	Boolean	No	Are drivers required to have a TWIC card to apply for this job?
licenseClass	String One of the following allowed values: A B C None	No	The required CDL class for the job.

Example Request

POST https://www.alltruckjobs.com/api/v2.0/jobs.json POST https://www.alltruckjobs.com/api/v2.0/jobs.xml

[
    {
        "referenceNumber": "u9FE7VIZ",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "description": "Text or HTML describing this job",
        "requirements": "Text or HTML describing the requirements for this job",
        "driverType": "Company Driver",
        "freightType": "Dry Van",
        "payAmountMin": "1300.00",
        "payAmountMax": "1700.00",
        "payFrequency": "Weekly",
        "preference": "Team",
        "employmentType": [
            "Full-Time",
            "Permanent"
        ],
        "routeType": [
            "Dedicated",
            "Regional"
        ],
        "twicOnly": true,
        "licenseClass": "A"
    }
]

<?xml version="1.0"?>
<jobs>
  <job>
    <referenceNumber>u9FE7VIZ</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <description>Text or HTML describing this job</description>
    <requirements>Text or HTML describing the requirements for this job</requirements>
    <driverType>Company Driver</driverType>
    <freightType>Dry Van</freightType>
    <payAmountMin>1300.00</payAmountMin>
    <payAmountMax>1700.00</payAmountMax>
    <payFrequency>Weekly</payFrequency>
    <preference>Team</preference>
    <employmentType>Full-Time</employmentType>
    <employmentType>Permanent</employmentType>
    <routeType>Dedicated</routeType>
    <routeType>Regional</routeType>
    <twicOnly>1</twicOnly>
    <licenseClass>A</licenseClass>
  </job>
</jobs>

Example Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 1,
    "deleted": 0,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    },
    "ignoredValues": []
}

<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>1</added>
  <deleted>0</deleted>
  <errors>0</errors>
  <errorMessages>
    <missingErrors>
      <errors/>
    </missingErrors>
    <invalidErrors>
      <errors/>
    </invalidErrors>
    <duplicationErrors>
      <errors/>
    </duplicationErrors>
    <limitErrors>
      <errors/>
    </limitErrors>
  </errorMessages>
  <ignoredValues/>
</jobs>

Retrieve a job

GET https://www.alltruckjobs.com/api/v2.0/jobs.json/:id GET https://www.alltruckjobs.com/api/v2.0/jobs.xml/:id

URL Parameters

id REQUIRED integer

The ID number of the job you want to fetch.

Query Parameters

No parameters.

Example Request

GET https://www.alltruckjobs.com/api/v2.0/jobs.json/10 GET https://www.alltruckjobs.com/api/v2.0/jobs.xml/5

Example Response

{
    "id": 10,
    "date": "2024-04-25",
    "referenceNumber": "iJUpYLpi",
    "title": "Job Title",
    "city": "Lancaster",
    "state": "PA",
    "postalCode": "17603",
    "payAmountMin": "1300.00",
    "payAmountMax": "1700.00",
    "payFrequency": "Weekly",
    "driverType": "Student",
    "freightType": "Tanker",
    "preference": "Team",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "employmentType": "Part-Time",
    "routeType": "OTR",
    "twicOnly": true,
    "licenseClass": "A"
}

<?xml version="1.0"?>
<jobs>
  <job>
    <id>5</id>
    <date>2024-04-25</date>
    <referenceNumber>iJUpYLpi</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <payAmountMin>1300.00</payAmountMin>
    <payAmountMax>1700.00</payAmountMax>
    <payFrequency>Weekly</payFrequency>
    <driverType>Student</driverType>
    <freightType>Tanker</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>OTR</routeType>
    <twicOnly>1</twicOnly>
    <licenseClass>A</licenseClass>
  </job>
</jobs>

Delete a job

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/:id DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/:id

URL Parameters

id REQUIRED integer

The ID number of the job you want to delete.

Example Request

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/12345 DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/12345

Example Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    }
}

<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>1</deleted>
  <errors>0</errors>
  <errorMessages>
    <missingErrors>
      <errors/>
    </missingErrors>
    <invalidErrors>
      <errors/>
    </invalidErrors>
    <duplicationErrors>
      <errors/>
    </duplicationErrors>
    <limitErrors>
      <errors/>
    </limitErrors>
  </errorMessages>
</jobs>

Delete multiple jobs

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml

Example Request

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml

<?xml version="1.0"?>
<jobs>
  <job>12345</job>
  <job>123456</job>
</jobs>

Example Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    }
}

<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>2</deleted>
  <errors>0</errors>
  <errorMessages>
    <missingErrors>
      <errors/>
    </missingErrors>
    <invalidErrors>
      <errors/>
    </invalidErrors>
    <duplicationErrors>
      <errors/>
    </duplicationErrors>
    <limitErrors>
      <errors/>
    </limitErrors>
  </errorMessages>
</jobs>

Delete a job by reference

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/reference/:referenceNumber DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/reference/:referenceNumber

URL Parameters

referenceNumber REQUIRED string

The reference number of the job you want to delete.

Example Request

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/reference/12345 DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/reference/12345

Example Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    }
}

<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>1</deleted>
  <errors>0</errors>
  <errorMessages>
    <missingErrors>
      <errors/>
    </missingErrors>
    <invalidErrors>
      <errors/>
    </invalidErrors>
    <duplicationErrors>
      <errors/>
    </duplicationErrors>
    <limitErrors>
      <errors/>
    </limitErrors>
  </errorMessages>
</jobs>

Delete multiple jobs by reference

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/reference DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/reference

Example Request

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.json/reference DELETE https://www.alltruckjobs.com/api/v2.0/jobs.xml/reference

[
    "12345",
    "123456"
]

<?xml version="1.0"?>
<jobs>
  <job>12345</job>
  <job>123456</job>
</jobs>

Example Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    }
}

<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>2</deleted>
  <errors>0</errors>
  <errorMessages>
    <missingErrors>
      <errors/>
    </missingErrors>
    <invalidErrors>
      <errors/>
    </invalidErrors>
    <duplicationErrors>
      <errors/>
    </duplicationErrors>
    <limitErrors>
      <errors/>
    </limitErrors>
  </errorMessages>
</jobs>