Skip to content
/
Corporate booking event w...

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

Bookings (carrier allocation webhook)Webhook

Request

Webhook type: BOOKING

Overview

This webhook provides notifications of changes to bookings that have been allocated to a carrier. It provides the subscriber with the full Booking entity, and enables downstream processes such as reporting and tracking.

Trigger Conditions

This webhook is triggered when:

  • The booking is allocated to a carrier through the enterprise platform, either via manual assignment or automated workflow.
  • Any update is made to the booking through the enterprise environment whilst the carrier is allocated.
Bodyapplication/jsonrequired
agentobject(Agent)
idstring

The M2X internal booking id

externalReferencestring
externalNotestring
canceledboolean

Indicates whether the booking has been unallocated from the carrier. Note: This field does not reflect whether the booking itself has been canceled within the enterprise system. It only represents that the carrier is no longer assigned to the booking

completedboolean
acknowledgedboolean
tentativeboolean
statusstring
slaQualitynumber
slaStatusstring
awardCreatedstring or null(date-time)
requestCreatedstring(date-time)
updatedstring(date-time)
latestDeliveryTimestampstring(date-time)
earliestPickupTimestampstring(date-time)
fulfilmentsArray of objects
acceptanceStateobject or null
noPaymentboolean

Whether upon acceptance the carrier shall get a payment or not (e.g. freight forward)

Default false
noPriceboolean

Whether the booking is free of charge, no offer generated

Default false
carrierIdstring or null

The M2X carrier id for this booking

carrierExternalIdstring or null

External carrier id for this carrier

carrierNamestring or null

Carrier name for this job

corporateIdstring

The M2X corporate id for this booking

corporateNamestring

Corporate name for this booking

corporateSubaccountIdstring

The M2X corporate subaccount id for this booking

corporateSubaccountNamestring

Corporate subaccount name for this booking

corporateSubaccountIntegrationIdstring

The M2X corporate subaccount integration id for this booking

transportRequirementsIdstring

M2X internal tracking id for the product type

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
propertiesobject or null

A key value store containing custom properties

Default null
metadataobject or null(Metadata)
contentnull or (Content (object or null or object or null))
Any of:

The sub components of the product if present

null
quantitynumber

The product quantity

Default 0
productSpatialRequirementnumber or null

Total volume or area for the booking

Default null
productMassKgnumber or null

Total weight for the booking

Default null
productNetWeightKgnumber or null

Net weight for the booking

Default null
productTareWeightKgnumber or null

Tare weight for the booking

Default null
distanceKmnumber

The reference distance for the job

Default 0
sourceIdstring

The source of the booking

groupPricingStrategyGroupIdstring or null

Pricing group id

Default null
priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
offerStatusstring

The offer status

Default "None"
priceFafOffernumber or null

The FAF offered

Default null
priceTransportOffernumber or null

The transport price offered

Default null
fromLocationobject(CorporateLocation)
fromLocationDistrictstring
fromLocationDistrictIdstring or null
fromLocationRegionstring
fromDateAndTimeConstraintobject(DateAndTimeConstraint)
fromTimeWindowsArray of objects(TimeWindows)
fromLocationGroupobject(LocationGroup)
fromContactDetailsobject(ContactDetails)
toLocationobject(CorporateLocation)
toLocationDistrictstring
toLocationDistrictIdstring or null
toLocationRegionstring
toDateAndTimeConstraintobject(DateAndTimeConstraint)
toTimeWindowsArray of objects(TimeWindows)
toLocationGroupobject(LocationGroup)
toContactDetailsobject(ContactDetails)
masterBookingobject(BookingMasterBookingData)
exceptionFlagStatenull or ExceptionFlagState (object)
Any of:

Status of the Exception Flag Resolution action

