Skip to content
/
Query pickups

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

Reads Delivery

Request

Security
M2X_auth_application
Path
deliveryIdstringrequired

The unique delivery Id

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

Responses

Successful operation

Bodyapplication/json
idstring
Example: "D001"
constraintIdstring or null
Example: "D001"
externalIdstring or null
dispatchGroupIdstring or null
Example: "ABC1123-asdasdasd-123213"
deletedboolean
vehicleIdstring
Example: "D001"
vehicleExternalIdstring or null
Any of:
string
driverFuelDriver (object) or null
Any of:
object FuelDriver Recursive
locationobject(JobLocation)
productsArray of objects(DynamicFulfilmentProduct)
shiftMetadataobject(ShiftMetadata)
actualobject or null
Response
application/json
{
  "id": "D001",
  "constraintId": "D001",
  "externalId": "string",
  "dispatchGroupId": "ABC1123-asdasdasd-123213",
  "deleted": true,
  "vehicleId": "D001",
  "vehicleExternalId": "string",
  "driver": {
    "id": "string",
    "name": "string",
    "externalId": "string"
  },
  "location": {
    "locationKind": "Farm",
    "shortName": "Dreamy Farm",
    "areaName": "Mystery Creek",
    "facilityName": "Main Yards",
    "addressText": "Main Yards",
    "latitude": 0,
    "longitude": 0,
    "externalId": "string",
    "inboundIntegrationIds": [ … ],
    "disabled": false,
    "onHold": false,
    "customer": null,
    "mobile": "+33 123",
    "phone": "+33 123",
    "email": "asd@asd.asd",
    "hazards": "string",
    "notes": "string",
    "properties": null,
    "requirements": null,
    "restrictions": null,
    "metadata": null,
    "readonlyFields": { … },
    "accessLatitude": null,
    "accessLongitude": null,
    "maxIncomingWeight": null,
    "maxOutgoingWeight": null,
    "minIncomingWeight": null,
    "minOutgoingWeight": null,
    "offRoadDistance": null,
    "offRoadDuration": null,
    "waitTime": null,
    "contactName": null,
    "contactNotes": null,
    "dairySupplyGeneration": null,
    "geofenceType": "Circular",
    "polygonGeofence": "POLYGON ((-105.0105 39.7617,-105.0108 39.7614,-105.0111 39.7616,-105.0105 39.7617))",
    "radius": 300,
    "geofenceAlerting": null,
    "gtnCaptureRequiredPickup": "MANDATORY",
    "gtnCaptureRequiredDelivery": "MANDATORY",
    "openingHours": {},
    "weeklySupplyGeneration": { … },
    "id": "D001",
    "updated": "2019-08-24T14:15:22Z"
  },
  "products": [
    { … }
  ],
  "shiftMetadata": {
    "serviceDay": "2019-08-24",
    "shiftId": "string",
    "totalShifts": 0,
    "shiftIndex": 0
  },
  "actual": {
    "inboundInventory": { … },
    "outboundInventory": { … },
    "vehicleId": "D001",
    "truckReference": "D001",
    "timestamp": "2019-08-24T14:15:22Z",
    "products": [ … ],
    "interactionsTransactions": [ … ],
    "storagesMeasurements": [ … ],
    "odometerDistanceKm": 0
  }
}

Query pickups

Request

Security
M2X_auth_application
Query
startstring(date)required

Start of the queried interval (YYYY-MM-DD)

endstring(date)required

End of the queried interval (YYYY-MM-DD)

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/fuel/pickups?start=2019-08-24&end=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
idstring
Example: "D001"
constraintIdstring or null
Example: "D001"
externalIdstring or null
dispatchGroupIdstring or null
Example: "ABC1123-asdasdasd-123213"
deletedboolean
vehicleIdstring
Example: "D001"
vehicleExternalIdstring or null
Any of:
string
driverFuelDriver (object) or null
Any of:
object FuelDriver Recursive
locationobject(JobLocation)
productsArray of objects(DynamicFulfilmentProduct)
shiftMetadataobject(ShiftMetadata)
actualobject or null
]
Response
application/json
[
  {
    "id": "D001",
    "constraintId": "D001",
    "externalId": "string",
    "dispatchGroupId": "ABC1123-asdasdasd-123213",
    "deleted": true,
    "vehicleId": "D001",
    "vehicleExternalId": "string",
    "driver": { … },
    "location": { … },
    "products": [ … ],
    "shiftMetadata": { … },
    "actual": { … }
  }
]

Query pickups

Request

Security
M2X_auth_application
Query
startstring(date)required

Start of the queried interval (YYYY-MM-DD)

endstring(date)required

End of the queried interval (YYYY-MM-DD)

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/fuel/inventoryAdjustments?start=2019-08-24&end=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
idstring
Example: "D001"
constraintIdstring or null
Example: "D001"
dispatchGroupIdstring or null
Example: "ABC1123-asdasdasd-123213"
deletedboolean
vehicleIdstring
Example: "D001"
vehicleExternalIdstring or null
driverFuelDriver (object) or null
Any of:
object FuelDriver Recursive
shiftMetadataobject(ShiftMetadata)
reasonCodeobject or null
Any of:
timestampstring or null(date-time)
actualobject
]
Response
application/json
[
  {
    "id": "D001",
    "constraintId": "D001",
    "dispatchGroupId": "ABC1123-asdasdasd-123213",
    "deleted": true,
    "vehicleId": "D001",
    "vehicleExternalId": "string",
    "driver": { … },
    "shiftMetadata": { … },
    "reasonCode": { … },
    "timestamp": "2019-08-24T14:15:22Z",
    "actual": { … }
  }
]

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