API docs by Redocly

Task Management Service API (1.0.0)

Perform CRUD actions for tasks.

Task

Read tasks from all organizations

Only SysAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

org_id
Array of strings

Array of Merchant IDs

broadcast_preference
string
Enum: "all" "squad" "marine"

To whom this will be broadcast/sent

group_tag
string

Group tag

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Create a task from all organization

Only SysAdmin is authorized.

Authorizations:
bearerAuth
Request Body schema: application/json
tracking_id
string

Custom tracking id that consist of alphanumeric & symbols.

object (client_info)
broadcast_preference
required
string
Enum: "squad" "all" "marine"
vehicle_preference
required
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"

Transportation mode requirement for deliver the package

service_type
required
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

client_time_utc
required
string <date-time>

Time when task creation submitted

client_timezone
string

Timezone used for task creation

invoice_number
string
required
object (address)
required
object (time_window)
object (contact)
pickup_note_to_driver
string

The instruction notes for driver when the packets are to be collected.

required
object (address)
object (time_window)
object (contact)
delivery_note_to_driver
string

The instruction notes for driver when the packets are to be delivered.

object (officer_contact)
group_tag
string
currency
string

The currency should follow the ISO4217 format.

Array of objects (item)

The lists of package

Array of objects (cargo_detail)

The lists of package

total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

from_location_type
string
Enum: "land" "sea"

Type of the location for pickup

to_location_type
string
Enum: "land" "sea"

Type of the location for delivery

vehicle_emissions_type
string
Enum: "ev" "ice"

Vehicle Emissions Type

object (task_epod)
org_id
string
org_name
string

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "client": {},
  • "broadcast_preference": "squad",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "delivery_note_to_driver": "Meet at the lobby",
  • "officer_contact": {
    },
  • "group_tag": "Tag example",
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 0,
  • "total_quantity_unit": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "from_location_type": "land",
  • "to_location_type": "land",
  • "vehicle_emissions_type": "ev",
  • "epod": {
    },
  • "org_id": "string",
  • "org_name": "string"
}

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Read extract-transform-load tasks from all organizations

Only SysAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

org_id
Array of strings

Array of Merchant IDs

broadcast_preference
string
Enum: "all" "squad" "marine"

To whom this will be broadcast/sent

group_tag
string

Group tag

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new task that belongs to any organization

Only SysAdmin is authorized.

Authorizations:
bearerAuth
Request Body schema: application/json
tracking_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
required
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
required
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 0,
  • "total_quantity_unit": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl"
}

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Read an existing task of any organization

Only SysAdmin is authorized.

Retrieve task information as well as version revision value

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be read

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update an existing task of any organization

Only SysAdmin is authorized. Update task details. Disallow addition, deletion, or update of the items and attachments. Disallow driver assignment or task completion.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
tracking_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
Array of objects (archived_attachments)
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

admin_fee
number <int16>

Unit used is 1/1000 cents

version_rev
required
string

Revision value of the record version

vehicle_emissions_type
string
Enum: "ev" "ice"

Vehicle Emissions Type

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "archived_attachments": [
    ],
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "admin_fee": 20000,
  • "version_rev": "0-xxxxxxxx",
  • "vehicle_emissions_type": "ev",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update a group tag for tasks

Only SysAdmin is authorized. Update a single group tag for multiple task in one operation

Authorizations:
bearerAuth
Request Body schema: application/json
task_ids
required
Array of strings

List of task IDs to update

group_tag
required
string [ 4 .. 50 ] characters ^[a-zA-Z0-9-]+$

Shared group tag for all tasks

Responses

Request samples

