Skip to content
/
Job 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

Find job by ID

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The job Id

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
idstring
shortNotestring
updatedstring(date-time)
createdstring(date-time)
deletedboolean
attachmentsArray of CarrierAttachmentBase (object)(CarrierAttachment)
bookedByobject(User)
updatedByobject(User)
reconciledByobject(User)
deletedByobject(User)
deliveryReferencestring

A reference added by the dispatcher

truckReferencestring

A reference added by the driver, e.g. docket number

senderReferencestring or null

A reference added by the dispatcher

receiverReferencestring or null

A reference added by the dispatcher

truckSenderReferencestring or null

A reference added by the driver at pickup, e.g. weighbridge docket number

truckReceiverReferencestring or null

A reference added by the driver at delivery, e.g. weighbridge docket number

truckPickupBoLReferencestring or null

A Bill of Lading reference added by the driver at pickup, e.g. Bill of Lading number

truckDeliveryBoLReferencestring or null

A Bill of Lading reference added by the driver at delivery, e.g. Bill of Lading number

pickupDistanceReadingKmnumber or null
deliveryDistanceReadingKmnumber or null
distanceReadingDeltaKmnumber or null

The odometer distance difference between pickup and delivery

pickupEngineHoursReadingnumber or null
deliveryEngineHoursReadingnumber or null
engineReadingDeltaHoursnumber or null

The engine hours difference between pickup and delivery

externalIdstring
orderIdstring
orderFriendlyNamestring
bookingIdstring

If the job is linked to a corporate booking, the bookingId

customerIdstring

The M2X customer id for this job

customerExternalIdstring

External customer id for this job

customerIntegrationIdstring

Customer integration id for this job

customerNamestring

Customer name for this job

billingGroupIdstring

Billing Group for this job

humanReadableIdstring

Human Readable Id for this Billing group

billingGroupStatusstring

Billing Group status for this job

pickupLocationobject(Location)
pickupRegionsobject(JobRegions)
taskPickupTimestampstring(date-time)

RFC3339 date time of the pickup

taskStartPickupTimestampstring(date-time)

RFC3339 date time of arrival at the pickup site

taskEndPickupTimestampstring(date-time)

RFC3339 date time of departure from the pickup site

deliveryLocationobject(Location)
deliveryRegionsobject(JobRegions)
taskDeliveryTimestampstring(date-time)

RFC3339 date time of the delivery

taskStartDeliveryTimestampstring(date-time)

RFC3339 date time of arrival at the delivery site

taskEndDeliveryTimestampstring(date-time)

RFC3339 date time of departure from the delivery site

dispatchHubobject

If the job was created from dispatch hub, the associated details

dynamicFulfilmentobject

If the job was created from dynamic fulfilment, the associated details

vehicleIdstring
vehicleExternalIdstring
vehiclePropertiesobject
assetsobject(ExecutionAssets)
subcontractorIdstring
subcontractorExternalIdstring
subcontractorPropertiesobject
transportRequirementsIdstring

M2X internal tracking id for the product type

divisionstring or null

The division of the job (e.g. bulk, general, livestock...)

Default null
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeNamestring or null

M2X name for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productPropertiesobject
productComponentsArray of objects(ProductComponent)

The sub components of the product if present

propertiesobject or null

A key value store containing custom properties

Default null
quantitynumber

The product quantity

Default 0
distanceKmnumber

The reference distance for the job

Default 0
precisionPricenumber or null

The precision price for the job

Default null
precisionTkmnumber or null

The precision tonne km for the job

Default null
precisionKmnumber or null

The precision price for the job

Default null
precisionHrnumber or null

The precision Hr for the job

Default null
statusstring
Enum"Booked""Started""Delivered""Accepted"
invoicableboolean

Whether the job is invoiceable or not

Default false
priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
podLinkstring or null

The link to the track and trace POC link

Default null
pocLinkstring or null

The link to the track and trace POD link

Default null
podobject

Task completion details, e.g. proof of delivery

bookedobject
docketMeasurementPropertiesobject or null

A key value store containing docket measurement properties

Default null
cancellationNotesstring or null

Notes for the job cancellation

