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 PUT \ 'https://docs.transportial.com/_mock/apis/consignment/{id}/documents' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "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" } } ] }'
{ "success": true, "message": "string", "code": 0, "trip": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "type": "internal", "tripNr": "string", "route": { … }, "status": "draft", "planStatus": "ok", "routeStatus": "on_route", "currentAction": { … }, "transportMode": "maritime", "capacityContract": { … }, "linkedTrip": true, "chauffeurs": [ … ], "transportEquipments": [ … ], "documents": [ … ], "actors": [ … ], "constraints": [ … ], "identifiers": [ … ], "pricingElements": [ … ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "kmStart": 0, "kmEnd": 0, "booking": { … }, "shareSettings": { … }, "externalAttributes": { … }, "expectedCost": { … }, "expectedRevenue": { … }, "actualCost": { … }, "CO2eWTW": 0.1, "CO2eTTW": 0.1, "nextAction": { … }, "lastAction": { … }, "versionNumber": 0 } }
Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.
This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process.
In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery.
curl -i -X POST \ https://docs.transportial.com/_mock/apis/consignments/combine \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "consignment": {}, "originalPhysicalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalPhysicalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "isPlannedToLastLocation": true, "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "pricingElements": [ { "nonce": "string", "name": "string", "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 } } ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "expectedCost": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "combined": true, "type": "string", "remark": "string", "constraints": [ { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" } ], "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] }'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
General description of consignment in Free text. e.g 20 europallets fruit. Meant for human inspection, not for automating processes.
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process.
In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery.
Set this value to 'true' if the user has agreed to the pricing of this element. Only needed once the NeedsBillingApproval Exception is thrown
curl -i -X PUT \ https://docs.transportial.com/_mock/apis/consignment \ -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", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "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": { "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 } } ], "attributes": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "color": "string" } ], "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": { "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 }, "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": { "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 }, "hasAgreedToPrice": true, "versionNumber": 0 }'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
Object describing a geographic location. A location can either be a point or an area.
This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process.
In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery.
Set this value to 'true' if the user has agreed to the pricing of this element. Only needed once the NeedsBillingApproval Exception is thrown
curl -i -X POST \ https://docs.transportial.com/_mock/apis/consignment \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "goods": [ { "associationType": "inline" } ], "combined": true, "consignment": { "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": [ { "associationType": "inline" } ], "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": { "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": { "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": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "attributes": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "color": "string" } ], "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": { "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 }, "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": { "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 }, "hasAgreedToPrice": true, "versionNumber": 0 }, "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "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": { "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": { "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "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": { "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 } } ], "attributes": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "color": "string" } ], "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": { "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 }, "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": { "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 }, "hasAgreedToPrice": true, "versionNumber": 0 }'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/consignment/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
curl -i -X DELETE \ 'https://docs.transportial.com/_mock/apis/consignment/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/consignments/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "consignments": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/consignments/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "consignments": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/consignment:extended/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "consignment": { "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": { … }, "originalLegalSender": { … }, "originalPhysicalAddressee": { … }, "originalLegalAddressee": { … }, "isPlannedToLastLocation": true, "type": "string", "remark": "string", "documents": [ … ], "actors": [ … ], "constraints": [ … ], "pricingElements": [ … ], "attributes": [ … ], "externalAttributes": { … }, "expectedRevenue": { … }, "expectedCost": { … }, "versionNumber": 0 } }
curl -i -X POST \ https://docs.transportial.com/_mock/apis/consignments/split \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "consignment": { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "consignment": {}, "originalPhysicalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalPhysicalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "isPlannedToLastLocation": true, "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "pricingElements": [ { "nonce": "string", "name": "string", "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "expectedCost": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "combined": true, "type": "string", "remark": "string", "constraints": [ { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" } ], "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] }, "relatedConsignments": [ { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "consignment": {}, "originalPhysicalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalPhysicalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "isPlannedToLastLocation": true, "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "pricingElements": [ { "nonce": "string", "name": "string", "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true } } ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "expectedCost": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "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 }, "combined": true, "type": "string", "remark": "string", "constraints": [ { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" } ], "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] } ] }'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "consignments": [ { … } ] }
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.