Content type
application/json
{
  • "task_ids": [
    ],
  • "group_tag": "DELIVERY-BATCH-1"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Create multiple new tasks

All tasks created will be mark status as Pending Broadcast: Order is placed by sender and is awaiting to be assigned into Runsheet. Provide task details, array of items, and item summary. Does not allow attachment addition, driver assignment, or status update.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects (task_post_request)

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Return the list of tasks

Only OrgAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

group_tag
string

Group tag

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Create a new task

Mark status as Pending Broadcast: Order is placed by sender and is awaiting to be assigned into Runsheet. Provide task details, array of items, and item summary. Does not allow attachment addition, driver assignment, or status update.

Authorizations:
bearerAuth
Request Body schema: application/json
tracking_id
string

Custom tracking id that consist of alphanumeric & symbols.

object (client_info)
broadcast_preference
required
string
Enum: "squad" "all" "marine"
vehicle_preference
required
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"

Transportation mode requirement for deliver the package

service_type
required
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

client_time_utc
required
string <date-time>

Time when task creation submitted

client_timezone
string

Timezone used for task creation

invoice_number
string
required
object (address)
required
object (time_window)
object (contact)
pickup_note_to_driver
string

The instruction notes for driver when the packets are to be collected.

required
object (address)
object (time_window)
object (contact)
delivery_note_to_driver
string

The instruction notes for driver when the packets are to be delivered.

object (officer_contact)
group_tag
string
currency
string

The currency should follow the ISO4217 format.

Array of objects (item)

The lists of package

Array of objects (cargo_detail)

The lists of package

total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

from_location_type
string
Enum: "land" "sea"

Type of the location for pickup

to_location_type
string
Enum: "land" "sea"

Type of the location for delivery

vehicle_emissions_type
string
Enum: "ev" "ice"

Vehicle Emissions Type

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "client": {},
  • "broadcast_preference": "squad",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "delivery_note_to_driver": "Meet at the lobby",
  • "officer_contact": {
    },
  • "group_tag": "Tag example",
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 0,
  • "total_quantity_unit": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "from_location_type": "land",
  • "to_location_type": "land",
  • "vehicle_emissions_type": "ev",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Read an existing task

Retrieve task information as well as version revision value

Authorizations:
bearerAuth
path Parameters
trackingID
required
string

ID of the tracking task to be read. In frontend you can find it as reference ID

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Read an existing task

Retrieve task information as well as version revision value

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be read

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update an existing task

Update task details. Disallow addition, deletion, or update of the items and attachments. Disallow driver assignment or task completion.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
tracking_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

version_rev
required
string

Revision value of the record version

vehicle_emissions_type
string
Enum: "ev" "ice"

Vehicle Emissions Type

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "version_rev": "0-xxxxxxxx",
  • "vehicle_emissions_type": "ev",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Delete an existing task

Deleted task is not able to be recovered through any APIs

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully deleted the task"
}

Read tasks with no assigned runsheet

Only SysAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

org_id
Array of strings

Array of Merchant IDs

is_qa
string
Enum: true false

Is QA true or false

group_tag
string

Group tag

broadcast_preference
string
Enum: "all" "squad" "marine"

To whom this will be broadcast/sent

is_future_pickup_end_time
boolean

Limit for today & next date pickup time only

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Get today tasks for a driver.

Only driver is authorized. This API is deprecated

Authorizations:
bearerAuth
query Parameters
offset
integer

Timezone offset in seconds for driver's local time

Responses

Response samples

Content type
application/json
Example
{
  • "tasks": [ ]
}

Read ongoing runsheets for a driver

Only driver is authorized.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "runsheets": [ ]
}

Read ongoing runsheets for an organization

Only transporter is authorized.

The list is ongoing runsheet that accepted by their team mate in an organization

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "runsheets": [ ]
}

Get list of driver earnings.

Only driver is authorized. data is filtered by driver.

Authorizations:
bearerAuth
query Parameters
range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Get list of past orders.

Only driver is authorized. data is filtered by driver id.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Get list of past orders for transporter.

Only transporter is authorized. data is filtered by transporter organization.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Platform Partners Read Tasks

Read tasks from platform partner's associated organizations. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

org_id
Array of strings

Array of Merchant IDs

broadcast_preference
string
Enum: "all" "squad" "marine"

To whom this will be broadcast/sent

group_tag
string

Group tag

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Platform Partners Create Tasks

Create multiple tasks from platform partners to associated organizations or own. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "You're not allowed to accept the task with this credentials."
}

Platform Partners Read Task Detail

Read tasks in detail from platform partner's associated organizations. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to get the detail

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Platform Partners Update an Existing Task

Update task details from plat. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
tracking_id
string
platform_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

version_rev
required
string

Revision value of the record version

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "platform_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "version_rev": "0-xxxxxxxx",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Confirm multiple draft tasks so that ready to broadcast.

Platform Partners confirm draft to change its status to pending_broadcast.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "task_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners Patch Tasks Tracking IDs

Patch multiple task tracking_id

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Read Tasks

Read tasks from platform partner's user.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

is_platform_admin
required
boolean

Flag indicating if the user has platform administrator privileges.

is_general_user
required
boolean

