Short Description
...
Required fields:
Cargo: commodity, charterer, freightCurrency, cargoMeasurement, cargoPorts cargoPorts
POST example:
Code Block | ||
---|---|---|
| ||
{
"cargoMeasurement":"MT",
"freightCurrency":"USD",
"charterer":30091200,
"commodity":11401057,
"cargoPorts":[
{
"cargoPortSequence":1,
"reasonForCall":"L",
"port":103309
},
{
"cargoPortSequence":1,
"reasonForCall":"D",
"port":105724
}
],
} |
Insert a new Cargo object allocated to a Voyage:
...
To know which should be the first portCallSequence value to use in the JSON, a GET.Voyage/{key} can be done passing the following fields as HTTP header parameter (see Adjust Number of Fields to be Returned from a Request):
{"portCalls":{"portCallSequence":"*"}}
that will return a JSON like this:
...
The starting portCallSequence to use to create the Cargo will be the max portCallSequence returned by this call plus 1.
If the port of the CargoPor CargoPort are instead already in the schedule, the following JSON can be post to create a new Cargo:
...
Changing cargoQuantity in a cargoPort does not trigger any calculation on cargoQuantity of other cargoPort.
The cargoQuantity at cargo level is calculated summing the cargoQuantity of loading ports
It is not possible assign freightRate in both discharge and loading ports.
The cargoQuantiy cargoQuantity used for calculations are those in cargoPort, cargoQuantity at Cargo level is not used in calculations
Freight and freightRate used for calculations are those in cargoPort,
API will not use stowageFactor and weightFactor from commodity
...
Property | Type | Length | Mandatory | Description | Comments |
---|---|---|---|---|---|
| |||||
| |||||
| |||||
| String | 256 | |||
| Date | ||||
| String | 16 | |||
| String | 4 | |||
| String | 64 | |||
| Double | ||||
| Array of /CargoPort | ||||
| Array of /Various | ||||
| Array of /Commission | ||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | Defines wether or not the cargo is a template. Template cargoes are created when creating CoA and are used to create fixtures. | Added in version 5.6 | ||
| Boolean | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Yes | ||||
| Yes | ||||
| |||||
| |||||
| Yes | ||||
| Yes | ||||
| Yes | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| |||||
| |||||
| Date | ||||
| Date | ||||
| Date | ||||
| String | 1 | Yes | ||
| String | 64 | |||
| |||||
| |||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Date | ||||
| Double | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Double | ||||
| Integer | ||||
| Integer | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 25 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Integer | ||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| Yes | ||||
| Double | ||||
| |||||
| Date | from API 3.3 | |||
| Date | from API 3.3 | |||
| from API 3.3 | ||||
| |||||
| |||||
| Array of /FreightRate | ||||
| Double |
Note |
---|
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss) |
Example Response Body
...
language | js |
---|
...
| Boolean | from API 6.26 | |||
| from API 6.26 | ||||
| from API 6.28 | ||||
| Double | The sum of all freight adjustments on the cargo | from API 6.28 | ||
office | from API 6.33 | ||||
| from API 6.33 |
Note |
---|
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss) |
Example Response Body
Code Block | ||
---|---|---|
| ||
{ "commodity": { "commodityName": "Mabl Commodity", "commodityCode": "MABL", "key": 13670798, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/Commodity/13670798" }, "subCommodity": null, "charterer": { "businessPartnerName": "Mabl Charterer", "businessPartnerSort": "Mabl Charterer", "businessPartnerCode": "105", "portAgentType": null, "businessPartnerType": { "businessPartnerType": "C", "businessPartnerTypeDesc": "Charterer", "key": 1000032, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/BusinessPartnerType/1000032" }, "key": 13669721, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/BusinessPartner/13669721" }, "portRotation": "BREMEN/LIVORNO", "cpDate": null, "cargoReference": "13875375", "cargoSubReference": null, "externalReference": null, "scenarios": [ { "key": 6015476, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/Scenario/6015476", "fleetPlan": { "key": 1474127, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/FleetPlan/1474127" } } ], "createdById": 999999, "voyage": { "key": 13875364, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/Voyage/13875364" }, "area": null, "createdDate": "2023-04-21T08:29:26", "exchangeRate": 1.0, "externalObjectKey": null, "modifiedDate": "2023-04-21T12:41:02", "company": { "key": 167278513668967, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Commodity/1672785" }, "subCommodity": nullCompany/13668967", "charterer": { "businessPartnerName"companyName": "SandMabl ASCompany", "businessPartnerSort": "LOCHALINE", "businessPartnerCodecompanyCode": "31339MABL", "portAgentTypedefaultBankAccount": null, }, "businessPartnerTypepaymentTerms": { "key": 1004279, "businessPartnerTypeself": "Chttp://rocketleague1.dataloy.com:8080/ws/rest/PaymentTerms/1004279", "businessPartnerTypeDescpaymentTermsCode": "Charterer",10D" }, "baselineTerm": { "key": 10000321004265, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/BusinessPartnerType/1000032"BaselineTerm/1004265", }"baselineTermCode": "ARBL", "keybaselineTermDesc": 20884163, "After Release of Bill of Lading" }, "selfcommission": "http://platform-dev.dataloy.com:80/ws/rest/BusinessPartner/20884163"0.0, "vc": }null, "portRotationhandlingCost": "ROTTERDAM/BOTANY BAY"0.0, "freightRate": 10.0, "cpDateleg": null, "cargoReferencecoaLine": "35509192"null, "cargoSubReferencecargoPorts": null, [ { "externalReferencekey": null,13875378, "self"commissions: "http: [],//rocketleague1.dataloy.com:8080/ws/rest/CargoPort/13875378" "cargoPorts": [ }, { "key": 3550919413875377, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/CargoPort/3550919413875377" } ], "reletOfCargo": null, { "isPerformanceCargo": false, "cargoQuantity": 5600.0, "keybusinessUnit": 35509195, { "key": 13670758, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/CargoPortBusinessUnit/35509195" } ], "variouses": [],13670758", "createdDatebusinessUnitName": "2020-08-18T15:34:01",Mabl Business Unit", "modifiedDatebusinessUnitCode": "2020-08-20T09:05:13",MABL" "createdById": 35370791}, "voyageisOption": {false, "keyisTemplate": 35508713false, "self": "http://platform-dev.dataloy.com:80/ws/rest/Voyage/35508713" "commissionBroker": 0.0, } "laycanFrom": null, "companylaycanMissedBy": 0.0, { "laycanTo": null, "keycommissions": 1000001[], "adjustment": 18592.800000000003, "selfcomments": "http://platform-dev.dataloy.com:80/ws/rest/Company/1000001"null, "commissionAddress": 0.0, "demurrage": 0.0, "despatch": 0.0, "companyCodedoPrice": 0.0, "5897eeoi": 24.208296035498126, "foPrice": 0.0, "companyNamefreight": "Peak Shipping AS",56000.0, "grossFreight": 74592.8, "defaultBankAccountnetFreight": null56000.0, }"variousCost": 0.0, "areavariousRevenue": null0.0, "exchangeRatevariouses": 0.9208117329079711[], "paymentTermsisIssuedLoi": null, "baselineTermlaytimeUsed": null0.0, "commissionvolume": 0.0, "vcarrivalWindowFrom": null, "handlingCostarrivalWindowMissedBy": 0.0, "freightRatearrivalWindowTo": 0.0null, "commentsblDate": null, "commissionAddressbookedQuantity": 05600.0, "businessUnitcargoMatch": { "1", "keycargoText": 1000576null, "deadfreight": 0.0, "self": "http://platform-dev.dataloy.com:80/ws/rest/BusinessUnit/1000576" "deadfreightRate": 0.0, "demurrageRate": 0.0, "businessUnitCodedespatchRate": 0.0, "01doBunkerAdjustment": 0.0, "finalDestination": null, "businessUnitNameflatRate": "Peak Shipping"0.0, }"foBunkerAdjustment": 0.0, "legfreightAmountCurrency": null56000.0, "coaLinehasEqualization": nullfalse, "reletOfCargohasN2Padding": nullfalse, "isPerformanceCargoheight": falsenull, "cargoQuantityisCradleRequired": 0.0false, "commissionBrokerisDemurrageFixed": 0.0false, "laycanFromisDespatchFixed": nullfalse, "laycanMissedByisExclusive": 0.0false, "laycanToisLaycanAgreed": null, "demurrageisLifo": 0.0false, "despatchisLumpsum": 0.0false, "doPriceisOnDeck": 0.0false, "foPriceisReversible": 0.0false, "freightisWorldscale": 0.0false, "grossFreightlaycanTargetFrom": 0.0null, "netFreightlaycanTargetTo": 0.0null, "variousCostlaytimeAllowed": 0.0, "variousRevenuelaytimeExpireDate": 0.0null, "arrivalWindowFromlaytimeTermsValue": null0.0, "arrivalWindowTolaytimeUsedFromDate": null, "blDatelaytimeUsedToDate": null, "bookedQuantitymaxTransitTime": 0.0, "cargoMatchminimumQuantity": "1"0.0, "cargoTextnetFio": null10.0, "deadfreightonDeckOption": 0.0false, "deadfreightRateoverrage": 0.0, "demurrageRatepctOverage": 0.050, "despatchRatepctPrepaid": 0.0100, "doBunkerAdjustmentpieces": 0.0, "finalDestinationplaceOfOrigin": null, "flatRatequantityOptionPct": 0.0, "foBunkerAdjustmentshipFigure": 0.0, "freightAmountCurrencyspecificGravity": 0.0, "hasEqualizationspecificGravityTemperature": false0.0, "hasN2PaddingstowageFactor": false0.0, "heightterms": null, "isCradleRequiredtimeNotToCount": false0.0, "isDemurrageFixedtimeOnDemurrage": false0.0, "isDespatchFixedtimeOnDespatch": false, "isExclusive": false0.0, "isLaycanAgreedweight": null5600.0, "isLifoweightFactor": false0.0, "isLumpsumwidth": falsenull, "isOnDeckwsYear": falsenull, "isReversiblebaselineTerm2": falsenull, "isTemplatebookingStatus": false, "isWorldscale": false,{ "laycanTargetFromkey": null6022839, "laycanTargetToself": null"http://rocketleague1.dataloy.com:8080/ws/rest/StatusType/6022839", "laytimeAllowedstatusTypeCode": 0.0,"POSS", "laytimeExpireDatestatusTypeDesc": null,"Possibility" "laytimeTermsValue": 0.0}, "laytimeUsedFromDatecargoMeasurement": null, { "laytimeUsedToDatemeasurementCode": null"MT", "maxTransitTime": 0.0, "minimumQuantitykey": 0.01000578, "netFio": 0.0, "self": "onDeckOption": false,"http://rocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" "overrage": 0.0}, "pctOveragecargoType": 50, { "pctPrepaid": 100, "pieceskey": 0.06021782, "placeOfOrigin": null, "quantityOptionPctself": 0.0, "shipFigure": 0.0"http://rocketleague1.dataloy.com:8080/ws/rest/CargoType/6021782", "specificGravity": 0.0, "specificGravityTemperaturecargoTypeCode": 0.0"SPOT" }, "stowageFactorcoatingType": 0.0null, "termsdemurrageTimeBarEvent": { "0 C/0 C", "timeNotToCountkey": 0.01000052, "timeOnDemurrage": 0.0, "timeOnDespatchself": 0.0"http://rocketleague1.dataloy.com:8080/ws/rest/Event/1000052", "weight": 0.0, "weightFactoreventCode": 0.0"DEP", "widtheventDesc": null,"Departed" "wsYear": null}, "baselineTerm2dimensionMeasurement": null, "bookingStatusfreightAdjustments": {[ { "key": 1000119, "selfkey": "http://platform-dev.dataloy.com:80/ws/rest/StatusType/1000119"13875661, "statusTypeCode": "IND", "statusTypeDescself": "Indicationhttp://rocketleague1.dataloy.com:8080/ws/rest/FreightAdjustment/13875661" }, }, "cargoMeasurement": { { "measurementCode": "MT", "key": 100057813875568, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/MeasurementFreightAdjustment/100057813875568" }, "coatingType": null,} ], "demurrageTimeBarEvent": { "key"freightCurrency": 1000052,{ "selfcurrencyCode": "http://platform-dev.dataloy.com:80/ws/rest/Event/1000052USD", "eventCodecurrencyName": "DEPU.S. Dollar", "eventDesckey": "Departed" 400132, }, "dimensionMeasurementself": null, "freightCurrency": {"http://rocketleague1.dataloy.com:8080/ws/rest/Currency/400132" }, "currencyCodefreightMeasurement": "USD",{ "currencyNamemeasurementCode": "U.S. DollarMT", "key": 4001321000578, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/CurrencyMeasurement/4001321000578" }, "freightMeasurementfreightRates": {[], "laytimeTerms": null, "measurementCodeoptionStatus": "MT",{ "key": 10005781000105, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/MeasurementStatusType/10005781000105", } "statusTypeCode": "NOT", "laytimeTerms": null "statusTypeDesc": "Not declared" }, "payee": null, "paymentTerms2": null, "project": null, "quantityOption": null, "stowageUnit": { "measurementCode": "MT", "key": 1000578, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Measurement/1000578" }, "subCargos": [], "supplier": null, "tsOfCargoPort": null, "valueCurrency": { "currencyCode": "USD", "currencyName": "U.S. Dollar", "key": 400132, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Currency/400132" }, "volumeMeasurement": { "measurementCode": "CBM", "key": 1000579, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Measurement/1000579" }, "weightMeasurement": { "measurementCode": "MT", "key": 1000578, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Measurement/1000578" }, "weightUnit": { "measurementCode": "MT", "key": 1000578, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Measurement/1000578" }, "isIssuedLoi": null, "laytimeUsed": 0.0, "volume": 0.0, "length": null, "value": null, "remarks": [], "isObjectActive": true, "key": 3550919213875375, "self": "http://platform-devrocketleague1.dataloy.com:808080/ws/rest/Cargo/3550919213875375" } |
Related Content
Expand | ||
---|---|---|
| ||
|
...