AllTruckJobs API v2.0

Jobs Data

JSON XML

The jobs endpoint is used to fetch job data from AllTruckJobs.

Fetch All Jobs

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

Sample Request

To get all jobs:

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

Sample Response

[
    {
        "id": 8,
        "date": "2022-08-13",
        "referenceNumber": "8efT3YfR",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "driverType": "Company Driver",
        "freightType": "Refrigerated",
        "preference": "Team",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "employmentType": "Part-Time",
        "routeType": "Dedicated"
    },
    {
        "id": 5,
        "date": "2022-08-13",
        "referenceNumber": "8efT3YfR",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "driverType": "Company Driver",
        "freightType": "Tanker",
        "preference": "Team",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "employmentType": "Part-Time",
        "routeType": "Dedicated"
    }
]

<?xml version="1.0"?>
<jobs>
  <job>
    <id>8</id>
    <date>2022-08-13</date>
    <referenceNumber>8efT3YfR</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <driverType>Company Driver</driverType>
    <freightType>Refrigerated</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>Dedicated</routeType>
  </job>
  <job>
    <id>5</id>
    <date>2022-08-13</date>
    <referenceNumber>8efT3YfR</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <driverType>Company Driver</driverType>
    <freightType>Tanker</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>Dedicated</routeType>
  </job>
</jobs>

Fetch a Single Job

GET https://www.alltruckjobs.com/api/v2.0/jobs.jsonxml/{id}

Parameters

Parameter should be appended to the endpoint URL.

Field	Format/Values	Required	Description
id	Integer	Yes	The ID number of the job you want to fetch.

Sample Request

GET https://www.alltruckjobs.com/api/v2.0/jobs.jsonxml/12345

Sample Response

{
    "id": 10,
    "date": "2022-08-13",
    "referenceNumber": "8efT3YfR",
    "title": "Job Title",
    "city": "Lancaster",
    "state": "PA",
    "postalCode": "17603",
    "driverType": "Owner Operator",
    "freightType": "Tanker",
    "preference": "Team",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "employmentType": "Full-Time",
    "routeType": "OTR"
}

<?xml version="1.0"?>
<jobs>
  <job>
    <id>10</id>
    <date>2022-08-13</date>
    <referenceNumber>8efT3YfR</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <driverType>Owner Operator</driverType>
    <freightType>Tanker</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Full-Time</employmentType>
    <routeType>OTR</routeType>
  </job>
</jobs>

Post Job(s)

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

Parameters

Parameter should be appended to the endpoint URL.

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 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.
employmentType	List Any combination 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	List Any combination 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[ ]]>

Sample Request

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

[
    {
        "date": "2022-08-13",
        "referenceNumber": "8efT3YfR",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalCode": "17603",
        "driverType": "Company Driver",
        "freightType": "Refrigerated",
        "preference": "Team",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "employmentType": "Part-Time",
        "routeType": "OTR"
    }
]

<?xml version="1.0"?>
<jobs>
  <job>
    <date>2022-08-13</date>
    <referenceNumber>8efT3YfR</referenceNumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalCode>17603</postalCode>
    <driverType>Company Driver</driverType>
    <freightType>Refrigerated</freightType>
    <preference>Team</preference>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <employmentType>Part-Time</employmentType>
    <routeType>OTR</routeType>
  </job>
</jobs>

Sample Response

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

<?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>
</jobs>

Delete a Single Job

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.jsonxml/{id}

Parameters

Parameter should be appended to the endpoint URL.

Field	Format/Values	Required	Description
id	Integer	Yes	The ID number of the job you want to delete.

Sample Request

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

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": []
}

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

Delete Multiple Jobs

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

Parameters

Parameter should be appended to the endpoint URL.

Field	Format/Values	Required	Description
id	Integer	Yes	The ID number of the job you want to delete.

Sample Request

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

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

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": []
}

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

Delete One Job By Reference

DELETE https://www.alltruckjobs.com/api/v2.0/jobs.jsonxml/reference/{referenceNumber}

Parameters

Parameter should be appended to the endpoint URL.

Field	Format/Values	Required	Description
referenceNumber	String	Yes	The reference number of the job you want to delete.

Sample Request

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

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": []
}

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

Delete Multiple Jobs By Reference

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

Parameters

Parameter should be appended to the endpoint URL.

Field	Format/Values	Required	Description
id	String	Yes	The reference number of the job you want to delete.

Sample Request

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

[
    "12345",
    "123456"
]

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

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": []
}

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