Flag indicating if the user is a general user (non-admin within their org context).

current_status
Array of strings

Filter tasks by their current status. Provide multiple times (e.g., current_status=broadcasting&current_status=pending_pickup) or potentially comma-separated depending on server implementation.

task_id
string

Filter by a specific task ID.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "meta": {
    }
}

Platform Partners User Create Tasks

Create multiple tasks for the organization associated with the platform partner user's context. The system will automatically determine the organization based on the user's platform attributes. If the organization doesn't exist, it will be created.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to be created.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Read Task Detail

Read a specific task's details based on user's platform partnership context. Access control is determined by the X-Task-Access-Permission header:

  • ALLOW_ALL: No restrictions (within user's general role permissions).
  • ALLOW_PLATFORM_ORG: Allows access if the task belongs to the user's organization OR if the task's platform ID and platform org ID match the user's platform attributes.
  • ALLOW_USER: Allows access only if the task's user email matches the requesting user's email. Requires appropriate roles and platform attributes verified by middleware.
Authorizations:
bearerAuth
path Parameters
taskID
required
string <uuid>

ID of the task to retrieve details for.

header Parameters
X-Task-Access-Permission
required
string
Enum: "ALLOW_ALL" "ALLOW_PLATFORM_ORG" "ALLOW_USER"

Defines the permission level for accessing the task details.

Responses

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Confirm and Broadcast Multiple Draft Tasks with Tracking IDs

Confirms multiple draft tasks (changing their status to pending_broadcast) and patches their tracking_id in a single operation. Only Platform Partner's OrgAdmin is authorized. Returns the result for each task, including any failures.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to confirm and patch tracking IDs.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Create Multiple Tasks as Platform Partner Admin

Allows a Platform Partner Admin to create multiple tasks for a specified organization.

  • Each task must include a valid org_id and org_name.
  • The system validates the admin's token and ensures the user has the correct role.
  • If the organization does not exist, the request will fail with an error.
  • All tasks are validated before creation.
  • Returns the created tasks and the current server time upon success.
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to be created.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Batch Get Tasks

Retrieve multiple tasks by their IDs for platform partner users. Returns 200 if all found, 207 if partially found, 404 if none found, and 500 for internal errors.

Authorizations:
bearerAuth
Request Body schema: application/json
tasks_ids
required
Array of strings

List of task IDs to retrieve

Responses

Request samples

Content type
application/json
{
  • "tasks_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Cancel a Platform Partners User Task

Allows a Platform Partners User to cancel a task by providing a reason and the current version revision. If the task is assigned to a runsheet, the cancellation will also update the runsheet accordingly. Only authorized Platform Partners Users can access this endpoint.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

The ID of the task to cancel.

Request Body schema: application/json
reason
required
string

Reason for cancelling the task.

version_rev
required
string

Revision value of the record version.

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update a Platform Partners User Task

Allows a Platform Partners User to update a task's details. Only tasks in editable statuses (Draft, Pending Broadcast, Broadcasting, Accepted) can be updated. If the task is assigned to a runsheet, the update will also update the runsheet accordingly. Only authorized Platform Partners Users can access this endpoint.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

The ID of the task to update.

Request Body schema: application/json
tracking_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
required
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
required
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

version_rev
required
string

Revision value of the record version

is_qa
boolean

Is QA true or false

Array of objects (archived_attachments)
from_location_type
string
Enum: "land" "sea"

Type of the location for pickup

to_location_type
string
Enum: "land" "sea"

Type of the location for delivery

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "version_rev": "0-xxxxxxxx",
  • "is_qa": true,
  • "archived_attachments": [
    ],
  • "from_location_type": "land",
  • "to_location_type": "land",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Pricing

Update task price

Only SysAdmin is authorized. Can update currency and price for task with no runsheet. Can only update price for task with runsheet. Can't update price after assign to driver

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which currency and/or price needs to be updated

Request Body schema: application/json
currency
string
price
integer <int64> >= 0

Unit used is 1/1000 cents, is 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "currency": "string",
  • "price": 120000,
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update task admin fee

Only SysAdmin is authorized. Can update admin fee for task with no runsheet.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which admin fee needs to be updated

Request Body schema: application/json
currency
string
admin_fee
integer <int64> >= 0

Unit used is 1/1000 cents, is 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "currency": "string",
  • "admin_fee": 120000,
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Increment price for a task

Used by Price Adjustment worker via Runsheet Management. The task will be listed and sent to this endpoint. The response will be log in the runsheet Price Adjustment

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which price needs to be incremented

Request Body schema: application/json
attempt
required
number

Attempt for the increment

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "attempt": 1,
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Task Statuses

Set expire for a task

Only SysAdmin & Automation is authorized. Task can only be expired if its status is Broadcasting.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be expired

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Cancel a task

Only SysAdmin is authorized. Task can only be cancelled if its status is Pending Broadcast or Broadcasting.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be cancelled

Request Body schema: application/json
reason
required
string

Reason for cancelling the task

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update Task status from Accepted to Pending Pickup.

Only designated driver is authorized. Mark status as Pickup Arriving: Inform that the driver is nearby pickup location and is attempting order takeover. This can transition only from Accepted.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

org_transporter_id
string <uuid>
Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Inform that the driver is nearby pickup location.

Only designated driver is authorized. Mark status as Pickup Arriving: Inform that the driver is nearby pickup location and is attempting order takeover. This can transition only from Pending Pickup.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update task from draft to pending broadcast.

Only designated merchant is authorized. Mark status as Pending Broadcast.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
broadcast_preference
required
string
Enum: "marine" "squad" "all"
currency
required
string

The currency should follow the ISO4217 format.

min_price
required
number <int16>

Unit used is 1/1000 cents

max_price
required
number <int16>

Unit used is 1/1000 cents

increment
required
number <int16>

Unit used is 1/1000 cents

client_time_utc
required
string <date-time>
client_timezone
required
string

Responses

Request samples

Content type
application/json
{
  • "broadcast_preference": "marine",
  • "currency": "SGD",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Fail pickup of a task by driver

Only designated driver is authorized. Mark status as Unsuccessful Pickup: Driver has attempted to pickup the order but has failed to takeover the parcel from sender. This can transition only from Pending Pickup or Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Array of objects (attachment)
Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "attachments": [
    ],
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Complete pickup of a task by driver

Only designated driver is authorized. Mark status as Pending Delivery: Driver has picked up order and is on the way to delivery location. This can transition only from Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

actual_contact_name
string

Name of the person who pass the items to the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "I received 50 items",
  • "attachments": [
    ],
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Inform that the driver is nearby delivery location.

Only designated driver is authorized. Mark status as Delivery Arriving: Driver is nearby delivery location and is attempting order handover. This can transition only from Pending Delivery.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Fail delivery of a task by driver

Only designated driver is authorized. Mark status as Unsuccessful Delivery: Driver has attempted to deliver the order but has failed to handover the parcel to recipient. This can transition only from Pending Delivery or Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "remarks": "The customer did not receive the items",
  • "attachments": [
    ],
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Complete delivery of a task by driver

Only designated driver is authorized. Mark status as Complete. This can transition only from Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

actual_contact_name
string

Name of the person who receive the items from the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)
object (driver_location)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "The customer received the items",
  • "attachments": [
    ],
  • "custom_info": [
    ],
  • "driver_location": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Complete delivery of a task by sysAdmin

Only sysAdmin is authorized. Mark status as Complete. This can transition only from Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
org_id
required
string

Organization ID

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "org_id": "xxxx-xxx-xxxx",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Cancel a task

Only OrgAdmin is authorized. Task can only be cancelled if its status is Pending Broadcast or Broadcasting.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be cancelled

Request Body schema: application/json
reason
required
string

Reason for cancelling the task

version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & complete pickup of a task by sysAdmin

Only SysAdmin is authorized. Mark status as Pending Delivery: Task has picked up and is on the way to delivery location. This can transition only from Pending Pickup or Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

org_transporter_id
string <uuid>
actual_contact_name
string

Name of the person who pass the items to the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "I received 50 items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & fail pickup of a task by SysAdmin

Only SysAdmin is authorized. Mark status as Unsuccessful Pickup: Task has attempted to picked up but has failed to be takeover the parcel from sender. This can transition only from Pending Pickup or Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

org_transporter_id
string <uuid>
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & complete delivery of a task by SysAdmin

Only SysAdmin is authorized. Mark status as Complete. This can transition only from Pending Delivery or Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

org_transporter_id
string <uuid>
actual_contact_name
string

Name of the person who receive the items from the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "The customer received the items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & fail delivery of a task by SysAdmin

Only SysAdmin is authorized. Mark status as Unsuccessful Delivery: Task has attempted to deliver the order but has failed to be handover the parcel to recipient. This can transition only from Pending Delivery or Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

org_transporter_id
string <uuid>
remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "remarks": "The customer did not receive the items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & complete pickup of a task by Transporter Ops

Only Transporter Ops is authorized. Mark status as Pending Delivery: Task has picked up and is on the way to delivery location. This can transition only from Pending Pickup or Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

actual_contact_name
string

Name of the person who pass the items to the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "I received 50 items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & fail pickup of a task by Transporter Ops

Only Transporter Ops is authorized. Mark status as Unsuccessful Pickup: Task has attempted to picked up but has failed to be takeover the parcel from sender. This can transition only from Pending Pickup or Pickup Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & complete delivery of a task by Transporter Ops

Only Transporter Ops is authorized. Mark status as Complete. This can transition only from Pending Delivery or Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

actual_contact_name
string

Name of the person who receive the items from the driver

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "actual_contact_name": "John Doe",
  • "remarks": "The customer received the items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Arrive & fail delivery of a task by Transporter Ops

Only Transporter Ops is authorized. Mark status as Unsuccessful Delivery: Task has attempted to deliver the order but has failed to be handover the parcel to recipient. This can transition only from Pending Delivery or Delivery Arriving.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

remarks
string
Array of objects (attachment)
Array of objects (custom-info-result)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "remarks": "The customer did not receive the items",
  • "attachments": [
    ],
  • "custom_info": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Broadcasting

Broadcast the task

Only SysAdmin is authorized. Mark status as broadcasting: Order is being broadcasted to drivers and is pending for response.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task which status needs to be updated

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Broadcast all tasks with no runsheet from all organizations

Only SysAdmin is authorized. Only tasks with pickup start time later than or equal to 12 AM of today's date are broadcasted.

Authorizations:
bearerAuth
Request Body schema: application/json
is_qa
boolean

Responses

Request samples

Content type
application/json
{
  • "is_qa": true
}

Tasks

Get tasks by group tag ID

Retrieves all tasks associated with a specific group tag

Authorizations:
bearerAuth
path Parameters
groupTagID
required
string

ID of the group tag to retrieve tasks for

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

Task Item

Add items to an existing task

Should provide items summary which reflect the changes caused by the addition. This items summary will replace the old one.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
Array of objects (item)
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 0,
  • "total_quantity_unit": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update an existing item of existing task

Should provide items summary which reflect the changes caused by the update. This items summary will replace the old one.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

itemID
required
string

ID of the item to be modified

Request Body schema: application/json
object
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Delete an existing item of existing task

Should provide items summary which reflect the changes caused by the deletion. This items summary will replace the old one.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

itemID
required
string

ID of the item to be modified

Request Body schema: application/json
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 0,
  • "total_quantity_unit": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Task Attachment

Get presigned url of a file

Authorizations:
bearerAuth
path Parameters
taskID
required
string

Task ID needed to prevent URL wildcard error

query Parameters
filename
required
string
Example: filename=aa.png

File name with extension

Responses

Response samples

Content type
application/json
{
  • "signed_url": "string"
}

Delete presigned attachment on s3

Authorizations:
bearerAuth
path Parameters
taskID
required
string

Task ID needed to prevent URL wildcard error

query Parameters
filename
required
string
Example: filename=aa.png

File name with extension

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Add attachments to an existing task

Only OrgAdmin is authorized.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
Array of objects (attachment)
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Delete an existing attachment of existing task

Only OrgAdmin is authorized.

path Parameters
taskID
required
string

ID of the task to be modified

attachmentID
required
string

ID of the attachment to be deleted

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Assign Driver

Assign a runsheet to an existing task

Assign a runsheet to an existing task

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be assigned

Request Body schema: application/json
object (runsheet)
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "runsheet": {
    },
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version_rev": "0-xxxxxxxx"
}

Unassign a runsheet

If the runsheet is unassigned to begin with, will not render error

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be unassigned

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "message": "Successfully unassigned the runsheet"
}

