Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.
URL http://transportial.com
Transportial info@transportial.com
curl -i -X POST \ https://docs.transportial.com/_mock/apis/capacity \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "name": "string", "description": "string", "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "banners": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "schedule": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "weekDays": [ "sunday" ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "timeSlotTemplates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "capacityUnits": 0, "weekDay": "sunday", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "filters": [] } ], "filters": [ { "filters": [] } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] } ], "timeSlots": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "date": "2019-08-24T14:15:22Z", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "consignments": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ {} ], "combined": true, "consignment": {}, "originalPhysicalSender": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalLegalSender": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalPhysicalAddressee": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalLegalAddressee": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ {} ], "actors": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "attributes": [ {} ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true }, "expectedCost": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true }, "hasAgreedToPrice": true, "versionNumber": 0 } ], "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "money": {} } ], "additionalInfo": { "property1": {}, "property2": {} }, "lineString": "string", "actors": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "user": { "vehicleGroups": [] }, "identifiers": [ null ], "contactDetails": [ null ] } ], "actions": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "identifiers": [ null ], "lifeCycle": "requested", "result": {}, "remark": "string", "sequenceNr": 0, "location": {}, "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "eta": "2019-08-24T14:15:22Z", "etd": "2019-08-24T14:15:22Z", "timeFormat": "string", "recurrence": "string", "duration": 0, "estimatedDuration": 0, "actions": [ null ], "communicationRequests": [ null ], "documents": [ null ], "versionNumber": 0, "constraints": [ null ], "isContainmentAction": true, "vehicle": {}, "stop": {}, "pin": "string", "tar": "string", "shipmentLine": {}, "containmentUUID": "string" } ], "constraints": [ { "associationType": "inline", "entity": {}, "description": "string" } ] } } ] }, "modality": "maritime", "subType": "load", "capacityPerUnit": { "value": "string", "unit": "string" }, "totalUnits": 0, "availableCapacity": { "value": "string", "unit": "string" }, "totalCapacity": { "value": "string", "unit": "string" }, "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true, "identifiers": [ {} ] }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "sequenceNr": 0 } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] }'
{ "success": true, "message": "string", "code": 0, "capacities": [ { … } ], "totalResults": 0 }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/capacity/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "capacities": [ { … } ], "totalResults": 0 }
curl -i -X PUT \ 'https://docs.transportial.com/_mock/apis/capacity/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "banners": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "schedule": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "weekDays": [ "sunday" ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "timeSlotTemplates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "capacityUnits": 0, "weekDay": "sunday", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "filters": [] } ], "filters": [ { "filters": [] } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] } ], "timeSlots": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "date": "2019-08-24T14:15:22Z", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "consignments": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ {} ], "combined": true, "consignment": {}, "originalPhysicalSender": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalLegalSender": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalPhysicalAddressee": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "originalLegalAddressee": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ {} ], "actors": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "attributes": [ {} ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true }, "expectedCost": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true }, "hasAgreedToPrice": true, "versionNumber": 0 } ], "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "money": {} } ], "additionalInfo": { "property1": {}, "property2": {} }, "lineString": "string", "actors": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "user": { "vehicleGroups": [] }, "identifiers": [ null ], "contactDetails": [ null ] } ], "actions": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "identifiers": [ null ], "lifeCycle": "requested", "result": {}, "remark": "string", "sequenceNr": 0, "location": {}, "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "eta": "2019-08-24T14:15:22Z", "etd": "2019-08-24T14:15:22Z", "timeFormat": "string", "recurrence": "string", "duration": 0, "estimatedDuration": 0, "actions": [ null ], "communicationRequests": [ null ], "documents": [ null ], "versionNumber": 0, "constraints": [ null ], "isContainmentAction": true, "vehicle": {}, "stop": {}, "pin": "string", "tar": "string", "shipmentLine": {}, "containmentUUID": "string" } ], "constraints": [ { "associationType": "inline", "entity": {}, "description": "string" } ] } } ] }, "modality": "maritime", "subType": "load", "capacityPerUnit": { "value": "string", "unit": "string" }, "totalUnits": 0, "availableCapacity": { "value": "string", "unit": "string" }, "totalCapacity": { "value": "string", "unit": "string" }, "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true, "identifiers": [ {} ] }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "sequenceNr": 0 } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] }'
{ "success": true, "message": "string", "code": 0, "capacities": [ { … } ], "totalResults": 0 }
curl -i -X DELETE \ 'https://docs.transportial.com/_mock/apis/capacity/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "capacities": [ { … } ], "totalResults": 0 }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/capacities/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "capacities": [ { … } ], "totalResults": 0 }
Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.
Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.
TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.