Default null
cancellationReasonstring or null

Reason for the job cancellation

Default null
pickupTimestampintegerDeprecated

Epoch timestamp (seconds since 1970) of the pickup

deliveryTimestampintegerDeprecated

Epoch timestamp (seconds since 1970) of the delivery

Response
application/json
{
  "id": "string",
  "shortNote": "string",
  "updated": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "deleted": true,
  "attachments": [
    { … }
  ],
  "bookedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "updatedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "reconciledBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "deletedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "deliveryReference": "string",
  "truckReference": "string",
  "senderReference": "string",
  "receiverReference": "string",
  "truckSenderReference": "string",
  "truckReceiverReference": "string",
  "truckPickupBoLReference": "string",
  "truckDeliveryBoLReference": "string",
  "pickupDistanceReadingKm": 0,
  "deliveryDistanceReadingKm": 0,
  "distanceReadingDeltaKm": 0,
  "pickupEngineHoursReading": 0,
  "deliveryEngineHoursReading": 0,
  "engineReadingDeltaHours": 0,
  "externalId": "string",
  "orderId": "string",
  "orderFriendlyName": "string",
  "bookingId": "string",
  "customerId": "string",
  "customerExternalId": "string",
  "customerIntegrationId": "string",
  "customerName": "string",
  "billingGroupId": "string",
  "humanReadableId": "string",
  "billingGroupStatus": "string",
  "pickupLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "pickupRegions": {
    "dispatchRegionIds": [ … ]
  },
  "pickupTimestamp": 0,
  "taskPickupTimestamp": "2019-08-24T14:15:22Z",
  "taskStartPickupTimestamp": "2019-08-24T14:15:22Z",
  "taskEndPickupTimestamp": "2019-08-24T14:15:22Z",
  "deliveryLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "deliveryRegions": {
    "dispatchRegionIds": [ … ]
  },
  "deliveryTimestamp": 0,
  "taskDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "taskStartDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "taskEndDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "dispatchHub": {
    "activityId": "string",
    "workId": "string",
    "type": "string",
    "subtypes": [ … ]
  },
  "dynamicFulfilment": {
    "shiftId": "string",
    "serviceDay": "2019-08-24",
    "pickupTaskId": "string",
    "pickupConstraintId": "string",
    "deliveryTaskId": "string",
    "deliveryConstraintId": "string",
    "dispatchGroupId": "string"
  },
  "vehicleId": "string",
  "vehicleExternalId": "string",
  "vehicleProperties": {},
  "assets": {
    "driver": { … },
    "tractorUnit": { … },
    "trailers": [ … ],
    "miscAssets": [ … ],
    "isoContainers": [ … ]
  },
  "subcontractorId": "string",
  "subcontractorExternalId": "string",
  "subcontractorProperties": {},
  "transportRequirementsId": "string",
  "division": null,
  "productCode": null,
  "productCodeName": null,
  "productCodeExternalId": null,
  "productProperties": {},
  "productComponents": [
    { … }
  ],
  "properties": null,
  "quantity": 0,
  "distanceKm": 0,
  "precisionPrice": null,
  "precisionTkm": null,
  "precisionKm": null,
  "precisionHr": null,
  "status": "Booked",
  "invoicable": false,
  "priceTransport": null,
  "priceFaf": null,
  "podLink": null,
  "pocLink": null,
  "pod": {
    "pickup": { … },
    "delivery": { … }
  },
  "booked": {
    "pickupLocation": { … },
    "pickupTimestamp": 0,
    "deliveryLocation": { … },
    "deliveryTimestamp": 0,
    "vehicleId": "string",
    "productId": "string",
    "productCode": null,
    "quantity": 0,
    "distanceKm": 0
  },
  "docketMeasurementProperties": null,
  "cancellationNotes": null,
  "cancellationReason": null
}

Find job attachment by ID

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The job Id

attachmentIdstringrequired

The Attachment Id

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/attachment/{attachmentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/octet-stream
string(binary)
Response
No content

Get tasks associated with job

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The job Id

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/tasks' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
shiftIdstring
tasksArray of MovingTaskProperties (object) or CustomerTaskProperties (object) or ServiceTaskProperties (object)(Task)
]
Response
application/json
[
  {
    "shiftId": "string",
    "tasks": [ … ]
  }
]