Assign a driver to an existing task

Only sysAdmin is authorized. Mark status as Pending Pickup: Driver has accepted order and is on the way to pickup location.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

driver_id
required
string

Driver ID Assigned

driver_name
required
string

Driver Name Assigned

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "driver_id": "3casl-askajs-kajsk-xxxx",
  • "driver_name": "driver-name-xxx"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "driver": {
    },
  • "version_rev": "0-xxxxxxxx"
}

Assign a driver to an existing task

Only driver is authorized. Mark status as Pending Pickup: Driver has accepted order and is on the way to pickup location. This can transition only from Broadcasting.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "driver": {
    },
  • "version_rev": "0-xxxxxxxx"
}

Get assigned tasks for a driver.

Only driver is authorized.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "tasks": [ ]
}

Assign Transporter

Assign a transporter to an existing task

Only sysAdmin is authorized. Mark status as Pending Pickup: Transporter has accepted order and is on the way to pickup location.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

required
object (org_transporter)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "org_transporter": {
    },
  • "version_rev": "0-xxxxxxxx"
}

Assign transporter driver to a task

Only orgTransporter is authorized. Mark status as Pending Pickup: Transporter has accepted order and is on the way to pickup location.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

required
object (org_transporter)

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "org_transporter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "org_transporter": {
    },
  • "version_rev": "0-xxxxxxxx"
}

