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

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

Get all products

Request

Security
M2X_auth_application
curl -i -X GET \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestring or null

Friendly name of the product code

Default null
productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsnull or Array of ProductComponent (objects)
Any of:
null
propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
]
Response
application/json
[
  {
    "transportRequirementsId": "",
    "productCode": null,
    "productCodeExternalId": null,
    "productCodeName": null,
    "productInvoiceName": null,
    "productComponents": {},
    "properties": null,
    "disabled": false,
    "customDimensions": false,
    "customDimensionsDensity": null,
    "customDimensionsLength": null,
    "customDimensionsWidth": null,
    "customDimensionsHeight": null,
    "customDimensionsWeightPerUnit": null,
    "customFixedLoadingTime": 0,
    "customFixedUnloadingTime": null,
    "customLoadingTimePerUnit": null,
    "customUnloadingTimePerUnit": null,
    "customDimensionsUnitsPerLift": null,
    "gtnCaptureEnabled": false,
    "isMix": false,
    "mixWrapperOnly": false,
    "mixContentOnly": false,
    "dispatcherCanSpecifyMix": false,
    "dispatcherCanSpecifyDimensions": false
  }
]

Create new product

Request

Security
M2X_auth_application
Bodyapplication/json
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestringrequired

Friendly name of the product code

productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsArray of objects(ProductComponentRequest)

The sub components of the product if present

propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transportRequirementsId": "",
    "productCodeExternalId": null,
    "productCodeName": "string",
    "productInvoiceName": null,
    "productComponents": [
      {
        "proportion": 0,
        "product": {
          "productCode": "string"
        }
      }
    ],
    "properties": null,
    "disabled": false,
    "customDimensions": false,
    "customDimensionsDensity": null,
    "customDimensionsLength": null,
    "customDimensionsWidth": null,
    "customDimensionsHeight": null,
    "customDimensionsWeightPerUnit": null,
    "customFixedLoadingTime": 0,
    "customFixedUnloadingTime": null,
    "customLoadingTimePerUnit": null,
    "customUnloadingTimePerUnit": null,
    "customDimensionsUnitsPerLift": null,
    "gtnCaptureEnabled": false,
    "isMix": false,
    "mixWrapperOnly": false,
    "mixContentOnly": false,
    "dispatcherCanSpecifyMix": false,
    "dispatcherCanSpecifyDimensions": false
  }'

Responses

Successful operation

Bodyapplication/json
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestring or null

Friendly name of the product code

Default null
productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsnull or Array of ProductComponent (objects)
Any of:
null
propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
Response
application/json
{
  "transportRequirementsId": "",
  "productCode": null,
  "productCodeExternalId": null,
  "productCodeName": null,
  "productInvoiceName": null,
  "productComponents": {},
  "properties": null,
  "disabled": false,
  "customDimensions": false,
  "customDimensionsDensity": null,
  "customDimensionsLength": null,
  "customDimensionsWidth": null,
  "customDimensionsHeight": null,
  "customDimensionsWeightPerUnit": null,
  "customFixedLoadingTime": 0,
  "customFixedUnloadingTime": null,
  "customLoadingTimePerUnit": null,
  "customUnloadingTimePerUnit": null,
  "customDimensionsUnitsPerLift": null,
  "gtnCaptureEnabled": false,
  "isMix": false,
  "mixWrapperOnly": false,
  "mixContentOnly": false,
  "dispatcherCanSpecifyMix": false,
  "dispatcherCanSpecifyDimensions": false
}

Get product by id

Request

Security
M2X_auth_application
Path
productCodeIdstringrequired

The product code Id

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

Responses

Successful operation

Bodyapplication/json
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestring or null

Friendly name of the product code

Default null
productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsnull or Array of ProductComponent (objects)
Any of:
null
propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
Response
application/json
{
  "transportRequirementsId": "",
  "productCode": null,
  "productCodeExternalId": null,
  "productCodeName": null,
  "productInvoiceName": null,
  "productComponents": {},
  "properties": null,
  "disabled": false,
  "customDimensions": false,
  "customDimensionsDensity": null,
  "customDimensionsLength": null,
  "customDimensionsWidth": null,
  "customDimensionsHeight": null,
  "customDimensionsWeightPerUnit": null,
  "customFixedLoadingTime": 0,
  "customFixedUnloadingTime": null,
  "customLoadingTimePerUnit": null,
  "customUnloadingTimePerUnit": null,
  "customDimensionsUnitsPerLift": null,
  "gtnCaptureEnabled": false,
  "isMix": false,
  "mixWrapperOnly": false,
  "mixContentOnly": false,
  "dispatcherCanSpecifyMix": false,
  "dispatcherCanSpecifyDimensions": false
}

Update/create product by id

Request

Security
M2X_auth_application
Path
productCodeIdstringrequired

The product code Id

Bodyapplication/json
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestringrequired

Friendly name of the product code

productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsArray of objects(ProductComponentRequest)

The sub components of the product if present

propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transportRequirementsId": "",
    "productCodeExternalId": null,
    "productCodeName": "string",
    "productInvoiceName": null,
    "productComponents": [
      {
        "proportion": 0,
        "product": {
          "productCode": "string"
        }
      }
    ],
    "properties": null,
    "disabled": false,
    "customDimensions": false,
    "customDimensionsDensity": null,
    "customDimensionsLength": null,
    "customDimensionsWidth": null,
    "customDimensionsHeight": null,
    "customDimensionsWeightPerUnit": null,
    "customFixedLoadingTime": 0,
    "customFixedUnloadingTime": null,
    "customLoadingTimePerUnit": null,
    "customUnloadingTimePerUnit": null,
    "customDimensionsUnitsPerLift": null,
    "gtnCaptureEnabled": false,
    "isMix": false,
    "mixWrapperOnly": false,
    "mixContentOnly": false,
    "dispatcherCanSpecifyMix": false,
    "dispatcherCanSpecifyDimensions": false
  }'

