Skip to content
/
Shift publication webhook

M2X APIS (1.0.0)

M2X APIs

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
All Rights Reserved
Languages
Servers
Mock server
https://developer.m2x.app/_mock/apis/publicapi/openapi/
https://developer.m2x.app/apis/v0/
NZ Production server (uses live data)
https://m2x.app/apis/v0/
US Production server (uses live data)
https://us.m2x.app/apis/v0/
AUS Production server (uses live data)
https://au.m2x.app/apis/v0/
Sandbox server
https://staging.m2x.app/apis/v0/

Analytics

Analytics data

Operations

Billing Groups

Invoiceable unit used by the system

Operations

Bookings

Bookings information

Operations

Carrier Bookings

Corporate bookings received by carriers

Operations

Carrier Large Contracts

Carrier large contracts

Operations

Carrier Orders

Carrier orders

Operations

Corporate Planning

Corporate Planning supplies and demands

Operations

Customer Bookings

Customer bookings on carriers

Operations

Customers

Customers used for invoices

Operations

Drivers

Drivers information

Operations

Fuel

Fuel deliveries management

Operations

Fulfilment Requests

Fulfilment request on carriers

OperationsWebhooks

General Consignments

General consignments

Operations

ISO containers

ISO containers information

Operations

Jobs

Vehicle units of work

OperationsWebhooks

Locations

Locations information

Operations

Master Bookings

Master bookings

OperationsWebhooks

Offers

Corporate monetary offers to carriers

OperationsWebhooks

Products

Products used by the system

Operations

Runs

Runs management

Operations

Subcontractors

Subcontractors information

Operations

Tractor Unit

Tractor units information

Operations

Trailer

Trailers information

Operations

Transaction

Transaction management

Operations

Vehicle

Vehicles information

Operations

Set the next active task for a vehicle

Request

Security
M2X_auth_application
Path
vehicleIdstringrequired

The vehicle ID

Bodyapplication/jsonrequired

Vehicle active task request

taskIdstringrequired

The task ID to set as active for the vehicle. Must be a task that is assigned to the vehicle and not already complete.

timestampinteger(int64)required

Epoch timestamp (seconds since 1970) of the update

namestring or null

The name of the user responsible for this action, if applicable

Default null
curl -i -X POST \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/vehicles/{vehicleId}/activeTask' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "taskId": "string",
    "timestamp": 0,
    "name": null
  }'

Responses

Successful Operation

Bodyapplication/json
successboolean
Example: true
Response
application/json
{
  "success": true
}

Shift publication webhookWebhook

Request

webhook type: SHIFT_PUBLICATION

Bodyapplication/jsonrequired
shiftIdstringrequired
tasksArray of MovingTaskProperties (object) or CustomerTaskProperties (object) or ServiceTaskProperties (object)(Task)required
One of:
tasks[].​distanceAndDurationobject

Task execution details

tasks[].​locationobject(Task Location)
tasks[].​eventualLocationnull or Location (object)
Any of:
null
tasks[].​idstring
tasks[].​taskIdstring
tasks[].​vehicleIdstring
tasks[].​vehicleExternalIdstring
tasks[].​vehiclePropertiesobject
tasks[].​deletedboolean
Default false
tasks[].​completeboolean

Indicate wether or not the task has been completed

Default false
tasks[].​propertiesobject or null

Collection of bespoke properties

Default null
tasks[].​shiftMetadataobject(ShiftMetadata)
tasks[].​assetsobject(ExecutionAssets)
tasks[].​typestring
Enum"START""DELIVERY""PICKUP""END"
application/json
{
  "shiftId": "string",
  "tasks": [
    { … }
  ]
}

Responses

Webhook received successfully

Service day publication webhookWebhook

Request

webhook type: SERVICE_DAY_PUBLICATION

Bodyapplication/jsonrequiredArray [
shiftIdstringrequired
tasksArray of MovingTaskProperties (object) or CustomerTaskProperties (object) or ServiceTaskProperties (object)(Task)required
One of:
tasks[].​distanceAndDurationobject

Task execution details

tasks[].​locationobject(Task Location)
tasks[].​eventualLocationnull or Location (object)
Any of:
null
tasks[].​idstring
tasks[].​taskIdstring
tasks[].​vehicleIdstring
tasks[].​vehicleExternalIdstring
tasks[].​vehiclePropertiesobject
tasks[].​deletedboolean
Default false
tasks[].​completeboolean

Indicate wether or not the task has been completed

Default false
tasks[].​propertiesobject or null

Collection of bespoke properties

Default null
tasks[].​shiftMetadataobject(ShiftMetadata)
tasks[].​assetsobject(ExecutionAssets)
tasks[].​typestring
Enum"START""DELIVERY""PICKUP""END"
]
application/json
[
  {
    "shiftId": "string",
    "tasks": [ … ]
  }
]

Responses

Webhook received successfully

Vehicle Execution Statements

Unit of execution for trucks

OperationsWebhooks

Consignments

Webhooks