EPOD

Generate EPOD

Generating EPOD from complete task

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "task": {
    },
  • "status": "to_be_acknowledged",
  • "statuses": [
    ],
  • "version_seq": 1,
  • "version_rev": "v1",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "endorse": {
    },
  • "receiver": {
    },
  • "remarks": "string"
}

Endorse EPOD

endorsement for EPOD

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task

Request Body schema: application/json
version_rev
required
string

Revision value of the record version

status
required
string
Enum: "partially_complete" "declined" "complete"

Status of the EPOD

required
object (endorse)
required
object (receiver)
remarks
required
string

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-xxxxxxxx",
  • "status": "Complete",
  • "endorse": {
    },
  • "receiver": {
    },
  • "remarks": "Additional Remarks"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "task": {
    },
  • "status": "to_be_acknowledged",
  • "statuses": [
    ],
  • "version_seq": 1,
  • "version_rev": "v1",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "endorse": {
    },
  • "receiver": {
    },
  • "remarks": "string"
}

Get EPOD

Get EPOD details

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "task": {
    },
  • "status": "to_be_acknowledged",
  • "statuses": [
    ],
  • "version_seq": 1,
  • "version_rev": "v1",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "endorse": {
    },
  • "receiver": {
    },
  • "remarks": "string"
}