Responses

Successful operation

Bodyapplication/json
transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
productCodestring or null

M2X internal tracking id for the product code used

Default null
productCodeExternalIdstring or null

External Id for product tracking

Default null
productCodeNamestring or null

Friendly name of the product code

Default null
productInvoiceNamestring or null

Invoice name of the product code

Default null
productComponentsnull or Array of ProductComponent (objects)
Any of:
null
propertiesobject or null
Default null
disabledboolean

Whether the product is usable in the front end

Default false
customDimensionsboolean

Whether the product has any custom dimensions

Default false
customDimensionsDensitynumber or null

Product's custom density

Default null
customDimensionsLengthnumber or null

Product's custom length

Default null
customDimensionsWidthnumber or null

Product's custom width

Default null
customDimensionsHeightnumber or null

Product's custom height

Default null
customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
Response
application/json
{
  "transportRequirementsId": "",
  "productCode": null,
  "productCodeExternalId": null,
  "productCodeName": null,
  "productInvoiceName": null,
  "productComponents": {},
  "properties": null,
  "disabled": false,
  "customDimensions": false,
  "customDimensionsDensity": null,
  "customDimensionsLength": null,
  "customDimensionsWidth": null,
  "customDimensionsHeight": null,
  "customDimensionsWeightPerUnit": null,
  "customFixedLoadingTime": 0,
  "customFixedUnloadingTime": null,
  "customLoadingTimePerUnit": null,
  "customUnloadingTimePerUnit": null,
  "customDimensionsUnitsPerLift": null,
  "gtnCaptureEnabled": false,
  "isMix": false,
  "mixWrapperOnly": false,
  "mixContentOnly": false,
  "dispatcherCanSpecifyMix": false,
  "dispatcherCanSpecifyDimensions": false
}

Update/create products bulk

Request

Security
M2X_auth_application
Bodyapplication/jsonArray [
idstringrequired
productobject(ProductRequest)required
product.​transportRequirementsIdstring or null

M2X internal tracking id for the product type

Default ""
product.​productCodeExternalIdstring or null

External Id for product tracking

Default null
product.​productCodeNamestringrequired

Friendly name of the product code

product.​productInvoiceNamestring or null

Invoice name of the product code

Default null
product.​productComponentsArray of objects(ProductComponentRequest)

The sub components of the product if present

product.​propertiesobject or null
Default null
product.​disabledboolean

Whether the product is usable in the front end

Default false
product.​customDimensionsboolean

Whether the product has any custom dimensions

Default false
product.​customDimensionsDensitynumber or null

Product's custom density

Default null
product.​customDimensionsLengthnumber or null

Product's custom length

Default null
product.​customDimensionsWidthnumber or null

Product's custom width

Default null
product.​customDimensionsHeightnumber or null

Product's custom height

Default null
product.​customDimensionsWeightPerUnitnumber or null

Product's custom eight per unit

Default null
product.​customFixedLoadingTimenumber or null

Product's custom fixed unit loading time

product.​customFixedUnloadingTimenumber or null

Product's custom fixed unit unloading time

Default null
product.​customLoadingTimePerUnitnumber or null

Product's custom loading time per unit

Default null
product.​customUnloadingTimePerUnitnumber or null

Product's custom unloading time per unit

Default null
product.​customDimensionsUnitsPerLiftnumber or null

Product's custom units per lift

Default null
product.​gtnCaptureEnabledboolean

Enable Gross, Tare, Net input on driver mobile when weighbridge available at location

Default false
product.​isMixboolean

Whether or not the product is a mix of other products. This is inferred from the presence of product components, but can also be specified explicitly in the case that there are no default components. Must not be false when product components are specified (but can be omitted).

Default false
product.​mixWrapperOnlyboolean

Whether or not the product is usable only as a mix wrapper

Default false
product.​mixContentOnlyboolean

Whether or not the product is usable only as component in a product mix

Default false
product.​dispatcherCanSpecifyMixboolean

Whether or not the dispatcher can specify the components making up the product mix

Default false
product.​dispatcherCanSpecifyDimensionsboolean

Whether or not the dispatcher can specify the product dimensions

Default false
]
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/products/bulk \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "string",
      "product": {
        "transportRequirementsId": "",
        "productCodeExternalId": null,
        "productCodeName": "string",
        "productInvoiceName": null,
        "productComponents": [
          {
            "proportion": 0,
            "product": {
              "productCode": "string"
            }
          }
        ],
        "properties": null,
        "disabled": false,
        "customDimensions": false,
        "customDimensionsDensity": null,
        "customDimensionsLength": null,
        "customDimensionsWidth": null,
        "customDimensionsHeight": null,
        "customDimensionsWeightPerUnit": null,
        "customFixedLoadingTime": 0,
        "customFixedUnloadingTime": null,
        "customLoadingTimePerUnit": null,
        "customUnloadingTimePerUnit": null,
        "customDimensionsUnitsPerLift": null,
        "gtnCaptureEnabled": false,
        "isMix": false,
        "mixWrapperOnly": false,
        "mixContentOnly": false,
        "dispatcherCanSpecifyMix": false,
        "dispatcherCanSpecifyDimensions": false
      }
    }
  ]'

Responses

Successful operation

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

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