Skip to content
/
DEPRECATED, use PUT inste...

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

DEPRECATED, use PUT instead - create new bookingDeprecated

Request

Security
M2X_auth_application
Bodyapplication/jsonrequired

Update for the booking

bookingobject(BookingRequest)
requestTimestampstring(date-time)

Request timestamp, useful to discard stale updates than were made offline and came online later

mappingRequestsobject(BookingMappingRequest)
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/bookings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "booking": {
      "agent": {
        "email": "string",
        "uid": "string",
        "phone": "string",
        "name": "string",
        "externalId": "string"
      },
      "externalReference": "string",
      "externalNote": "string",
      "carrierId": "string",
      "canceled": true,
      "completed": true,
      "quantity": 0,
      "noPayment": false,
      "noPrice": false,
      "properties": null,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "productNetWeightKg": null,
      "productTareWeightKg": null,
      "metadata": null,
      "fromLocation": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "fromDateAndTimeConstraint": {
        "date": "2019-08-24",
        "timezone": "Pacific/Auckland",
        "timeConstraint": {}
      },
      "fromTimeWindows": [
        {
          "start": 0,
          "end": 0
        }
      ],
      "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",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "toDateAndTimeConstraint": {
        "date": "2019-08-24",
        "timezone": "Pacific/Auckland",
        "timeConstraint": {}
      },
      "toTimeWindows": [
        {
          "start": 0,
          "end": 0
        }
      ],
      "toLocationGroup": {
        "groupId": "string",
        "code": "C123",
        "externalId": "asd-asd-asd",
        "name": "string"
      },
      "toContactDetails": {
        "email": "string",
        "phone": "string",
        "name": "string"
      }
    },
    "requestTimestamp": "2019-08-24T14:15:22Z",
    "mappingRequests": {
      "agent": {
        "externalId": "string"
      },
      "carrier": {
        "carrierExternalId": "string"
      },
      "content": null,
      "product": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "fromLocation": {
        "locationId": null,
        "addressText": null,
        "locationExternalId": null,
        "locationName": null,
        "latitude": 0,
        "longitude": 0,
        "saveIfUnknown": false,
        "locationNameResolutionEnabled": false,
        "useDefaultParentGroup": false,
        "parentGroupExternalId": null,
        "parentGroupName": null,
        "saveGroupIfUnknown": false
      },
      "fromLocationGroup": {
        "groupId": null,
        "externalId": null,
        "usePrimaryLocation": false,
        "subLocationExternalId": null
      },
      "toLocation": {
        "locationId": null,
        "addressText": null,
        "locationExternalId": null,
        "locationName": null,
        "latitude": 0,
        "longitude": 0,
        "saveIfUnknown": false,
        "locationNameResolutionEnabled": false,
        "useDefaultParentGroup": false,
        "parentGroupExternalId": null,
        "parentGroupName": null,
        "saveGroupIfUnknown": false
      },
      "toLocationGroup": {
        "groupId": null,
        "externalId": null,
        "usePrimaryLocation": false,
        "subLocationExternalId": null
      },
      "corporateSubaccount": {
        "corporateSubaccountId": "string",
        "corporateSubaccountIntegrationId": "string"
      }
    }
  }'

Responses

Successful Operation

Bodyapplication/json
batchIdstring
Example: "XYZ123"
idstring
Example: "ABC123-example-1737580145879"
Response
application/json
{
  "batchId": "XYZ123",
  "id": "ABC123-example-1737580145879"
}

DEPRECATED, use PUT instead - update/create bookings bulkDeprecated

Request