Cron

Get all available cron jobs

Get list available crons and last time cron was run

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto complete endrosement > 7 days

Manually run auto complete endorsement by system after > 7 days via API

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "ok",
  • "pending_epods_count": 5,
  • "successfully_processed_count": 5
}

Platform Partners

Platform Partners Read Tasks

Read tasks from platform partner's associated organizations. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

org_id
Array of strings

Array of Merchant IDs

broadcast_preference
string
Enum: "all" "squad" "marine"

To whom this will be broadcast/sent

group_tag
string

Group tag

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tasks": [
    ]
}

Platform Partners Create Tasks

Create multiple tasks from platform partners to associated organizations or own. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "You're not allowed to accept the task with this credentials."
}

Platform Partners Read Task Detail

Read tasks in detail from platform partner's associated organizations. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to get the detail

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Platform Partners Update an Existing Task

Update task details from plat. Only Platform Partner's OrgAdmin is authorized.

Authorizations:
bearerAuth
path Parameters
taskID
required
string

ID of the task to be modified

Request Body schema: application/json
tracking_id
string
platform_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

version_rev
required
string

Revision value of the record version

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "platform_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "version_rev": "0-xxxxxxxx",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Confirm multiple draft tasks so that ready to broadcast.

Platform Partners confirm draft to change its status to pending_broadcast.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "task_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners Patch Tasks Tracking IDs

Patch multiple task tracking_id

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Read Tasks

Read tasks from platform partner's user.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string

Range start (inclusive) of Created At

range_end_created_at
string

Range end (inclusive) of Created At

is_platform_admin
required
boolean

Flag indicating if the user has platform administrator privileges.

is_general_user
required
boolean

Flag indicating if the user is a general user (non-admin within their org context).

current_status
Array of strings

Filter tasks by their current status. Provide multiple times (e.g., current_status=broadcasting&current_status=pending_pickup) or potentially comma-separated depending on server implementation.

task_id
string

Filter by a specific task ID.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "meta": {
    }
}

Platform Partners User Create Tasks

Create multiple tasks for the organization associated with the platform partner user's context. The system will automatically determine the organization based on the user's platform attributes. If the organization doesn't exist, it will be created.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to be created.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Read Task Detail