Get all action step records associated with the job

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The job Id

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/actionStepRecords' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
actionStepRecordIdstringrequired

uid for this exact instance of step action record

Example: "i8rmqV1wDDg5OkAK1F43"
stepIdstringrequired

Step identifier for action associated with record

Example: "weighbridgePreAdvise"
stepTypestringrequired

Step type for action associated with record

Enum"DECLARATION""EVENT"
Example: "EVENT"
timestampstring(date-time)required

RFC3339 date time of step being actioned

Example: "2023-08-10T00:12:19.000+00:00"
actionedByobjectrequired

Detail on the entity that actioned the step

actionedBy.​uidstringrequired

M2X user identifier

Example: "57dbfdcfaff5f6ba545583b2e03ee1e1-E01FA786-AC09-42EC-9697-02F17EC727F8"
actionedBy.​namestring or null

Human readable name of entity, e.g. Driver's name

Example: "John Doe"
actionedBy.​rolestring or null

Role of entity

Example: "driver"
actionedBy.​vehicleIdstring or null

M2X vehicle Id associated with tracking device that actioned the step

Example: "5o6aiI6prkBXRprUmkTy"
actionedBy.​vehicleLocationobject(VehicleLocation)
taskIdstring or null

Task associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0_qlDbkYdQDd3vcsET8nGQ_pickup"
jobIdstring or null

Job associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0"
transportOrderIdstring or null

Order associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653"
bookingIdstring or null

Booking associated with step action

Example: "FIN158-qlDbkYdQDd3vcsET8nGQ-1679540523856"
shiftIdstring or null

Shift associated with step action

Example: "qlDbkYdQDd3vcsET8nGQ-5o6aiI6prkBXRprUmkTy_2023-08-01_0"
]
Response
application/json
[
  {
    "actionStepRecordId": "i8rmqV1wDDg5OkAK1F43",
    "stepId": "weighbridgePreAdvise",
    "stepType": "EVENT",
    "timestamp": "2023-08-10T00:12:19.000+00:00",
    "actionedBy": { … },
    "taskId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0_qlDbkYdQDd3vcsET8nGQ_pickup",
    "jobId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0",
    "transportOrderId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653",
    "bookingId": "FIN158-qlDbkYdQDd3vcsET8nGQ-1679540523856",
    "shiftId": "qlDbkYdQDd3vcsET8nGQ-5o6aiI6prkBXRprUmkTy_2023-08-01_0"
  }
]

Upsert job note

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The job Id

noteIdstringrequired

The unique note identifier

Bodyapplication/json
notesstring
curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/notes/{noteId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "notes": "string"
  }'

Responses

Successful operation

Bodytext/plain
string
Response
No content

Get the weighbridge measurement for a given job ID and measurement ID

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The unique job identifier

measurementIdstringrequired

