Get Consols
get
/consols
Request
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : consols
Type:
Show Source
object
-
allocatedNumFeu: number
(double)
Allocated FEU represents the original agreed-upon forty foot equivalent unit capacity for this stowage mode on the charter voyage.
-
allocatedNumTeu: number
(double)
Allocated TEU represents the original agreed-upon twenty foot equivalent unit capacity for this stowage mode on the charter voyage.
-
allocatedVolume:
allocatedVolume
Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.
-
allocatedWeight:
allocatedWeight
Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
bookedNumFeu: number
(double)
Represents the booked FEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
-
bookedNumTeu: number
(double)
Represents the booked TEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
-
bookedVolume:
bookedVolume
Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
-
bookedWeight:
bookedWeight
Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
-
charterVoyageGid: string
The GID for the charter voyage associated with the consol. Charter voyage is assigned for consol type of Charter Voyage Stowage.
-
committedNumFeu: number
(double)
Committed FEU represents the committed number of forty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed FEU can only be edited when the consol status is READY-TO-COMMIT.
-
committedNumTeu: number
(double)
Committed number of TEU represents the committed number of twenty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed TEU can only be edited when the consol status is READY-TO-COMMIT.
-
committedVolume:
committedVolume
Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.
-
committedWeight:
committedWeight
Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.
-
consolGid: string
The GID for the consol.
-
consolidationTypeGid: string
The GID for the assigned consolidation type on the consol. A consolidation type can be assigned to any order release or job for informational purposes. Consolidation types can also be included in a consolidation type profile that can then be used as criteria for the automatic assignment of non-freight related charges to a job.
-
consolType: string
Consol type can be Charter Voyage Stowage, Flight, or Ocean FCL.
-
consolXid: string
The XID for the consol.
-
domainName: string
Database domain where this data is stored.
-
equipmentReferenceUnitGid: string
The GID for the equipment group reference unit being defined.
-
flexCommodityCode: string
The user-defined commodity code. E.g.. the HTS, NMFC, SITC, STCC codes.
-
flexCommodityProfileGid: string
The flexible commodity profile ID that associates to the consol.
-
flexCommodityQualGid: string
A GID to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.
-
flightInstanceId: number
(int64)
The flight instance ID this consol is created from when the consol is a flight consol.
-
hazmatType: string
Hazmat type. One of three values: HAZMAT ONLY, NO HAZMAT, HAZMAT ALLOWED.
-
incoTermGid: string
The GID for the incoterms associated with the consol.
-
insertDate:
insertDate
Read Only:
true
insert date -
intendedArrivalTime:
intendedArrivalTime
Intended estimated time of arrival.
-
intendedDepartureTime:
intendedDepartureTime
Intended estimated time of departure.
-
intendedGroundServiceGid: string
The intended ground service gid. The ground service gid may not be in the system yet and therefore there is no foreign key restriction.
-
intendedVesselGid: string
The intended vessel gid. The vessel gid may not be in the system yet and therefore there is no foreign key restriction.
-
intendedVoyageGid: string
The intended voyage gid. The voyage gid may not be in the system yet and therefore there is no foreign key restriction.
-
itineraryProfileGid: string
The GID for the assigned itinerary profile. The itinerary profile defines the consol's applicability to legs.
-
links: array
links
Read Only:
true
-
maxNumEquipment: number
(int32)
The maximum number of equipment that can be held in the consol.
-
maxNumFeu: number
(double)
Maximum FEU represents the maximum forty foot equivalent unit capacity for this stowage mode on the charter voyage.
-
maxNumReferenceUnits: number
(double)
The maximum number of equipment reference units that can be held in the consol.
-
maxNumTeu: number
(double)
Maximum number of TEU represents the maximum twenty foot equivalent unit capacity for this stowage mode on the charter voyage.
-
maxVolume:
maxVolume
Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.
-
maxWeight:
maxWeight
Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.
-
oneShipmentPerContainer: boolean
This flag will only be used when consol_type is OCEAN FCL. If it is 'Y', one shipment will be created for each container specified on the consol. If it is 'N', one shipment will be created for all the containers specified on the consol. The default value is 'N'.
-
perspective: string
Perspective - Buy or Sell.
-
placeDeliverLocationGid: string
Specifies a place of delivery other than the port of discharge. If specified this will add a stop to the consol shipment created.
-
placeReceiptLocationGid: string
Specifies a place of receipt location other than the port of loading. If specified this will add a stop to the consol shipment created.
-
portOfDisLocationGid: string
The port of discharge for transport.
-
portOfLoadLocationGid: string
The port of loading for transport.
-
producedNumFeu: number
(double)
Produced FEU is a FEU value that is not calculated and is user-defined.
-
producedNumTeu: number
(double)
Produced TEU is a TEU value that is not calculated and is user-defined.
-
producedVolume:
producedVolume
Produced volume is a volume values that is not calculated and is user-defined.
-
producedWeight:
producedWeight
Produced weight is a weight values that is not calculated and is user-defined.
-
refnums:
refnums
-
remarks:
remarks
-
servprovGid: string
The GID for the carrier. If blank, look at the voyage table.
-
statuses:
statuses
-
stowageModeGid: string
The GID for the stowage mode related to this consol. Stowage modes provide a way to identify how the shipment will be stowed. When an order release is booked for a voyage, the system needs to determine the best stowage mode and subsequently the best voyage that supports that stowage mode. To determine the best stowage mode, you can create preference rules that are evaluated. This rule will, based on certain attributes on the order release, provide a preferred list of stowage modes that can be used for that order. Note: You can also define a stowage mode directly on an order and it will override any stowage mode preference rules.
-
transportModeGid: string
The GID for the transportation mode for the consol.
-
updateDate:
updateDate
Read Only:
true
update date -
userDefined1IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
-
userDefined2IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
-
userDefined3IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
-
userDefined4IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
-
userDefined5IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
Nested Schema : allocatedVolume
Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.
Match All
Show Source
Nested Schema : allocatedWeight
Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : bookedVolume
Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
Match All
Show Source
Nested Schema : bookedWeight
Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
Match All
Show Source
Nested Schema : committedVolume
Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.
Match All
Show Source
Nested Schema : committedWeight
Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.
Match All
Show Source
Nested Schema : maxVolume
Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.
Match All
Show Source
Nested Schema : maxWeight
Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.
Match All
Show Source
Nested Schema : producedVolume
Produced volume is a volume values that is not calculated and is user-defined.
Match All
Show Source
Nested Schema : producedWeight
Produced weight is a weight values that is not calculated and is user-defined.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : consols.refnums
Type:
Show Source
object
-
consolRefnumQualGid: string
The GID for the reference number qualifier.
-
consolRefnumValue: string
Value entered for the consol reference number.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : consols.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The GID for the remark qualifier.
-
remarkSequence: number
(int64)
Sequence number for remark - not visible in the UI.
-
remarkText: string
Remark text.
Nested Schema : consols.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status type for the consol status
-
statusValueGid: string
Value of status type