Read a specific task's details based on user's platform partnership context. Access control is determined by the X-Task-Access-Permission header:

  • ALLOW_ALL: No restrictions (within user's general role permissions).
  • ALLOW_PLATFORM_ORG: Allows access if the task belongs to the user's organization OR if the task's platform ID and platform org ID match the user's platform attributes.
  • ALLOW_USER: Allows access only if the task's user email matches the requesting user's email. Requires appropriate roles and platform attributes verified by middleware.
Authorizations:
bearerAuth
path Parameters
taskID
required
string <uuid>

ID of the task to retrieve details for.

header Parameters
X-Task-Access-Permission
required
string
Enum: "ALLOW_ALL" "ALLOW_PLATFORM_ORG" "ALLOW_USER"

Defines the permission level for accessing the task details.

Responses

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Confirm and Broadcast Multiple Draft Tasks with Tracking IDs

Confirms multiple draft tasks (changing their status to pending_broadcast) and patches their tracking_id in a single operation. Only Platform Partner's OrgAdmin is authorized. Returns the result for each task, including any failures.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to confirm and patch tracking IDs.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Create Multiple Tasks as Platform Partner Admin

Allows a Platform Partner Admin to create multiple tasks for a specified organization.

  • Each task must include a valid org_id and org_name.
  • The system validates the admin's token and ensures the user has the correct role.
  • If the organization does not exist, the request will fail with an error.
  • All tasks are validated before creation.
  • Returns the created tasks and the current server time upon success.
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

List of tasks to be created.

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Platform Partners User Batch Get Tasks

Retrieve multiple tasks by their IDs for platform partner users. Returns 200 if all found, 207 if partially found, 404 if none found, and 500 for internal errors.

Authorizations:
bearerAuth
Request Body schema: application/json
tasks_ids
required
Array of strings

List of task IDs to retrieve

Responses

Request samples

Content type
application/json
{
  • "tasks_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Cancel a Platform Partners User Task

Allows a Platform Partners User to cancel a task by providing a reason and the current version revision. If the task is assigned to a runsheet, the cancellation will also update the runsheet accordingly. Only authorized Platform Partners Users can access this endpoint.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

The ID of the task to cancel.

Request Body schema: application/json
reason
required
string

Reason for cancelling the task.

version_rev
required
string

Revision value of the record version.

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "version_rev": "0-xxxxxxxx"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "total_item_weight": 0.67,
  • "total_weight_unit": "kg",
  • "total_item_volume": 2507.545,
  • "total_volume_unit": "cm^3",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "created_at": "2019-08-24T14:15:22Z",
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "attachments": [
    ],
  • "runsheet": {
    },
  • "driver": {
    },
  • "current_status": "pending_broadcast",
  • "current_status_info": {
    },
  • "statuses": [
    ],
  • "edit_locked": true,
  • "version_seq": 0,
  • "version_rev": "0-xxxxxxxx",
  • "org_id": "string",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "vehicle_preference": "ltl",
  • "service_type": "ltl",
  • "is_qa": true,
  • "is_urgent": true,
  • "vehicle_emissions_type": "ev",
  • "vehicle_emissions": {
    },
  • "epod": {
    }
}

Update a Platform Partners User Task

Allows a Platform Partners User to update a task's details. Only tasks in editable statuses (Draft, Pending Broadcast, Broadcasting, Accepted) can be updated. If the task is assigned to a runsheet, the update will also update the runsheet accordingly. Only authorized Platform Partners Users can access this endpoint.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

The ID of the task to update.

Request Body schema: application/json
tracking_id
string
invoice_number
string
object (address)
object (time_window)
object (contact)
object (address)
object (time_window)
object (contact)
object (officer_contact)
broadcast_preference
string
Enum: "marine" "squad" "all"
group_tag
string
pickup_note_to_driver
string
delivery_note_to_driver
string
cargo_net_quantity
integer <int32> >= 0
rigger_required
boolean

Is Rigger required for the task

price
integer <int64> >= 0

Unit used is 1/1000 cents, will be set as 0 if the currency is "". The example value (120000 = 120x1000) represents 120 cents.

currency
string

The currency should follow the ISO4217 format.

Array of objects (item)
Array of objects (cargo_detail)
org_id
required
string
total_item_weight
number <float>
total_weight_unit
string
total_item_volume
number <float>
total_volume_unit
string
total_item_quantity
number <int16>
total_quantity_unit
string
min_price
number <int16>

Unit used is 1/1000 cents

max_price
number <int16>

Unit used is 1/1000 cents

increment
number <int16>

Unit used is 1/1000 cents

admin_fee
number <int16>

Unit used is 1/1000 cents

client_time_utc
required
string <date-time>
client_timezone
string
vehicle_preference
string
Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_20ft" "lorry_24ft" "lorry_40ft"
service_type
string
Enum: "ftl" "ltl"

Charter a full truck (FTL) or Book only the truck space you need (LTL)

version_rev
required
string

Revision value of the record version

is_qa
boolean

Is QA true or false

Array of objects (archived_attachments)
from_location_type
string
Enum: "land" "sea"

Type of the location for pickup

to_location_type
string
Enum: "land" "sea"

Type of the location for delivery

object (task_epod)

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "string",
  • "invoice_number": "string",
  • "from_address": {
    },
  • "from_time_window": {
    },
  • "from_contact": {
    },
  • "to_address": {
    },
  • "to_time_window": {
    },
  • "to_contact": {
    },
  • "officer_contact": {
    },
  • "broadcast_preference": "marine",
  • "group_tag": "Tag example",
  • "pickup_note_to_driver": "Please pickup at 2pm",
  • "delivery_note_to_driver": "string",
  • "cargo_net_quantity": 4,
  • "rigger_required": true,
  • "price": 120000,
  • "currency": "SGD",
  • "items": [
    ],
  • "cargo_details": [
    ],
  • "org_id": "string",
  • "total_item_weight": 0,
  • "total_weight_unit": "string",
  • "total_item_volume": 0,
  • "total_volume_unit": "string",
  • "total_item_quantity": 1,
  • "total_quantity_unit": "lift",
  • "min_price": 500000,
  • "max_price": 1500000,
  • "increment": 100000,
  • "admin_fee": 20000,
  • "client_time_utc": "2019-08-24T14:15:22Z",
  • "client_timezone": "Asia/Singapore",
  • "vehicle_preference": "ltl",
  • "service_type": "ftl",
  • "version_rev": "0-xxxxxxxx",
  • "is_qa": true,
  • "archived_attachments": [
    ],
  • "from_location_type": "land",
  • "to_location_type": "land",
  • "epod": {
    }
}