The unique measurement identifier

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/measurements/weighbridge/{measurementId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful request

Bodyapplication/json
unitstringrequired

What unit the weight values are in

Enum"kilogram""tonne""pound""ton"
netWeightnumberrequired

The net weight of the contents of the truck

grossWeightnumber

The gross weight of the contents of the truck

tareWeightnumber

The tare weight of the contents of the truck

timestampnumber

The timestamp that the measurement took place in Unix time

metadataobject or null

Opaque weighbridge key-value measurement data

propertiesobject or null

Optional weighbridge key-value measurement properties that may be used in eDockets

Response
application/json
{
  "unit": "kilogram",
  "netWeight": 0,
  "grossWeight": 0,
  "tareWeight": 0,
  "timestamp": 0,
  "metadata": {},
  "properties": {}
}

Create (or edit) the weighbridge measurement for a given job ID and measurement ID

Request

Security
M2X_auth_application
Path
jobIdstringrequired

The unique job identifier

measurementIdstringrequired

The unique measurement identifier

Bodyapplication/json
unitstringrequired

What unit the weight values are in

Enum"kilogram""tonne""pound""ton"
netWeightnumberrequired

The net weight of the contents of the truck

grossWeightnumber

The gross weight of the contents of the truck

tareWeightnumber

The tare weight of the contents of the truck

timestampnumber

The timestamp that the measurement took place in Unix time

metadataobject or null

Opaque weighbridge key-value measurement data

propertiesobject or null

Optional weighbridge key-value measurement properties that may be used in eDockets

curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/jobs/{jobId}/measurements/weighbridge/{measurementId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "unit": "tonne",
    "netWeight": 31000,
    "tareWeight": 10000,
    "grossWeight": 41000
  }'

Responses

Weighbridge measurement modified successfully

Bodyapplication/json
unitstringrequired

What unit the weight values are in

Enum"kilogram""tonne""pound""ton"
netWeightnumberrequired

The net weight of the contents of the truck

grossWeightnumber

The gross weight of the contents of the truck

tareWeightnumber

The tare weight of the contents of the truck

timestampnumber

The timestamp that the measurement took place in Unix time

metadataobject or null

Opaque weighbridge key-value measurement data

propertiesobject or null

Optional weighbridge key-value measurement properties that may be used in eDockets

Response
application/json
{
  "unit": "tonne",
  "netWeight": 31000,
  "tareWeight": 10000,
  "grossWeight": 41000
}

Job webhookWebhook

Request

webhook type: JOB

Bodyapplication/jsonrequired
idstring
shortNotestring
updatedstring(date-time)
createdstring(date-time)
deletedboolean
attachmentsArray of CarrierAttachmentBase (object)(CarrierAttachment)
bookedByobject(User)
updatedByobject(User)
reconciledByobject(User)
deletedByobject(User)
deliveryReferencestring

A reference added by the dispatcher

truckReferencestring

A reference added by the driver, e.g. docket number

senderReferencestring or null

A reference added by the dispatcher

receiverReferencestring or null

A reference added by the dispatcher

truckSenderReferencestring or null

A reference added by the driver at pickup, e.g. weighbridge docket number

truckReceiverReferencestring or null

A reference added by the driver at delivery, e.g. weighbridge docket number

truckPickupBoLReferencestring or null

A Bill of Lading reference added by the driver at pickup, e.g. Bill of Lading number

truckDeliveryBoLReferencestring or null

A Bill of Lading reference added by the driver at delivery, e.g. Bill of Lading number

pickupDistanceReadingKmnumber or null
deliveryDistanceReadingKmnumber or null
distanceReadingDeltaKmnumber or null

The odometer distance difference between pickup and delivery

pickupEngineHoursReadingnumber or null
deliveryEngineHoursReadingnumber or null
engineReadingDeltaHoursnumber or null

The engine hours difference between pickup and delivery

externalIdstring
orderIdstring
orderFriendlyNamestring
bookingIdstring

If the job is linked to a corporate booking, the bookingId

customerIdstring

The M2X customer id for this job

customerExternalIdstring

External customer id for this job

customerIntegrationIdstring

Customer integration id for this job

customerNamestring

Customer name for this job

billingGroupIdstring

Billing Group for this job

humanReadableIdstring

Human Readable Id for this Billing group

billingGroupStatusstring

Billing Group status for this job

pickupLocationobject(Location)
pickupRegionsobject(JobRegions)
taskPickupTimestampstring(date-time)

RFC3339 date time of the pickup

taskStartPickupTimestampstring(date-time)

RFC3339 date time of arrival at the pickup site

taskEndPickupTimestampstring(date-time)

RFC3339 date time of departure from the pickup site

deliveryLocationobject(Location)
deliveryRegionsobject(JobRegions)
taskDeliveryTimestampstring(date-time)

RFC3339 date time of the delivery

taskStartDeliveryTimestampstring(date-time)

RFC3339 date time of arrival at the delivery site

taskEndDeliveryTimestampstring(date-time)

RFC3339 date time of departure from the delivery site

dispatchHubobject

If the job was created from dispatch hub, the associated details

dynamicFulfilmentobject

If the job was created from dynamic fulfilment, the associated details

vehicleIdstring
vehicleExternalIdstring
vehiclePropertiesobject
assetsobject(ExecutionAssets)
subcontractorIdstring
subcontractorExternalIdstring
subcontractorPropertiesobject
transportRequirementsIdstring

M2X internal tracking id for the product type

divisionstring or null

The division of the job (e.g. bulk, general, livestock...)

Default null
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeNamestring or null

M2X name for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productPropertiesobject
productComponentsArray of objects(ProductComponent)

The sub components of the product if present

propertiesobject or null

A key value store containing custom properties

Default null
quantitynumber

The product quantity

Default 0
distanceKmnumber

The reference distance for the job

Default 0
precisionPricenumber or null

The precision price for the job

Default null
precisionTkmnumber or null

The precision tonne km for the job

Default null
precisionKmnumber or null

The precision price for the job

Default null
precisionHrnumber or null

The precision Hr for the job

Default null
statusstring
Enum"Booked""Started""Delivered""Accepted"
invoicableboolean

Whether the job is invoiceable or not

Default false
priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
podLinkstring or null

The link to the track and trace POC link

Default null
pocLinkstring or null

The link to the track and trace POD link

Default null
podobject

Task completion details, e.g. proof of delivery

bookedobject
docketMeasurementPropertiesobject or null

A key value store containing docket measurement properties

Default null
cancellationNotesstring or null

Notes for the job cancellation

Default null
cancellationReasonstring or null

Reason for the job cancellation

Default null
pickupTimestampintegerDeprecated

Epoch timestamp (seconds since 1970) of the pickup

deliveryTimestampintegerDeprecated

Epoch timestamp (seconds since 1970) of the delivery

application/json
{
  "id": "string",
  "shortNote": "string",
  "updated": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "deleted": true,
  "attachments": [
    { … }
  ],
  "bookedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "updatedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "reconciledBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "deletedBy": {
    "uid": "string",
    "email": "string",
    "name": "string"
  },
  "deliveryReference": "string",
  "truckReference": "string",
  "senderReference": "string",
  "receiverReference": "string",
  "truckSenderReference": "string",
  "truckReceiverReference": "string",
  "truckPickupBoLReference": "string",
  "truckDeliveryBoLReference": "string",
  "pickupDistanceReadingKm": 0,
  "deliveryDistanceReadingKm": 0,
  "distanceReadingDeltaKm": 0,
  "pickupEngineHoursReading": 0,
  "deliveryEngineHoursReading": 0,
  "engineReadingDeltaHours": 0,
  "externalId": "string",
  "orderId": "string",
  "orderFriendlyName": "string",
  "bookingId": "string",
  "customerId": "string",
  "customerExternalId": "string",
  "customerIntegrationId": "string",
  "customerName": "string",
  "billingGroupId": "string",
  "humanReadableId": "string",
  "billingGroupStatus": "string",
  "pickupLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "pickupRegions": {
    "dispatchRegionIds": [ … ]
  },
  "pickupTimestamp": 0,
  "taskPickupTimestamp": "2019-08-24T14:15:22Z",
  "taskStartPickupTimestamp": "2019-08-24T14:15:22Z",
  "taskEndPickupTimestamp": "2019-08-24T14:15:22Z",
  "deliveryLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "deliveryRegions": {
    "dispatchRegionIds": [ … ]
  },
  "deliveryTimestamp": 0,
  "taskDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "taskStartDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "taskEndDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "dispatchHub": {
    "activityId": "string",
    "workId": "string",
    "type": "string",
    "subtypes": [ … ]
  },
  "dynamicFulfilment": {
    "shiftId": "string",
    "serviceDay": "2019-08-24",
    "pickupTaskId": "string",
    "pickupConstraintId": "string",
    "deliveryTaskId": "string",
    "deliveryConstraintId": "string",
    "dispatchGroupId": "string"
  },
  "vehicleId": "string",
  "vehicleExternalId": "string",
  "vehicleProperties": {},
  "assets": {
    "driver": { … },
    "tractorUnit": { … },
    "trailers": [ … ],
    "miscAssets": [ … ],
    "isoContainers": [ … ]
  },
  "subcontractorId": "string",
  "subcontractorExternalId": "string",
  "subcontractorProperties": {},
  "transportRequirementsId": "string",
  "division": null,
  "productCode": null,
  "productCodeName": null,
  "productCodeExternalId": null,
  "productProperties": {},
  "productComponents": [
    { … }
  ],
  "properties": null,
  "quantity": 0,
  "distanceKm": 0,
  "precisionPrice": null,
  "precisionTkm": null,
  "precisionKm": null,
  "precisionHr": null,
  "status": "Booked",
  "invoicable": false,
  "priceTransport": null,
  "priceFaf": null,
  "podLink": null,
  "pocLink": null,
  "pod": {
    "pickup": { … },
    "delivery": { … }
  },
  "booked": {
    "pickupLocation": { … },
    "pickupTimestamp": 0,
    "deliveryLocation": { … },
    "deliveryTimestamp": 0,
    "vehicleId": "string",
    "productId": "string",
    "productCode": null,
    "quantity": 0,
    "distanceKm": 0
  },
  "docketMeasurementProperties": null,
  "cancellationNotes": null,
  "cancellationReason": null
}

