Skip to content
/
Create new offer

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

Locations

Locations information

Operations

Master Bookings

Master bookings

OperationsWebhooks

Offers

Corporate monetary offers to carriers

OperationsWebhooks

Get offers list

Request

Security
M2X_auth_application
Query
startstring(date-time)

RFC3339 date time start of the required interval, default to start of the week

endstring(date-time)

RFC3339 date time end of the required interval, default to end of the week

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

Responses

Successful operation

Bodyapplication/jsonArray [
idstring
referencesArray of strings
offerVersionstring
bookingIdstring
canceledboolean
carrierIdstring

The M2X carrier id for this offer

carrierExternalIdstring

External carrier ids for this carrier

carrierNamestring

Carrier name for this job

corporateIdstring

The M2X corporate id for this offer

corporateNamestring

Corporate name for this job

corporateSubaccountIdstring

The M2X corporate subaccount id for this offer

corporateSubaccountNamestring

Corporate subaccount name for this offer

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(CustomProperties)
productSpatialRequirementnumber or null

Total volume or area for the booking

Default null
productMassKgnumber or null

Total weight for the booking

Default null
contentArray of objects or null(Content)

The sub components of the product if present

quantitynumber

The product quantity

Default 0
noPaymentboolean

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

Default false
distanceKmnumber

The reference distance for the job

Default 0
sourceIdstring

The source of the offer

priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
priceStrategystring or null

The pricing strategy for the offer

Default null
Enum"Deferred""Fixed""Group""Precision""Provided"
priceTransportAdjustmentReasonsArray of strings
priceTransportAdjustmentnumber or null

The amount for the adjustment

Default null
fromLocationobject(Location)
fromLocationDistrictstring
fromLocationDistrictIdstring
fromLocationRegionstring
toLocationobject(Location)
toLocationDistrictstring
toLocationDistrictIdstring
toLocationRegionstring
transportTimestampstring(date-time)

RFC3339 date time of cart

settledboolean

Whether the offer is accepted by the carrier

queriedboolean

Whether the offer is being queried by the carrier

statusstring
Enum"Delivered""Queried""Accepted""Invoiced""Paid""Completed"
]
Response
application/json
[
  {
    "id": "string",
    "references": [ … ],
    "offerVersion": "string",
    "bookingId": "string",
    "canceled": true,
    "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,
    "productSpatialRequirement": null,
    "productMassKg": null,
    "content": [ … ],
    "quantity": 0,
    "noPayment": false,
    "distanceKm": 0,
    "sourceId": "string",
    "priceTransport": null,
    "priceFaf": null,
    "priceStrategy": "Deferred",
    "priceTransportAdjustmentReasons": [ … ],
    "priceTransportAdjustment": null,
    "fromLocation": { … },
    "fromLocationDistrict": "string",
    "fromLocationDistrictId": "string",
    "fromLocationRegion": "string",
    "toLocation": { … },
    "toLocationDistrict": "string",
    "toLocationDistrictId": "string",
    "toLocationRegion": "string",
    "transportTimestamp": "2019-08-24T14:15:22Z",
    "settled": true,
    "queried": true,
    "status": "Delivered"
  }
]

Create new offer

Request

Security
M2X_auth_application
Bodyapplication/jsonrequired

Update for the booking

offerobject(OfferRequest)
mappingRequestsobject(OfferMappingRequest)
cancelboolean
settledboolean
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/offers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offer": {
      "references": [
        "string"
      ],
      "offerVersion": "string",
      "bookingId": "string",
      "carrierId": "string",
      "quantity": 0,
      "properties": null,
      "noPayment": false,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "metadata": null,
      "priceTransport": null,
      "priceFaf": null,
      "fromLocation": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "toLocation": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "transportTimestamp": "2019-08-24T14:15:22Z"
    },
    "mappingRequests": {
      "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
      }
    },
    "cancel": true,
    "settled": true
  }'

Responses

Successful operation

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

Find offer by ID

Request

Security
M2X_auth_application
Path
offerIdstringrequired

The offer Id

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

Responses

Successful operation

