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

Get a master booking by id

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

Internal M2X master booking id

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

Responses

Successful operation

Bodyapplication/json
masterBookingIdstring
externalIdstring
shipmentIdstring
emptyReleaseNumberstring
releaseNumberstring
containerNumberstring
containerSealNumberstring
customerobject
recipientCustomerstring
shippingTemperaturenumber
actualPackTemperaturenumber
unNumberstring
commodityCodestring
commodityDescriptionstring
dangerousGoodsboolean
ambientTimeHoursnumber
activeRefrigerationboolean
powerOffDateTimestring
grossWeightKgnumber
netWeightKgnumber
tareWeightKgnumber
spatialRequirementnumber
salesOrderNumberstring
purchaseOrderNumberstring
customerOrderNumberstring
specialInstructionsstring
internalNotesstring
feederVesselstring
feederVoyageNumberstring
oceanVesselstring
oceanVoyageNumberstring
shippingCarrierstring
shippingBookingReferencestring
portOfDischargestring
destinationCountrystring
portOfDispatchstring
originCountrystring
productobject
bookingIdsArray of strings
keyWaypointsobject

contains a list of key waypoints

movementsArray of objects(MasterBookingMovement)
propertiesobject

A key value store containing custom properties

canceledboolean
createdByobject
createdstring
updatedstring
typestringrequired

The type of container transportation (export)

Discriminator
Value "EXPORT"
segmentsobject

Container movement segments for export operations (pre-movement and main movement only)

transportModestringDeprecated
Enum"COASTAL""RAIL""ROAD"
Response
application/json
{
  "transportMode": "COASTAL",
  "masterBookingId": "string",
  "externalId": "string",
  "shipmentId": "string",
  "emptyReleaseNumber": "string",
  "releaseNumber": "string",
  "containerNumber": "string",
  "containerSealNumber": "string",
  "customer": {
    "customerId": "string",
    "customerName": "string",
    "externalId": "string",
    "integrationId": "string"
  },
  "recipientCustomer": "string",
  "shippingTemperature": 0,
  "actualPackTemperature": 0,
  "unNumber": "string",
  "commodityCode": "string",
  "commodityDescription": "string",
  "dangerousGoods": true,
  "ambientTimeHours": 0,
  "activeRefrigeration": true,
  "powerOffDateTime": "string",
  "grossWeightKg": 0,
  "netWeightKg": 0,
  "tareWeightKg": 0,
  "spatialRequirement": 0,
  "salesOrderNumber": "string",
  "purchaseOrderNumber": "string",
  "customerOrderNumber": "string",
  "specialInstructions": "string",
  "internalNotes": "string",
  "feederVessel": "string",
  "feederVoyageNumber": "string",
  "oceanVessel": "string",
  "oceanVoyageNumber": "string",
  "shippingCarrier": "string",
  "shippingBookingReference": "string",
  "portOfDischarge": "string",
  "destinationCountry": "string",
  "portOfDispatch": "string",
  "originCountry": "string",
  "product": {
    "productBundle": {},
    "productCode": { … },
    "productId": "string",
    "quantity": 0
  },
  "bookingIds": [
    "string"
  ],
  "keyWaypoints": {
    "EMPTY_PICKUP": { … },
    "EMPTY_DELIVERY": { … },
    "PICKUP": { … },
    "DELIVERY": { … },
    "PORT_OF_LOADING": { … },
    "PORT_OF_DISCHARGE": { … }
  },
  "movements": [
    { … }
  ],
  "properties": {},
  "canceled": true,
  "createdBy": {
    "userId": "string",
    "userName": "string",
    "email": "string",
    "sourceId": "string"
  },
  "created": "string",
  "updated": "string",
  "type": "EXPORT",
  "segments": {
    "pre": { … },
    "main": { … }
  }
}

update/create master booking by ID

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

M2X master booking id

Bodyapplication/jsonrequired

Create or update a master booking

shipmentIdstringrequired

Unique identifier for the container shipment

emptyReleaseNumberstring

Release number for empty container pickup authorization

releaseNumberstring or null

Release number for loaded container pickup authorization

containerNumberstring or null

The ISO standard container number

containerSealNumberstring or null

The customs seal number attached to the container

customerobject(CorporateCustomerMappingRequest)
recipientCustomerstring or null

The recipient customer for the container shipment

shippingTemperaturenumber or null

Required shipping temperature for refrigerated containers

actualPackTemperaturenumber or null

Actual temperature when the container was packed

unNumberstring or null

UN number for dangerous goods classification

commodityCodestring or null

Commodity code for customs classification