Response samples

Content type
application/json
{
  • "task": {
    },
  • "server_time": "2019-08-24T14:15:22Z"
}

Vehicle

Get all vehicles

Retrieve the list of all vehicles.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "vehicles": [
    ],
  • "server_time": "2019-08-24T14:15:22Z"
}

Get a vehicle by ID

Retrieve a specific vehicle by its unique ID.

Authorizations:
bearerAuth
path Parameters
id
required
string

The unique ID of the vehicle to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "vehicle_type": "string",
  • "ice_fuel_consumption_rate": 0,
  • "ice_co2_emissions_factor": 0,
  • "ev_power_consumption_rate": 0,
  • "ev_co2_emissions_factor": 0,
  • "ice_carbon_emissions": 0,
  • "ev_carbon_emissions": 0,
  • "total_reductions_percent": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "server_time": "2024-10-03T08:52:31.365793+07:00"
}

Update vehicle information

Update the details of an existing vehicle.

Authorizations:
bearerAuth
path Parameters
id
required
string

The unique ID of the vehicle to update.

Request Body schema: application/json
ice_fuel_consumption_rate
required
number

Fuel consumption rate for ICE vehicles (in liters per kilometer).

ice_co2_emissions_factor
required
number

CO2 emissions factor for ICE vehicles (in grams per liter).

ev_power_consumption_rate
required
number

Power consumption rate for EVs (in kWh per kilometer).

ev_co2_emissions_factor
required
number

CO2 emissions factor for EVs (in grams per kWh).

Responses

Request samples

Content type
application/json
{
  • "ice_fuel_consumption_rate": 0,
  • "ice_co2_emissions_factor": 0,
  • "ev_power_consumption_rate": 0,
  • "ev_co2_emissions_factor": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "vehicle_type": "string",
  • "ice_fuel_consumption_rate": 0,
  • "ice_co2_emissions_factor": 0,
  • "ev_power_consumption_rate": 0,
  • "ev_co2_emissions_factor": 0,
  • "ice_carbon_emissions": 0,
  • "ev_carbon_emissions": 0,
  • "total_reductions_percent": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "server_time": "2024-10-03T08:52:31.365793+07:00"
}