Bodyapplication/jsonArray [
idstring
referencesArray of strings
offerVersionstring
bookingIdstring
canceledboolean
carrierIdstring

The M2X carrier id for this offer

carrierExternalIdstring

External carrier ids for this carrier

carrierNamestring

Carrier name for this job

corporateIdstring

The M2X corporate id for this offer

corporateNamestring

Corporate name for this job

corporateSubaccountIdstring

The M2X corporate subaccount id for this offer

corporateSubaccountNamestring

Corporate subaccount name for this offer

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(CustomProperties)
productSpatialRequirementnumber or null

Total volume or area for the booking

Default null
productMassKgnumber or null

Total weight for the booking

Default null
contentArray of objects or null(Content)

The sub components of the product if present

quantitynumber

The product quantity

Default 0
noPaymentboolean

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

Default false
distanceKmnumber

The reference distance for the job

Default 0
sourceIdstring

The source of the offer

priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
priceStrategystring or null

The pricing strategy for the offer

Default null
Enum"Deferred""Fixed""Group""Precision""Provided"
priceTransportAdjustmentReasonsArray of strings
priceTransportAdjustmentnumber or null

The amount for the adjustment

Default null
fromLocationobject(Location)
fromLocationDistrictstring
fromLocationDistrictIdstring
fromLocationRegionstring
toLocationobject(Location)
toLocationDistrictstring
toLocationDistrictIdstring
toLocationRegionstring
transportTimestampstring(date-time)

RFC3339 date time of cart

settledboolean

Whether the offer is accepted by the carrier

queriedboolean

Whether the offer is being queried by the carrier

statusstring
Enum"Delivered""Queried""Accepted""Invoiced""Paid""Completed"
]
Response
application/json
[
  {
    "id": "string",
    "references": [ … ],
    "offerVersion": "string",
    "bookingId": "string",
    "canceled": true,
    "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,
    "productSpatialRequirement": null,
    "productMassKg": null,
    "content": [ … ],
    "quantity": 0,
    "noPayment": false,
    "distanceKm": 0,
    "sourceId": "string",
    "priceTransport": null,
    "priceFaf": null,
    "priceStrategy": "Deferred",
    "priceTransportAdjustmentReasons": [ … ],
    "priceTransportAdjustment": null,
    "fromLocation": { … },
    "fromLocationDistrict": "string",
    "fromLocationDistrictId": "string",
    "fromLocationRegion": "string",
    "toLocation": { … },
    "toLocationDistrict": "string",
    "toLocationDistrictId": "string",
    "toLocationRegion": "string",
    "transportTimestamp": "2019-08-24T14:15:22Z",
    "settled": true,
    "queried": true,
    "status": "Delivered"
  }
]

Update/create offer by ID

Request

Security
M2X_auth_application
Path
offerIdstringrequired

The offer Id

Bodyapplication/jsonrequired

Update for the offer

offerobject(OfferRequest)
mappingRequestsobject(OfferMappingRequest)
cancelboolean
settledboolean
curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/offers/{offerId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offer": {
      "references": [
        "string"
      ],
      "offerVersion": "string",
      "bookingId": "string",
      "carrierId": "string",
      "quantity": 0,
      "properties": null,
      "noPayment": false,
      "productSpatialRequirement": null,
      "productMassKg": null,
      "metadata": null,
      "priceTransport": null,
      "priceFaf": null,
      "fromLocation": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "toLocation": {
        "addressText": "string",
        "latitude": 0,
        "longitude": 0,
        "locationName": "string",
        "locationId": "string",
        "externalId": "string",
        "timezone": "Pacific/Auckland",
        "properties": null
      },
      "transportTimestamp": "2019-08-24T14:15:22Z"
    },
    "mappingRequests": {
      "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
      }
    },
    "cancel": true,
    "settled": true
  }'

Responses

Successful Operation

Bodyapplication/json
batchIdstring
Example: "XYZ123"
Response
application/json
{
  "batchId": "XYZ123"
}

Delete offer by ID

Request

Security
M2X_auth_application
Path
offerIdstringrequired

The offer Id

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

Responses

Successful Operation

Bodyapplication/json
batchIdstring
Example: "XYZ123"
Response
application/json
{
  "batchId": "XYZ123"
}

Update/create offers bulk

Request