commodityDescriptionstring or null

Description of the goods in the container

dangerousGoodsboolean or null

Whether the container contains dangerous goods

ambientTimeHoursnumber or null

Maximum time the container can be at ambient temperature (for refrigerated goods)

activeRefrigerationboolean or null

Whether the container requires active refrigeration during transport

powerOffDateTimestring or null(date-time)

Date and time when refrigeration power is turned off

grossWeightKgnumber or null

Total weight of container and contents (in kilograms)

netWeightKgnumber or null

Weight of goods only, excluding container tare weight (in kilograms)

tareWeightKgnumber or null

Weight of the empty container (in kilograms)

spatialRequirementnumber or null

Volume requirement for the container contents (in cubic meters)

salesOrderNumberstring or null

Customer's sales order number for the container shipment

purchaseOrderNumberstring or null

Customer's purchase order number for the container shipment

customerOrderNumberstring or null

Customer's internal order number for the container shipment

specialInstructionsstring or null

Special handling instructions for the container

internalNotesstring or null

Internal notes for the container booking

feederVesselstring or null

Name of the feeder vessel for container transport

feederVoyageNumberstring or null

Voyage number of the feeder vessel

oceanVesselstring or null

Name of the ocean vessel for international container transport

oceanVoyageNumberstring or null

Voyage number of the ocean vessel

shippingCarrierstring or null

Name of the shipping line or carrier

shippingBookingReferencestring or null

Booking reference from the shipping carrier

portOfDischargestring or null

Port where the container is discharged from the vessel

destinationCountrystring or null

Country of destination for the container shipment

portOfDispatchstring or null

Port where the container is dispatched from

originCountrystring or null

Country of origin for the container shipment

productobject(MasterBookingProductRequest)
propertiesobject

A key value store containing custom properties

typestringrequired

The type of container transportation (export)

Discriminator
Value "EXPORT"
segmentsobject

Container movement segments for export operations (pre-movement and main movement only)

transportModestringDeprecated

The primary mode of transport for the container. Deprecated in favour of segment level transport mode.

Enum"COASTAL""RAIL""ROAD"
keyWaypointsobjectDeprecated

contains a list of key waypoints

