Skip to content

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

Update/create supply by ID

Request

Security
M2X_auth_application
Path
supplyIdstringrequired

The supply Id

Query
syncboolean

Whether mapping errors should be returned synchronously

reprocessIdstring

Used to retry a request that fail and clear the issues in the integration issues

Bodyapplication/jsonrequired

Update for the supply

supplyobject(CorporateNodeRequest)
requestTimestampstring(date-time)

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

mappingRequestsobject(CorporateNodeMappingRequest)
curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/corporatePlanning/supplies/{supplyId}?sync=true&reprocessId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "supply": {
      "agent": {
        "email": "string",
        "uid": "string",
        "phone": "string",
        "name": "string",
        "externalId": "string"
      },
      "externalReference": "string",
      "externalNote": "string",
      "quantity": 0,
      "properties": null,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "metadata": null,
      "location": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "locationGroup": {
        "groupId": "string",
        "code": "C123",
        "externalId": "asd-asd-asd",
        "name": "string"
      },
      "contactDetails": {
        "email": "string",
        "phone": "string",
        "name": "string"
      },
      "orderDay": "2019-08-24",
      "locationDate": "2019-08-24",
      "locationDateFlexibility": "AFTER"
    },
    "requestTimestamp": "2019-08-24T14:15:22Z",
    "mappingRequests": {
      "agent": {
        "externalId": "string"
      },
      "product": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "products": [
        {
          "productCode": null,
          "productCodeExternalId": null,
          "productDescription": null
        }
      ],
      "location": {
        "locationId": null,
        "addressText": null,
        "locationExternalId": null,
        "locationName": null,
        "latitude": 0,
        "longitude": 0,
        "saveIfUnknown": false,
        "locationNameResolutionEnabled": false,
        "useDefaultParentGroup": false,
        "parentGroupExternalId": null,
        "parentGroupName": null,
        "saveGroupIfUnknown": false
      },
      "locationGroup": {
        "groupId": null,
        "externalId": null,
        "usePrimaryLocation": false,
        "subLocationExternalId": null
      }
    }
  }'

Responses

Successful operation

Bodyapplication/json
batchIdstring
Example: "XYZ123"
idstring
Example: "ABC123"
reprocessIdstring
Example: "reprocess123"
Response
application/json
{
  "batchId": "XYZ123",
  "id": "ABC123",
  "reprocessId": "reprocess123"
}

Update/create demand by ID

Request

Security
M2X_auth_application
Path
demandIdstringrequired

The demand Id

Query
syncboolean

Whether mapping errors should be returned synchronously

reprocessIdstring

Used to retry a request that fail and clear the issues in the integration issues

Bodyapplication/jsonrequired

Update for the demand

demandobject(CorporateNodeRequest)
requestTimestampstring(date-time)

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

mappingRequestsobject(CorporateNodeMappingRequest)
curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/corporatePlanning/demands/{demandId}?sync=true&reprocessId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "demand": {
      "agent": {
        "email": "string",
        "uid": "string",
        "phone": "string",
        "name": "string",
        "externalId": "string"
      },
      "externalReference": "string",
      "externalNote": "string",
      "quantity": 0,
      "properties": null,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "metadata": null,
      "location": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "locationGroup": {
        "groupId": "string",
        "code": "C123",
        "externalId": "asd-asd-asd",
        "name": "string"
      },
      "contactDetails": {
        "email": "string",
        "phone": "string",
        "name": "string"
      },
      "orderDay": "2019-08-24",
      "locationDate": "2019-08-24",
      "locationDateFlexibility": "AFTER"
    },
    "requestTimestamp": "2019-08-24T14:15:22Z",
    "mappingRequests": {
      "agent": {
        "externalId": "string"
      },
      "product": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "products": [
        {
          "productCode": null,
          "productCodeExternalId": null,
          "productDescription": null
        }
      ],
      "location": {
        "locationId": null,
        "addressText": null,
        "locationExternalId": null,
        "locationName": null,
        "latitude": 0,
        "longitude": 0,
        "saveIfUnknown": false,
        "locationNameResolutionEnabled": false,
        "useDefaultParentGroup": false,
        "parentGroupExternalId": null,
        "parentGroupName": null,
        "saveGroupIfUnknown": false
      },
      "locationGroup": {
        "groupId": null,
        "externalId": null,
        "usePrimaryLocation": false,
        "subLocationExternalId": null
      }
    }
  }'

Responses

Successful operation

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

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