M2X APIs
M2X APIS (1.0.0)
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products
- https://developer.m2x.app/apis/v0/products
- NZ Production server (uses live data)https://m2x.app/apis/v0/products
- US Production server (uses live data)https://us.m2x.app/apis/v0/products
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products
- Sandbox serverhttps://staging.m2x.app/apis/v0/products
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://developer.m2x.app/_mock/apis/publicapi/openapi/products \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Successful operation
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
Whether or not the dispatcher can specify the product dimensions
[ { "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 } ]
The sub components of the product if present
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products
- https://developer.m2x.app/apis/v0/products
- NZ Production server (uses live data)https://m2x.app/apis/v0/products
- US Production server (uses live data)https://us.m2x.app/apis/v0/products
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products
- Sandbox serverhttps://staging.m2x.app/apis/v0/products
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'Successful operation
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
{ "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 }
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}
- https://developer.m2x.app/apis/v0/products/{productCodeId}
- NZ Production server (uses live data)https://m2x.app/apis/v0/products/{productCodeId}
- US Production server (uses live data)https://us.m2x.app/apis/v0/products/{productCodeId}
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products/{productCodeId}
- Sandbox serverhttps://staging.m2x.app/apis/v0/products/{productCodeId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Successful operation
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
{ "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 }
The sub components of the product if present
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}
- https://developer.m2x.app/apis/v0/products/{productCodeId}
- NZ Production server (uses live data)https://m2x.app/apis/v0/products/{productCodeId}
- US Production server (uses live data)https://us.m2x.app/apis/v0/products/{productCodeId}
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products/{productCodeId}
- Sandbox serverhttps://staging.m2x.app/apis/v0/products/{productCodeId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'Successful operation
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
{ "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 }
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}/loadPlanRules
- https://developer.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- NZ Production server (uses live data)https://m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- US Production server (uses live data)https://us.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- Sandbox serverhttps://staging.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}/loadPlanRules' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Successful operation
The percentage of a compartment's capacity this product may never exceed, or null for no limit.
While this product occupies any compartment of a vehicle, every compartment on that vehicle at least minApplicableCapacityM3 in size must not come to rest strictly between lowPercent and highPercent full.
Lower bound of the restricted band, exclusive. Must be less than highPercent.
Upper bound of the restricted band, exclusive.
{ "safeFillPercent": 97, "restrictedFillBands": [ { … } ] }
Request
Replaces the product's safe fill level and fill bands as a whole. Send safeFillPercent: null to clear the safe fill level and an empty restrictedFillBands to clear the fill bands. Setting the same rules again leaves them unchanged, so a failed request is safe to retry.
The percentage of a compartment's capacity this product may never exceed, or null for no limit.
While this product occupies any compartment of a vehicle, every compartment on that vehicle at least minApplicableCapacityM3 in size must not come to rest strictly between lowPercent and highPercent full.
Lower bound of the restricted band, exclusive. Must be less than highPercent.
Upper bound of the restricted band, exclusive.
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}/loadPlanRules
- https://developer.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- NZ Production server (uses live data)https://m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- US Production server (uses live data)https://us.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- Sandbox serverhttps://staging.m2x.app/apis/v0/products/{productCodeId}/loadPlanRules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.m2x.app/_mock/apis/publicapi/openapi/products/{productCodeId}/loadPlanRules' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"safeFillPercent": 97,
"restrictedFillBands": [
{
"lowPercent": 20,
"highPercent": 80,
"minApplicableCapacityM3": 5
}
]
}'A product
M2X internal tracking id for the product type
The sub components of the product if present
Product's custom fixed unit unloading time
Product's custom loading time per unit
Product's custom unloading time per unit
Enable Gross, Tare, Net input on driver mobile when weighbridge available at location
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).
Whether or not the product is usable only as a mix wrapper
Whether or not the product is usable only as component in a product mix
Whether or not the dispatcher can specify the components making up the product mix
- Mock serverhttps://developer.m2x.app/_mock/apis/publicapi/openapi/products/bulk
- https://developer.m2x.app/apis/v0/products/bulk
- NZ Production server (uses live data)https://m2x.app/apis/v0/products/bulk
- US Production server (uses live data)https://us.m2x.app/apis/v0/products/bulk
- AUS Production server (uses live data)https://au.m2x.app/apis/v0/products/bulk
- Sandbox serverhttps://staging.m2x.app/apis/v0/products/bulk
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}
}
]'{ "success": true, "batchId": "ABC123" }