Jump to

• Request
• Response

Create a Consol

post

/consols

Request

Header Parameters

• Prefer:
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "consolGid":{
            "description":"The GID for the consol.",
            "type":"string"
        },
        "consolXid":{
            "description":"The XID for the consol.",
            "type":"string"
        },
        "consolType":{
            "description":"Consol type can be Charter Voyage Stowage, Flight, or Ocean FCL.",
            "type":"string"
        },
        "charterVoyageGid":{
            "description":"The GID for the charter voyage associated with the consol. Charter voyage is assigned for consol type of Charter Voyage Stowage.",
            "type":"string"
        },
        "stowageModeGid":{
            "description":"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.",
            "type":"string"
        },
        "allocatedWeight":{
            "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedVolume":{
            "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedNumTeu":{
            "description":"Allocated TEU represents the original agreed-upon twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "allocatedNumFeu":{
            "description":"Allocated FEU represents the original agreed-upon forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxWeight":{
            "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxNumTeu":{
            "description":"Maximum number of TEU represents the maximum twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxNumFeu":{
            "description":"Maximum FEU represents the maximum forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "committedWeight":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedVolume":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedNumTeu":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "committedNumFeu":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "bookedWeight":{
            "description":"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).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedVolume":{
            "description":"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).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedNumTeu":{
            "description":"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).",
            "type":"number",
            "format":"double"
        },
        "bookedNumFeu":{
            "description":"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).",
            "type":"number",
            "format":"double"
        },
        "producedWeight":{
            "description":"Produced weight is a weight values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedVolume":{
            "description":"Produced volume is a volume values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedNumTeu":{
            "description":"Produced TEU is a TEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "producedNumFeu":{
            "description":"Produced FEU is a FEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance ID this consol is created from when the consol is a flight consol.",
            "type":"number",
            "format":"int64"
        },
        "hazmatType":{
            "description":"Hazmat type. One of three values: HAZMAT ONLY, NO HAZMAT, HAZMAT ALLOWED.",
            "type":"string"
        },
        "itineraryProfileGid":{
            "description":"The GID for the assigned itinerary profile. The itinerary profile defines the consol's applicability to legs.",
            "type":"string"
        },
        "consolidationTypeGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "placeReceiptLocationGid":{
            "description":"Specifies a place of receipt location other than the port of loading. If specified this will add a stop to the consol shipment created.",
            "type":"string"
        },
        "placeDeliverLocationGid":{
            "description":"Specifies a place of delivery other than the port of discharge. If specified this will add a stop to the consol shipment created.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The port of loading for transport.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The port of discharge for transport.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The GID for the incoterms associated with the consol.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the carrier. If blank, look at the voyage table.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transportation mode for the consol.",
            "type":"string"
        },
        "intendedVesselGid":{
            "description":"The intended vessel gid. The vessel gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedVoyageGid":{
            "description":"The intended voyage gid. The voyage gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedDepartureTime":{
            "description":"Intended estimated time of departure.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "intendedArrivalTime":{
            "description":"Intended estimated time of arrival.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code. E.g.. the HTS, NMFC, SITC, STCC codes.",
            "type":"string"
        },
        "oneShipmentPerContainer":{
            "description":"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'.",
            "type":"boolean"
        },
        "flexCommodityProfileGid":{
            "description":"The flexible commodity profile ID that associates to the consol.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment group reference unit being defined.",
            "type":"string"
        },
        "maxNumReferenceUnits":{
            "description":"The maximum number of equipment reference units that can be held in the consol.",
            "type":"number",
            "format":"double"
        },
        "maxNumEquipment":{
            "description":"The maximum number of equipment that can be held in the consol.",
            "type":"number",
            "format":"int32"
        },
        "intendedGroundServiceGid":{
            "description":"The intended ground service gid. The ground service gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedVolume

Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : allocatedWeight

Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object amountType

{
    "description":"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).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : intendedArrivalTime

Intended estimated time of arrival.

Match All

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of arrival.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : intendedDepartureTime

Intended estimated time of departure.

Match All

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of departure.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : producedVolume

Produced volume is a volume values that is not calculated and is user-defined.

Match All

Show Source

• object amountType

{
    "description":"Produced volume is a volume values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : producedWeight

Produced weight is a weight values that is not calculated and is user-defined.

Match All

Show Source

• object amountType

{
    "description":"Produced weight is a weight values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.refnums

Type: object

Show Source

• 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

{
    "properties":{
        "consolRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "consolRefnumValue":{
            "description":"Value entered for the consol reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for remark - not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.statuses

Type: object

Show Source

• 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

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the consol status",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "consolGid":{
            "description":"The GID for the consol.",
            "type":"string"
        },
        "consolXid":{
            "description":"The XID for the consol.",
            "type":"string"
        },
        "consolType":{
            "description":"Consol type can be Charter Voyage Stowage, Flight, or Ocean FCL.",
            "type":"string"
        },
        "charterVoyageGid":{
            "description":"The GID for the charter voyage associated with the consol. Charter voyage is assigned for consol type of Charter Voyage Stowage.",
            "type":"string"
        },
        "stowageModeGid":{
            "description":"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.",
            "type":"string"
        },
        "allocatedWeight":{
            "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedVolume":{
            "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedNumTeu":{
            "description":"Allocated TEU represents the original agreed-upon twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "allocatedNumFeu":{
            "description":"Allocated FEU represents the original agreed-upon forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxWeight":{
            "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxNumTeu":{
            "description":"Maximum number of TEU represents the maximum twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxNumFeu":{
            "description":"Maximum FEU represents the maximum forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "committedWeight":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedVolume":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedNumTeu":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "committedNumFeu":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "bookedWeight":{
            "description":"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).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedVolume":{
            "description":"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).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedNumTeu":{
            "description":"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).",
            "type":"number",
            "format":"double"
        },
        "bookedNumFeu":{
            "description":"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).",
            "type":"number",
            "format":"double"
        },
        "producedWeight":{
            "description":"Produced weight is a weight values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedVolume":{
            "description":"Produced volume is a volume values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedNumTeu":{
            "description":"Produced TEU is a TEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "producedNumFeu":{
            "description":"Produced FEU is a FEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance ID this consol is created from when the consol is a flight consol.",
            "type":"number",
            "format":"int64"
        },
        "hazmatType":{
            "description":"Hazmat type. One of three values: HAZMAT ONLY, NO HAZMAT, HAZMAT ALLOWED.",
            "type":"string"
        },
        "itineraryProfileGid":{
            "description":"The GID for the assigned itinerary profile. The itinerary profile defines the consol's applicability to legs.",
            "type":"string"
        },
        "consolidationTypeGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "placeReceiptLocationGid":{
            "description":"Specifies a place of receipt location other than the port of loading. If specified this will add a stop to the consol shipment created.",
            "type":"string"
        },
        "placeDeliverLocationGid":{
            "description":"Specifies a place of delivery other than the port of discharge. If specified this will add a stop to the consol shipment created.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The port of loading for transport.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The port of discharge for transport.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The GID for the incoterms associated with the consol.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the carrier. If blank, look at the voyage table.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transportation mode for the consol.",
            "type":"string"
        },
        "intendedVesselGid":{
            "description":"The intended vessel gid. The vessel gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedVoyageGid":{
            "description":"The intended voyage gid. The voyage gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedDepartureTime":{
            "description":"Intended estimated time of departure.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "intendedArrivalTime":{
            "description":"Intended estimated time of arrival.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code. E.g.. the HTS, NMFC, SITC, STCC codes.",
            "type":"string"
        },
        "oneShipmentPerContainer":{
            "description":"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'.",
            "type":"boolean"
        },
        "flexCommodityProfileGid":{
            "description":"The flexible commodity profile ID that associates to the consol.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment group reference unit being defined.",
            "type":"string"
        },
        "maxNumReferenceUnits":{
            "description":"The maximum number of equipment reference units that can be held in the consol.",
            "type":"number",
            "format":"double"
        },
        "maxNumEquipment":{
            "description":"The maximum number of equipment that can be held in the consol.",
            "type":"number",
            "format":"int32"
        },
        "intendedGroundServiceGid":{
            "description":"The intended ground service gid. The ground service gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedVolume

Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : allocatedWeight

Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object amountType

{
    "description":"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).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : intendedArrivalTime

Intended estimated time of arrival.

Match All

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of arrival.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : intendedDepartureTime

Intended estimated time of departure.

Match All

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of departure.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Show Source

• object amountType

{
    "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : producedVolume

Produced volume is a volume values that is not calculated and is user-defined.

Match All

Show Source

• object amountType

{
    "description":"Produced volume is a volume values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : producedWeight

Produced weight is a weight values that is not calculated and is user-defined.

Match All

Show Source

• object amountType

{
    "description":"Produced weight is a weight values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.refnums

Type: object

Show Source

• 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

{
    "properties":{
        "consolRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "consolRefnumValue":{
            "description":"Value entered for the consol reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for remark - not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object consols.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : consols.statuses

Type: object

Show Source

• 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

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the consol status",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top