curl -i -X PUT \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/masterBookings/{masterBookingId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transportMode": "COASTAL",
    "shipmentId": "string",
    "emptyReleaseNumber": "string",
    "releaseNumber": "string",
    "containerNumber": "string",
    "containerSealNumber": "string",
    "customer": {
      "customerName": "Fruit World",
      "customerId": "Yc7cXUulBhMM58iuOQce",
      "externalId": "FTW",
      "integrationId": "C99"
    },
    "recipientCustomer": "string",
    "shippingTemperature": 0,
    "actualPackTemperature": 0,
    "unNumber": "string",
    "commodityCode": "string",
    "commodityDescription": "string",
    "dangerousGoods": true,
    "ambientTimeHours": 0,
    "activeRefrigeration": true,
    "powerOffDateTime": "2019-08-24T14:15:22Z",
    "grossWeightKg": 0,
    "netWeightKg": 0,
    "tareWeightKg": 0,
    "spatialRequirement": 0,
    "salesOrderNumber": "string",
    "purchaseOrderNumber": "string",
    "customerOrderNumber": "string",
    "specialInstructions": "string",
    "internalNotes": "string",
    "feederVessel": "string",
    "feederVoyageNumber": "string",
    "oceanVessel": "string",
    "oceanVoyageNumber": "string",
    "shippingCarrier": "string",
    "shippingBookingReference": "string",
    "portOfDischarge": "string",
    "destinationCountry": "string",
    "portOfDispatch": "string",
    "originCountry": "string",
    "product": {
      "productCode": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "quantity": 0,
      "productBundle": {
        "payload": [
          {
            "itemId": "string",
            "quantity": 0,
            "description": "string",
            "massKg": 0,
            "netWeightKg": 0,
            "tareWeightKg": 0,
            "spatialRequirement": 0,
            "unitOfMeasure": "string",
            "product": {
              "productCode": null,
              "productCodeExternalId": null,
              "productDescription": null
            },
            "commodityCode": "string",
            "commodityDescription": "string",
            "orderNumber": "string",
            "metadata": null,
            "properties": null
          }
        ]
      }
    },
    "properties": {},
    "keyWaypoints": {
      "EMPTY_PICKUP": {
        "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
        },
        "pickupDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "deliveryDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "packDate": "2019-08-24",
        "availableDate": "2019-08-24",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      },
      "EMPTY_DELIVERY": {
        "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
        },
        "pickupDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "deliveryDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "packDate": "2019-08-24",
        "availableDate": "2019-08-24",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      },
      "PICKUP": {
        "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
        },
        "pickupDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "deliveryDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "packDate": "2019-08-24",
        "availableDate": "2019-08-24",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      },
      "DELIVERY": {
        "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
        },
        "pickupDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "deliveryDateTimeWindow": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "packDate": "2019-08-24",
        "availableDate": "2019-08-24",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      },
      "PORT_OF_LOADING": {
        "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
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      },
      "PORT_OF_DISCHARGE": {
        "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
        },
        "departureDateTime": "2019-08-24T14:15:22Z",
        "arrivalDateTime": "2019-08-24T14:15:22Z",
        "portEarliestReceivalDateTime": "2019-08-24T14:15:22Z",
        "shipCutOffDateTime": "2019-08-24T14:15:22Z"
      }
    },
    "type": "EXPORT",
    "segments": {
      "pre": {
        "tentative": true,
        "options": {
          "regenerateMovements": true
        },
        "transportMode": "COASTAL",
        "placeOfPickup": {
          "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
          },
          "dateTimeWindow": {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        },
        "placeOfDelivery": {
          "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
          },
          "dateTimeWindow": {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        },
        "shippingInformation": {
          "timeConstraints": [
            {
              "dateTime": "2019-08-24T14:15:22Z",
              "constraintType": "AVAILABLE"
            }
          ]
        }
      },
      "main": {
        "tentative": true,
        "options": {
          "regenerateMovements": true
        },
        "transportMode": "COASTAL",
        "placeOfPickup": {
          "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
          },
          "dateTimeWindow": {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        },
        "placeOfDelivery": {
          "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
          },
          "dateTimeWindow": {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        },
        "shippingInformation": {
          "timeConstraints": [
            {
              "dateTime": "2019-08-24T14:15:22Z",
              "constraintType": "AVAILABLE"
            }
          ],
          "placeOfReceipt": {
            "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
            },
            "timeConstraints": [
              {
                "dateTime": "2019-08-24T14:15:22Z",
                "constraintType": "ESTIMATED_DEPARTURE"
              }
            ]
          },
          "portOfLoading": {
            "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
            },
            "timeConstraints": [
              {
                "dateTime": "2019-08-24T14:15:22Z",
                "constraintType": "ESTIMATED_DEPARTURE"
              }
            ]
          }
        }
      }
    }
  }'

Responses

Successful operation

Bodyapplication/json
masterBookingIdstring

master booking id

Response
application/json
{
  "masterBookingId": "string"
}

delete a master booking by ID

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

M2X master booking id

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

Responses

Successful operation

Bodyapplication/json
masterBookingIdstring

master booking id

Response
application/json
{
  "masterBookingId": "string"
}

Update a master booking's manifest

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

Master BookingId Id

Bodyapplication/jsonrequired

Update master booking via manifest data

masterBookingIdstring or null
releaseNumberstring or null
containerNumberstring or null
containerSealNumberstring or null
customerOrderNumberstring or null
shippingTemperaturenumber or null
actualPackTemperaturenumber or null
grossWeightKgnumber or null
netWeightKgnumber or null
tareWeightKgnumber or null
spatialRequirementnumber or null
powerOffDateTimestring or null(date-time)
productobject(MasterBookingProductRequest)
activeRefrigerationboolean
dangerousGoodsboolean
unNumberstring or null
commodityCodestring or null

Commodity code for customs classification

commodityDescriptionstring or null

Description of the goods in the container

timestampstring(date-time)

RFC3339 date time of the manifest