Security
M2X_auth_application
Bodyapplication/jsonArray [
idstringrequired
offerobject(OfferRequest)required
offer.​referencesArray of strings
offer.​offerVersionstring
offer.​bookingIdstring
offer.​carrierIdstring

The M2X carrier id for this offer

offer.​quantitynumber

The product quantity

Default 0
offer.​propertiesobject or null(CustomProperties)
offer.​noPaymentboolean

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

Default false
offer.​productSpatialRequirementnumber or null

Optional override for the volume

Default null
offer.​productMassKgnumber or null

Optional total weight override for the booking

Default null
offer.​metadataobject or null(Metadata)
offer.​priceTransportnumber or null

The allocated transport price

Default null
offer.​priceFafnumber or null

The allocated FAF

Default null
offer.​fromLocationobject(Location)
offer.​toLocationobject(Location)
offer.​transportTimestampstring(date-time)

RFC3339 date time of cart

mappingRequestsobject(OfferMappingRequest)required
mappingRequests.​carrierobject
mappingRequests.​contentobject or null(ContentMappingRequest)
mappingRequests.​productobject(ProductMappingRequest)
mappingRequests.​fromLocationobject(LocationMappingRequest)
mappingRequests.​fromLocationGroupobject(LocationGroupMappingRequest)
mappingRequests.​toLocationobject(LocationMappingRequest)
mappingRequests.​toLocationGroupobject(LocationGroupMappingRequest)
cancelboolean
settledboolean
]
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/offers/bulk \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "string",
      "offer": {
        "references": [
          "string"
        ],
        "offerVersion": "string",
        "bookingId": "string",
        "carrierId": "string",
        "quantity": 0,
        "properties": null,
        "noPayment": false,
        "productSpatialRequirement": null,
        "productMassKg": null,
        "metadata": null,
        "priceTransport": null,
        "priceFaf": null,
        "fromLocation": {
          "addressText": "string",
          "latitude": 0,
          "longitude": 0,
          "locationName": "string",
          "locationId": "string",
          "externalId": "string",
          "timezone": "Pacific/Auckland",
          "properties": null
        },
        "toLocation": {
          "addressText": "string",
          "latitude": 0,
          "longitude": 0,
          "locationName": "string",
          "locationId": "string",
          "externalId": "string",
          "timezone": "Pacific/Auckland",
          "properties": null
        },
        "transportTimestamp": "2019-08-24T14:15:22Z"
      },
      "mappingRequests": {
        "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
        }
      },
      "cancel": true,
      "settled": true
    }
  ]'

Responses

Successful operation

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

Offer webhookWebhook

Request

webhook type: OFFER

Bodyapplication/jsonrequired
idstring
referencesArray of strings
offerVersionstring
bookingIdstring
canceledboolean
carrierIdstring

The M2X carrier id for this offer

carrierExternalIdstring

External carrier ids for this carrier

carrierNamestring

Carrier name for this job

corporateIdstring

The M2X corporate id for this offer

corporateNamestring

Corporate name for this job

corporateSubaccountIdstring

The M2X corporate subaccount id for this offer

corporateSubaccountNamestring

Corporate subaccount name for this offer

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(CustomProperties)
productSpatialRequirementnumber or null

Total volume or area for the booking

Default null
productMassKgnumber or null

Total weight for the booking

Default null
contentArray of objects or null(Content)

The sub components of the product if present

quantitynumber

The product quantity

Default 0
noPaymentboolean

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

Default false
distanceKmnumber

The reference distance for the job

Default 0
sourceIdstring

The source of the offer

priceTransportnumber or null

The allocated transport price

Default null
priceFafnumber or null

The allocated FAF

Default null
priceStrategystring or null

The pricing strategy for the offer

Default null
Enum"Deferred""Fixed""Group""Precision""Provided"
priceTransportAdjustmentReasonsArray of strings
priceTransportAdjustmentnumber or null

The amount for the adjustment

Default null
fromLocationobject(Location)
fromLocationDistrictstring
fromLocationDistrictIdstring
fromLocationRegionstring
toLocationobject(Location)
toLocationDistrictstring
toLocationDistrictIdstring
toLocationRegionstring
transportTimestampstring(date-time)

RFC3339 date time of cart

settledboolean

Whether the offer is accepted by the carrier

queriedboolean

Whether the offer is being queried by the carrier

statusstring
Enum"Delivered""Queried""Accepted""Invoiced""Paid""Completed"
application/json
{
  "id": "string",
  "references": [
    "string"
  ],
  "offerVersion": "string",
  "bookingId": "string",
  "canceled": true,
  "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,
  "productSpatialRequirement": null,
  "productMassKg": null,
  "content": [
    null
  ],
  "quantity": 0,
  "noPayment": false,
  "distanceKm": 0,
  "sourceId": "string",
  "priceTransport": null,
  "priceFaf": null,
  "priceStrategy": "Deferred",
  "priceTransportAdjustmentReasons": [
    "string"
  ],
  "priceTransportAdjustment": null,
  "fromLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "fromLocationDistrict": "string",
  "fromLocationDistrictId": "string",
  "fromLocationRegion": "string",
  "toLocation": {
    "addressText": "string",
    "latitude": 0,
    "longitude": 0,
    "locationName": "string",
    "locationId": "string",
    "externalId": "string",
    "timezone": "Pacific/Auckland",
    "properties": null
  },
  "toLocationDistrict": "string",
  "toLocationDistrictId": "string",
  "toLocationRegion": "string",
  "transportTimestamp": "2019-08-24T14:15:22Z",
  "settled": true,
  "queried": true,
  "status": "Delivered"
}

Responses

Webhook received successfully

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