Responses

Webhook received successfully

Action step record webhookWebhook

Request

webhook type: ACTION_STEP_RECORDS

Bodyapplication/jsonrequired
actionStepRecordIdstringrequired

uid for this exact instance of step action record

Example: "i8rmqV1wDDg5OkAK1F43"
stepIdstringrequired

Step identifier for action associated with record

Example: "weighbridgePreAdvise"
stepTypestringrequired

Step type for action associated with record

Enum"DECLARATION""EVENT"
Example: "EVENT"
timestampstring(date-time)required

RFC3339 date time of step being actioned

Example: "2023-08-10T00:12:19.000+00:00"
actionedByobjectrequired

Detail on the entity that actioned the step

actionedBy.​uidstringrequired

M2X user identifier

Example: "57dbfdcfaff5f6ba545583b2e03ee1e1-E01FA786-AC09-42EC-9697-02F17EC727F8"
actionedBy.​namestring or null

Human readable name of entity, e.g. Driver's name

Example: "John Doe"
actionedBy.​rolestring or null

Role of entity

Example: "driver"
actionedBy.​vehicleIdstring or null

M2X vehicle Id associated with tracking device that actioned the step

Example: "5o6aiI6prkBXRprUmkTy"
actionedBy.​vehicleLocationobject(VehicleLocation)
taskIdstring or null