feederVesselstring or null
feederVoyageNumberstring or null
oceanVesselstring or null
oceanVoyageNumberstring or null
shippingBookingReferencestring or null
shipmentIdstring or null
packDatestring or null(date)
propertiesobject
metadataobject
specialInstructionsstring or nullDeprecated
curl -i -X POST \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/masterBookings/{masterBookingId}/manifest' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "masterBookingId": "string",
    "releaseNumber": "string",
    "containerNumber": "string",
    "containerSealNumber": "string",
    "customerOrderNumber": "string",
    "shippingTemperature": 0,
    "actualPackTemperature": 0,
    "grossWeightKg": 0,
    "netWeightKg": 0,
    "tareWeightKg": 0,
    "spatialRequirement": 0,
    "powerOffDateTime": "2019-08-24T14:15:22Z",
    "product": {
      "productCode": {
        "productCode": null,
        "productCodeExternalId": null,
        "productDescription": null
      },
      "quantity": 0,
      "productBundle": {
        "payload": [
          {
            "itemId": "string",
            "quantity": 0,
            "description": "string",
            "massKg": 0,
            "netWeightKg": 0,
            "tareWeightKg": 0,
            "spatialRequirement": 0,
            "unitOfMeasure": "string",
            "product": {
              "productCode": null,
              "productCodeExternalId": null,
              "productDescription": null
            },
            "commodityCode": "string",
            "commodityDescription": "string",
            "orderNumber": "string",
            "metadata": null,
            "properties": null
          }
        ]
      }
    },
    "activeRefrigeration": true,
    "dangerousGoods": true,
    "unNumber": "string",
    "commodityCode": "string",
    "commodityDescription": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "specialInstructions": "string",
    "feederVessel": "string",
    "feederVoyageNumber": "string",
    "oceanVessel": "string",
    "oceanVoyageNumber": "string",
    "shippingBookingReference": "string",
    "shipmentId": "string",
    "packDate": "2019-08-24",
    "properties": {},
    "metadata": {}
  }'

Responses

successful operation

Bodyapplication/json
masterBookingIdstring

master booking id

Response
application/json
{
  "masterBookingId": "string"
}

Get a master booking expense view by id

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

Internal M2X master booking id

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

Responses

Successful operation

Bodyapplication/json
totalnumber or nullrequired

The projected total expense for the master booking

expensesArray of objectsrequired
expenses[].​bookingIdstring

The booking identifier

expenses[].​totalnumber

The projected total expense for the booking

Response
application/json
{
  "total": 0,
  "expenses": [
    { … }
  ]
}

Get a master booking revenue view by id

Request

Security
M2X_auth_application
Path
masterBookingIdstringrequired

Internal M2X master booking id

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

Responses

Successful operation

Bodyapplication/json
totalnumber or nullrequired

The projected total revenue for the master booking

Response
application/json
{
  "total": 0
}

Get a shipment's master bookings by shipment ID

Request

Security
M2X_auth_application
Query
shipmentIdstringrequired

Shipment Id

curl -i -X GET \
  'https://developer.m2x.app/_mock/apis/publicapi/openapi/masterBookings?shipmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/jsonArray [
One of:

A master booking for container transportation operations. The structure varies based on the operation type (export, import, or domestic move).

masterBookingIdstring
externalIdstring
shipmentIdstring
emptyReleaseNumberstring
releaseNumberstring
containerNumberstring
containerSealNumberstring
customerobject
recipientCustomerstring
shippingTemperaturenumber
actualPackTemperaturenumber
unNumberstring
commodityCodestring
commodityDescriptionstring
dangerousGoodsboolean
ambientTimeHoursnumber
activeRefrigerationboolean
powerOffDateTimestring
grossWeightKgnumber
netWeightKgnumber
tareWeightKgnumber
spatialRequirementnumber
salesOrderNumberstring
purchaseOrderNumberstring
customerOrderNumberstring
specialInstructionsstring
internalNotesstring
feederVesselstring
feederVoyageNumberstring
oceanVesselstring
oceanVoyageNumberstring
shippingCarrierstring
shippingBookingReferencestring
portOfDischargestring
destinationCountrystring
portOfDispatchstring
originCountrystring
productobject
bookingIdsArray of strings
keyWaypointsobject

contains a list of key waypoints

movementsArray of objects(MasterBookingMovement)
propertiesobject

A key value store containing custom properties

canceledboolean
createdByobject
createdstring
updatedstring
typestringrequired

The type of container transportation (export)

Value "EXPORT"
segmentsobject

Container movement segments for export operations (pre-movement and main movement only)

transportModestringDeprecated
Enum"COASTAL""RAIL""ROAD"
]
Response
application/json
[
  {
    "transportMode": "COASTAL",
    "masterBookingId": "string",
    "externalId": "string",
    "shipmentId": "string",
    "emptyReleaseNumber": "string",
    "releaseNumber": "string",
    "containerNumber": "string",
    "containerSealNumber": "string",
    "customer": { … },
    "recipientCustomer": "string",
    "shippingTemperature": 0,
    "actualPackTemperature": 0,
    "unNumber": "string",
    "commodityCode": "string",
    "commodityDescription": "string",
    "dangerousGoods": true,
    "ambientTimeHours": 0,
    "activeRefrigeration": true,
    "powerOffDateTime": "string",
    "grossWeightKg": 0,
    "netWeightKg": 0,
    "tareWeightKg": 0,
    "spatialRequirement": 0,
    "salesOrderNumber": "string",
    "purchaseOrderNumber": "string",
    "customerOrderNumber": "string",
    "specialInstructions": "string",
    "internalNotes": "string",
    "feederVessel": "string",
    "feederVoyageNumber": "string",
    "oceanVessel": "string",
    "oceanVoyageNumber": "string",
    "shippingCarrier": "string",
    "shippingBookingReference": "string",
    "portOfDischarge": "string",
    "destinationCountry": "string",
    "portOfDispatch": "string",
    "originCountry": "string",
    "product": { … },
    "bookingIds": [ … ],
    "keyWaypoints": { … },
    "movements": [ … ],
    "properties": {},
    "canceled": true,
    "createdBy": { … },
    "created": "string",
    "updated": "string",
    "type": "EXPORT",
    "segments": { … }
  }
]