null
application/json
{
  "agent": {
    "email": "string",
    "uid": "string",
    "phone": "string",
    "name": "string",
    "externalId": "string"
  },
  "id": "string",
  "externalReference": "string",
  "externalNote": "string",
  "canceled": true,
  "completed": true,
  "acknowledged": true,
  "tentative": true,
  "status": "string",
  "slaQuality": 0,
  "slaStatus": "string",
  "awardCreated": "2019-08-24T14:15:22Z",
  "requestCreated": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "latestDeliveryTimestamp": "2019-08-24T14:15:22Z",
  "earliestPickupTimestamp": "2019-08-24T14:15:22Z",
  "fulfilments": [
    { … }
  ],
  "acceptanceState": {
    "acceptanceDeadline": "2019-08-24T14:15:22Z",
    "actioned": "2019-08-24T14:15:22Z",
    "accepted": true,
    "acceptable": true,
    "declined": true,
    "declinable": true,
    "retractable": true
  },
  "noPayment": false,
  "noPrice": false,
  "carrierId": "string",
  "carrierExternalId": "string",
  "carrierName": "string",
  "corporateId": "string",
  "corporateName": "string",
  "corporateSubaccountId": "string",
  "corporateSubaccountName": "string",
  "corporateSubaccountIntegrationId": "string",
  "transportRequirementsId": "string",
  "productCode": null,
  "productCodeName": null,
  "productCodeExternalId": null,
  "properties": null,
  "metadata": null,
  "content": {},
  "quantity": 0,
  "productSpatialRequirement": null,
  "productMassKg": null,
  "productNetWeightKg": null,
  "productTareWeightKg": null,
  "distanceKm": 0,
  "sourceId": "string",
  "groupPricingStrategyGroupId": null,
  "priceTransport": null,
  "priceFaf": null,
  "offerStatus": "None",
  "priceFafOffer": null,
  "priceTransportOffer": null,
  "fromLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "locationOwnerId": "string",
    "locationVersion": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "fromLocationDistrict": "string",
  "fromLocationDistrictId": "string",
  "fromLocationRegion": "string",
  "fromDateAndTimeConstraint": {
    "date": "2019-08-24",
    "timezone": "Pacific/Auckland",
    "timeConstraint": {}
  },
  "fromTimeWindows": [
    { … }
  ],
  "fromLocationGroup": {
    "groupId": "string",
    "code": "C123",
    "externalId": "asd-asd-asd",
    "name": "string"
  },
  "fromContactDetails": {
    "email": "string",
    "phone": "string",
    "name": "string"
  },
  "toLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "locationOwnerId": "string",
    "locationVersion": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "toLocationDistrict": "string",
  "toLocationDistrictId": "string",
  "toLocationRegion": "string",
  "toDateAndTimeConstraint": {
    "date": "2019-08-24",
    "timezone": "Pacific/Auckland",
    "timeConstraint": {}
  },
  "toTimeWindows": [
    { … }
  ],
  "toLocationGroup": {
    "groupId": "string",
    "code": "C123",
    "externalId": "asd-asd-asd",
    "name": "string"
  },
  "toContactDetails": {
    "email": "string",
    "phone": "string",
    "name": "string"
  },
  "masterBooking": {
    "masterBookingId": "string",
    "type": "string",
    "shipmentId": "string",
    "transportMode": "string",
    "properties": null,
    "metadata": null,
    "containerNumber": "string",
    "containerSealNumber": "string",
    "shippingBookingReference": "string",
    "customerOrderNumber": "string",
    "salesOrderNumber": "string",
    "purchaseOrderNumber": "string",
    "shippingTemperature": 0,
    "specialInstructions": "string",
    "releaseNumber": "string",
    "feederVessel": "string",
    "feederVoyageNumber": "string",
    "oceanVessel": "string",
    "oceanVoyageNumber": "string",
    "shippingCarrier": "string",
    "dangerousGoods": true,
    "unNumber": "string",
    "activeRefrigeration": true,
    "ambientTimeHours": 0,
    "powerOffDateTime": "string",
    "vesselArrivalDateTime": "string",
    "vesselDepartureDateTime": "string",
    "packDate": "2019-08-24",
    "availableDate": "2019-08-24",
    "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
    "movementSequence": 0,
    "movementType": "string",
    "movementTotal": 0,
    "customerName": "string",
    "productType": "Bulk",
    "emptyReleaseNumber": "string",
    "shipCutOffDateTime": "2019-08-24T14:15:22Z",
    "commodityCode": "string",
    "commodityDescription": "string",
    "connectedMovements": { … }
  },
  "exceptionFlagState": {}
}

Responses

Webhook received successfully

Corporate booking event webhookWebhook

Request

webhook type: FACT

Overview

This webhook allows you to receive notifications when booking events are created or updated. This could be due to changes made in the carrier TMS, mobile app, or in external systems via the M2X API.

Possible event types are listed in the description of the event field of the payload.

Trigger Conditions

This webhook is triggered when:

  • A booking event is created or updated. See below for the list of possible events.
Bodyapplication/jsonrequired
idstring
canceledboolean
bookingIdstring
eventstring
Enum"load""unload""vehicleAssignment""pickup""pickupEta""gateIn""delivery""deliveryEta""gateOut""exceptionFlag"
versionstring or null
statusnull or string
Any of:
null
vehicleobject or null
timeWindowobject or null
notestring or null
referencestring or null
actualIdstring or null
deliveryReferencestring or null
truckReferencestring or null
flagReasonstring or null

For exception events, flagReason is populated with the reason of exception

resolutionReasonstring or null

Populated with comment made while clearing exception events

createdstring(date-time)
serverCreatedstring or null(date-time)
actualnull or BookingEventActual (object)
Any of:
null
attachmentsnull or Array of BookingEventAttachment (objects)
Any of:
null
application/json
{
  "id": "string",
  "canceled": true,
  "bookingId": "string",
  "event": "load",
  "version": "string",
  "status": {},
  "vehicle": {
    "vehicleName": "string",
    "vehicleId": "string",
    "vehicleExternalId": "string",
    "registration": "string",
    "vehicleType": "string",
    "weightClass": 0,
    "weightClassLabel": "string",
    "driverId": "string",
    "driverExternalId": "string",
    "driverName": "string"
  },
  "timeWindow": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "note": "string",
  "reference": "string",
  "actualId": "string",
  "deliveryReference": "string",
  "truckReference": "string",
  "flagReason": "string",
  "resolutionReason": "string",
  "created": "2019-08-24T14:15:22Z",
  "serverCreated": "2019-08-24T14:15:22Z",
  "actual": {},
  "attachments": {}
}

Responses

Webhook received successfully

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

Vehicle Execution Statements

Unit of execution for trucks

OperationsWebhooks

Consignments

Webhooks