Task associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0_qlDbkYdQDd3vcsET8nGQ_pickup"
jobIdstring or null

Job associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0"
transportOrderIdstring or null

Order associated with step action

Example: "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653"
bookingIdstring or null

Booking associated with step action

Example: "FIN158-qlDbkYdQDd3vcsET8nGQ-1679540523856"
shiftIdstring or null

Shift associated with step action

Example: "qlDbkYdQDd3vcsET8nGQ-5o6aiI6prkBXRprUmkTy_2023-08-01_0"
application/json
{
  "actionStepRecordId": "i8rmqV1wDDg5OkAK1F43",
  "stepId": "weighbridgePreAdvise",
  "stepType": "EVENT",
  "timestamp": "2023-08-10T00:12:19.000+00:00",
  "actionedBy": {
    "uid": "57dbfdcfaff5f6ba545583b2e03ee1e1-E01FA786-AC09-42EC-9697-02F17EC727F8",
    "name": "John Doe",
    "role": "driver",
    "vehicleId": "5o6aiI6prkBXRprUmkTy",
    "vehicleLocation": { … }
  },
  "taskId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0_qlDbkYdQDd3vcsET8nGQ_pickup",
  "jobId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653_0",
  "transportOrderId": "IIX572-qlDbkYdQDd3vcsET8nGQ-1690861908653",
  "bookingId": "FIN158-qlDbkYdQDd3vcsET8nGQ-1679540523856",
  "shiftId": "qlDbkYdQDd3vcsET8nGQ-5o6aiI6prkBXRprUmkTy_2023-08-01_0"
}

Responses

Webhook received successfully

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

Vehicle Execution Statements

Unit of execution for trucks

OperationsWebhooks

Consignments

Webhooks