Master booking webhookWebhook

Request

webhook type: MASTER_BOOKING

Bodyapplication/jsonrequired
masterBookingIdstring
externalIdstring
shipmentIdstring
emptyReleaseNumberstring
releaseNumberstring
containerNumberstring
containerSealNumberstring
customerobject
recipientCustomerstring
shippingTemperaturenumber
actualPackTemperaturenumber
unNumberstring
commodityCodestring
commodityDescriptionstring
dangerousGoodsboolean
ambientTimeHoursnumber
activeRefrigerationboolean
powerOffDateTimestring
grossWeightKgnumber
netWeightKgnumber
tareWeightKgnumber
spatialRequirementnumber
salesOrderNumberstring
purchaseOrderNumberstring
customerOrderNumberstring
specialInstructionsstring
internalNotesstring
feederVesselstring
feederVoyageNumberstring
oceanVesselstring
oceanVoyageNumberstring
shippingCarrierstring
shippingBookingReferencestring
portOfDischargestring
destinationCountrystring
portOfDispatchstring
originCountrystring
productobject
bookingIdsArray of strings
keyWaypointsobject

contains a list of key waypoints

movementsArray of objects(MasterBookingMovement)
propertiesobject

A key value store containing custom properties

canceledboolean
createdByobject
createdstring
updatedstring
typestringrequired

The type of container transportation (export)

Discriminator
Value "EXPORT"
segmentsobject

Container movement segments for export operations (pre-movement and main movement only)

transportModestringDeprecated
Enum"COASTAL""RAIL""ROAD"
application/json
{
  "transportMode": "COASTAL",
  "masterBookingId": "string",
  "externalId": "string",
  "shipmentId": "string",
  "emptyReleaseNumber": "string",
  "releaseNumber": "string",
  "containerNumber": "string",
  "containerSealNumber": "string",
  "customer": {
    "customerId": "string",
    "customerName": "string",
    "externalId": "string",
    "integrationId": "string"
  },
  "recipientCustomer": "string",
  "shippingTemperature": 0,
  "actualPackTemperature": 0,
  "unNumber": "string",
  "commodityCode": "string",
  "commodityDescription": "string",
  "dangerousGoods": true,
  "ambientTimeHours": 0,
  "activeRefrigeration": true,
  "powerOffDateTime": "string",
  "grossWeightKg": 0,
  "netWeightKg": 0,
  "tareWeightKg": 0,
  "spatialRequirement": 0,
  "salesOrderNumber": "string",
  "purchaseOrderNumber": "string",
  "customerOrderNumber": "string",
  "specialInstructions": "string",
  "internalNotes": "string",
  "feederVessel": "string",
  "feederVoyageNumber": "string",
  "oceanVessel": "string",
  "oceanVoyageNumber": "string",
  "shippingCarrier": "string",
  "shippingBookingReference": "string",
  "portOfDischarge": "string",
  "destinationCountry": "string",
  "portOfDispatch": "string",
  "originCountry": "string",
  "product": {
    "productBundle": {},
    "productCode": { … },
    "productId": "string",
    "quantity": 0
  },
  "bookingIds": [
    "string"
  ],
  "keyWaypoints": {
    "EMPTY_PICKUP": { … },
    "EMPTY_DELIVERY": { … },
    "PICKUP": { … },
    "DELIVERY": { … },
    "PORT_OF_LOADING": { … },
    "PORT_OF_DISCHARGE": { … }
  },
  "movements": [
    { … }
  ],
  "properties": {},
  "canceled": true,
  "createdBy": {
    "userId": "string",
    "userName": "string",
    "email": "string",
    "sourceId": "string"
  },
  "created": "string",
  "updated": "string",
  "type": "EXPORT",
  "segments": {
    "pre": { … },
    "main": { … }
  }
}

Responses

Webhook received successfully

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