Security
M2X_auth_application
Bodyapplication/jsonArray [
idstringrequired
bookingobject(BookingRequest)required
booking.​agentobject(Agent)
booking.​externalReferencestring
booking.​externalNotestring
booking.​carrierIdstring

The M2X carrier id for this booking

booking.​canceledboolean
booking.​completedboolean
booking.​quantitynumber

The product quantity

Default 0
booking.​noPaymentboolean

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

Default false
booking.​noPriceboolean

Whether the booking is free of charge, no offer generated

Default false
booking.​propertiesobject or null(CustomProperties)
booking.​productSpatialRequirementnumber or null

Optional override for the volume

Default null
booking.​productMassKgnumber or null

Optional total weight override for the booking

Default null
booking.​productNetWeightKgnumber or null

Optional net weight override for the booking

Default null
booking.​productTareWeightKgnumber or null

Optional tare weight override for the booking

Default null
booking.​metadataobject or null(Metadata)
booking.​fromLocationobject(Location)
booking.​fromDateAndTimeConstraintobject(DateAndTimeConstraint)
booking.​fromTimeWindowsArray of objects(TimeWindows)
booking.​fromLocationGroupobject(LocationGroup)
booking.​fromContactDetailsobject(ContactDetails)
booking.​toLocationobject(Location)
booking.​toDateAndTimeConstraintobject(DateAndTimeConstraint)
booking.​toTimeWindowsArray of objects(TimeWindows)
booking.​toLocationGroupobject(LocationGroup)
booking.​toContactDetailsobject(ContactDetails)
requestTimestampstring(date-time)

Request timestamp, useful to discard stale updates than were made offline and came online later

mappingRequestsobject(BookingMappingRequest)required
mappingRequests.​agentobject
mappingRequests.​carrierobject
mappingRequests.​contentobject or null(ContentMappingRequest)
mappingRequests.​productobject(ProductMappingRequest)
mappingRequests.​fromLocationobject(LocationMappingRequest)
mappingRequests.​fromLocationGroupobject(LocationGroupMappingRequest)
mappingRequests.​toLocationobject(LocationMappingRequest)
mappingRequests.​toLocationGroupobject(LocationGroupMappingRequest)
mappingRequests.​corporateSubaccountobject(CorporateSubaccountMappingRequest)
cancelboolean
]
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/bookings/bulk \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "string",
      "booking": {
        "agent": {
          "email": "string",
          "uid": "string",
          "phone": "string",
          "name": "string",
          "externalId": "string"
        },
        "externalReference": "string",
        "externalNote": "string",
        "carrierId": "string",
        "canceled": true,
        "completed": true,
        "quantity": 0,
        "noPayment": false,
        "noPrice": false,
        "properties": null,
        "productSpatialRequirement": null,
        "productMassKg": null,
        "productNetWeightKg": null,
        "productTareWeightKg": null,
        "metadata": null,
        "fromLocation": {
          "addressText": "string",
          "latitude": 0,
          "longitude": 0,
          "locationName": "string",
          "locationId": "string",
          "externalId": "string",
          "timezone": "Pacific/Auckland",
          "properties": null
        },
        "fromDateAndTimeConstraint": {
          "date": "2019-08-24",
          "timezone": "Pacific/Auckland",
          "timeConstraint": {}
        },
        "fromTimeWindows": [
          {
            "start": 0,
            "end": 0
          }
        ],
        "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",
          "externalId": "string",
          "timezone": "Pacific/Auckland",
          "properties": null
        },
        "toDateAndTimeConstraint": {
          "date": "2019-08-24",
          "timezone": "Pacific/Auckland",
          "timeConstraint": {}
        },
        "toTimeWindows": [
          {
            "start": 0,
            "end": 0
          }
        ],
        "toLocationGroup": {
          "groupId": "string",
          "code": "C123",
          "externalId": "asd-asd-asd",
          "name": "string"
        },
        "toContactDetails": {
          "email": "string",
          "phone": "string",
          "name": "string"
        }
      },
      "requestTimestamp": "2019-08-24T14:15:22Z",
      "mappingRequests": {
        "agent": {
          "externalId": "string"
        },
        "carrier": {
          "carrierExternalId": "string"
        },
        "content": null,
        "product": {
          "productCode": null,
          "productCodeExternalId": null,
          "productDescription": null
        },
        "fromLocation": {
          "locationId": null,
          "addressText": null,
          "locationExternalId": null,
          "locationName": null,
          "latitude": 0,
          "longitude": 0,
          "saveIfUnknown": false,
          "locationNameResolutionEnabled": false,
          "useDefaultParentGroup": false,
          "parentGroupExternalId": null,
          "parentGroupName": null,
          "saveGroupIfUnknown": false
        },
        "fromLocationGroup": {
          "groupId": null,
          "externalId": null,
          "usePrimaryLocation": false,
          "subLocationExternalId": null
        },
        "toLocation": {
          "locationId": null,
          "addressText": null,
          "locationExternalId": null,
          "locationName": null,
          "latitude": 0,
          "longitude": 0,
          "saveIfUnknown": false,
          "locationNameResolutionEnabled": false,
          "useDefaultParentGroup": false,
          "parentGroupExternalId": null,
          "parentGroupName": null,
          "saveGroupIfUnknown": false
        },
        "toLocationGroup": {
          "groupId": null,
          "externalId": null,
          "usePrimaryLocation": false,
          "subLocationExternalId": null
        },
        "corporateSubaccount": {
          "corporateSubaccountId": "string",
          "corporateSubaccountIntegrationId": "string"
        }
      },
      "cancel": true
    }
  ]'

Responses

Successful operation

Bodyapplication/json
successboolean
Example: true
batchIdstring
Example: "ABC123"
Response
application/json
{
  "success": true,
  "batchId": "ABC123"
}

DEPRECATED, use PUT instead - create and event for a bookingDeprecated

Request

Security
M2X_auth_application
Path
bookingIdstringrequired

The booking Id

Bodyapplication/jsonrequired

Event

eventstring
Enum"load""unload"
statusstring
Enum"partial""completed"
notestring
referencestring
actualIdstring
createdstring(date-time)
actualobject
curl -i -X POST \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/bookings/{bookingId}/events' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "load",
    "status": "partial",
    "note": "string",
    "reference": "string",
    "actualId": "string",
    "created": "2019-08-24T14:15:22Z",
    "actual": {
      "quantity": 0,
      "properties": null,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "productNetWeightKg": null,
      "productTareWeightKg": null,
      "metadata": null,
      "product": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "content": null
    }
  }'

Responses

Successful operation

Response
No content

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