Please note:
This version of the Trade Trak API is deprecated and will be switched off on the 30th of June 2022. For our updated API please see: https://documenter.getpostman.com/view/16153613/TzkzoyBo
The jobs API main endpoint is [https://app.tradetrak.com.au/api/job/](https://app.tradetrak.com.au/api/job/)
and the following functions are currently available.
List all jobs
- Endpoint:
https://app.tradetrak.com.au/api/job/list
- Request Data:
- Optional parameter:
search
to search within a job name or address
- Optional parameter:
- Request Type: GET
- Returned Data: A JSON array containing information about each job, including the client and also site contact.
[{
"id": 0,
"name": "Demo Job",
"client": { See Client API for expected data response },
"main_contact": {
"id": 0,
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"office_phone_number": null,
"email": "contact@digitalbasis.com",
"firm_id": 0,
"firm": "Demo Client"
},
"status_id": 11,
"status": "In Progress",
"created_date": "2018-08-30 09:20:01",
"start_date": "2018-08-30",
"end_date": "2019-08-30",
"description": "Job involves several stages of work, including getting ready for starting the work, completing the work and testing the work.",
"address": "7 Riverside Quay, Southbank VIC 3006, Australia"
}]
List single job
- Endpoint:
https://app.tradetrak.com.au/api/job/<JOB #>/list
E.G.
https://app.tradetrak.com.au/api/job/0/list
- Request Data: None
- Request Type: GET
- Returned Data: Same data returned as List all jobs, however only one single job will be returned, or an array containing error information if the job wasn't found.
Create job
- Endpoint:
https://app.tradetrak.com.au/api/job/create
- Request Data: A JSON object containing the following information. Required fields are prefixed with an asterisk (*)
{
*"name": "The name you would like to give the job - string",
*"client": "The ID of a client (See below for listing available clients and creating new clients) - integer. Alternatively, pass through the text name of the client name - if the client exists, it will match the client, if it does not exist, it will create a new client.",
"start_date": "The start date for a job if applicable, in format 'yyyy-mm-dd' e.g. 2018-08-30",
"end_date": "The end date for a job if applicable, in format 'yyyy-mm-dd' e.g. 2018-08-30",
"description": "A description for this job - string",
"address": "The job address if applicable - string",
"status": "Status name - string - If a status is not found by this name a new one will be created"
}
- Request Type: POST
- Returned Data: Returns job information for created job as above, or an array containing error information if the job wasn't created successfully.
- Jobs can have custom field data added to the create request, see more on custom fields here
May 2, 2022