Short Description
...
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:
...
Property | Type | Length | Mandatory | Description | Comments |
|---|
commodity
| /Commodity | | | | |
subCommodity
| /SubCommodity | | | | |
charterer
| /BusinessPartner | | | | |
portRotation
| String | 256 | | | |
cpDate
| Date | | | | |
cargoReference
| String | 16 | | | |
cargoSubReference
| String | 4 | | | |
externalReference
| String | 64 | | | |
commissionAddress
| Double | | | | |
cargoPorts
| Array of /CargoPort | | | | |
variouses
| Array of /Various | | | | |
commissions
| Array of /Commission | | | | |
voyage
| /Voyage | | | | |
bookedQuantity
| Double | | | | |
cargoQuantity
| Double | | | | |
commissionBroker
| Double | | | | |
exchangeRate
| Double | | | | |
freightRate
| Double | | | | |
isLumpsum
| Boolean | | | | |
isTemplate
| 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 |
isWorldscale
| Boolean | | | | |
minimumQuantity
| Double | | | | |
quantityOptionPct
| Double | | | | |
stowageFactor
| Double | | | | |
volume
| Double | | | | |
weight
| Double | | | | |
weightFactor
| Double | | | | |
width
| Double | | | | |
cargoMeasurement
| /Measurement | | Yes | | |
freightCurrency
| /Currency | | Yes | | |
freightMeasurement
| /Measurement | | | | |
quantityOption
| /QuantityOption | | | | |
stowageUnit
| /Measurement | | Yes | | |
weightMeasurement
| /Measurement | | Yes | | |
weightUnit
| /Measurement | | Yes | | |
length
| Double | | | | |
comments
| String | 64 | | | |
commission
| Double | | | | |
area
| Double | | | | |
netFreight
| Double | | | | |
variousCost
| Double | | | | |
variousRevenue
| Double | | | | |
demurrage
| Double | | | | |
despatch
| Double | | | | |
doPrice
| Double | | | | |
foPrice
| Double | | | | |
freight
| Double | | | | |
grossFreight
| Double | | | | |
handlingCost
| Double | | | | |
reletOfCargo
| /Cargo | | | | |
businessUnit
| /BusinessUnit | | | | |
arrivalWindowFrom
| Date | | | | |
arrivalWindowTo
| Date | | | | |
blDate
| Date | | | | |
cargoMatch
| String | 1 | Yes | | |
cargoText
| String | 64 | | | |
laytimeTerms
| /LaytimeTerms | | | | |
paymentTerms
| /PaymentTerms | | | | |
tsOfCargoPort
| /CargoPort | | | | |
laytimeUsed
| Double | | | | |
deadfreight
| Double | | | | |
deadfreightRate
| Double | | | | |
demurrageRate
| Double | | | | |
despatchRate
| Double | | | | |
doBunkerAdjustment
| Double | | | | |
finalDestination
| String | 64 | | | |
flatRate
| Double | | | | |
foBunkerAdjustment
| Double | | | | |
hasEqualization
| Boolean | | | | |
hasN2Padding
| Boolean | | | | |
height
| Double | | | | |
isCradleRequired
| Boolean | | | | |
isDemurrageFixed
| Boolean | | | | |
isDespatchFixed
| Boolean | | | | |
isExclusive
| Boolean | | | | |
isLifo
| Boolean | | | | |
isOnDeck
| Boolean | | | | |
isReversible
| Boolean | | | | |
laycanFrom
| Date | | | | |
laycanTo
| Date | | | | |
laycanMissedBy
| Double | | | | |
laytimeAllowed
| Double | | | | |
laytimeExpireDate
| Date | | | | |
laytimeTermsValue
| Double | | | | |
laytimeUsedFromDate
| Date | | | | |
laytimeUsedToDate
| Date | | | | |
maxTransitTime
| Double | | | | |
netFio
| Double | | | | |
onDeckOption
| Boolean | | | | |
overrage
| Double | | | | |
pctOverage
| Integer | | | | |
pctPrepaid
| Integer | | | | |
pieces
| Double | | | | |
placeOfOrigin
| String | 64 | | | |
shipFigure
| Double | | | | |
specificGravity
| Double | | | | |
specificGravityTemperature
| Double | | | | |
terms
| String | 25 | | | |
timeNotToCount
| Double | | | | |
timeOnDemurrage
| Double | | | | |
timeOnDespatch
| Double | | | | |
wsYear
| Integer | | | | |
baselineTerm
| /BaselineTerm | | | | |
baselineTerm2
| /BaselineTerm | | | | |
bookingStatus
| /StatusType | | | | |
coaLine
| /CoaLine | | | | |
coatingType
| /CoatingType | | | | |
dimensionMeasurement
| /Measurement | | | | |
payee
| /BusinessPartner | | | | |
paymentTerms2
| /PaymentTerms | | | | |
project
| /Project | | | | |
supplier
| /BusinessPartner | | | | |
valueCurrency
| /Currency | | | | |
volumeMeasurement
| /Measurement | | Yes | | |
value
| Double | | | | |
demurrageTimeBarEvent
| /Event | | | | |
laycanTargetFrom
| Date | | | | from API 3.3 |
laycanTargetTo
| Date | | | | from API 3.3 |
company
| /Company | | | | from API 3.3 |
vc
| /Vc | | | | |
cargoType
| /CargoType | | | | |
freightRates
| Array of /FreightRate | | | | |
eeoi
| Double | | | | |
isOption
| Boolean | | | | from API 6.26 |
optionStatus
| /StatusType | | | | from API 6.26 |
freightAdjustments
| /FreightAdjustment | | | | from API 6.28 |
adjustment
| Double | | | The sum of all freight adjustments on the cargo | from API 6.28 |
office | /Office | | | | from API 6.33 |
cargoOperator
| /User | | | | 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) |
...