Jump to

• Request
• Response

Get Lnm Shipments

get

/lnmShipments

Request

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/lnmShipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object lnmShipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lnmShipments"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : lnmShipments

Type: object

Show Source

• actualCo2Emission: actualCo2Emission
  Actual CO2 emissions for the shipment.
• actualCo2EqEmission: actualCo2EqEmission
  Actual CO2 equivalent emissions for the shipment.
• airRailRouteCode: string
  No description.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeCurrency1: number (double)
  No description.
• attributeCurrency1Base: number (double)
  No description.
• attributeCurrency1Gid: string
  No description.
• attributeCurrency2: number (double)
  No description.
• attributeCurrency2Base: number (double)
  No description.
• attributeCurrency2Gid: string
  No description.
• attributeCurrency3: number (double)
  No description.
• attributeCurrency3Base: number (double)
  No description.
• attributeCurrency3Gid: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• bulkPlanGid: string
  If the shipment was planned via the bulk plan process, then the global identifier for the bulk plan.
• bulkplanSpecGid: string
  No description.
• checkCapacityConstraint: boolean
  No description.
• checkCostConstraint: boolean
  No description.
• checkTimeConstraint: boolean
  No description.
• cmCost: cmCost
  The shipment cost when the shipment is part of a CM tour.
• cmEmptyDistance: cmEmptyDistance
  The empty leg distance between previous and this shipments
• cmName: string
  SHIPMENT_GID of the first shipment in the tour. If the CM tour is received as input to GC3, this is the supplied tour id
• cmNextSourceLocationGid: string
  Source LOCATION_GID of the next shipment in the CM tour
• cmPrevDestLocationGid: string
  Destination LOCATION_GID of the previous shipment in the CM tour.
• cmSequenceNum: number (int32)
  Indicates the shipment's sequence in the CM tour
• costs: costs
• destLocationGid: string
  The global identifier of the destination location of the shipment.
• domainName: string
  No description.
• dutyPaid: string
  No description.
• endTime: endTime
  This is the time the shipment is delievered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
• equipRefUnitUtilization: number (double)
  No description.
• firstEquipmentGroupGid: string
  No description.
• hasAppointments: boolean
  Indicates if any stops on the shipment have appointments
• insertDate: insertDate
  Read Only: true

  insert date
• inTrailerBuild: boolean
  Flag indicating whether this shipment is in a Trailer Build shipment group
• isAutoMergeConsolidate: boolean
  No description.
• isCostFixed: boolean
  Indicates shipment cost is a fixed cost.
• isCreditNote: boolean
  No description.
• isEquipmentFixed: boolean
  Is_Equipment_Fixed is used to check if a service provider can update the equipment_number and equipment_initials when accepting a tendered shipment.
• isFixedDistance: boolean
  Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total_loaded_distance field
• isFixedTenderContact: boolean
  No description.
• isFixedVoyage: boolean
  No description.
• isHazardous: boolean
  No description.
• isPreferredCarrier: boolean
  Flag indicating whether the carrier selected for the shipment is preferred.
• isPreload: boolean
  No description.
• isPrimary: boolean
  No description.
• isRateGeoFixed: boolean
  User assigned rate geo is fixed.
• isRateOfferingFixed: boolean
  User assigned rate offering is fixed.
• isRecalcTotals: boolean
  Turns on/off totaling logic
• isServiceTimeFixed: boolean
  No description.
• isServprovFixed: boolean
  No description.
• isSpotCosted: boolean
  Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
• isTemperatureControl: boolean
  No description.
• isTemplate: boolean
  Indicates whether a shipment is a template.
• isToBeHeld: boolean
  No description.
• itineraryGid: string
  No description.
• links: array links
  Read Only: true
• loadedDistance: loadedDistance
  No description.
• numEquipment: number (double)
  No description.
• numOrderReleases: number (int32)
  Number of order releases that are on this shipment.
• numStops: number (int32)
  Number of shipment_stop records related to this shipment.
• originalShipmentGid: string
  OTM Shipment GID
• parentLegGid: string
  No description.
• perspective: string
  No description.
• plannedCo2Emission: plannedCo2Emission
  CO2 emissions recorded while planning the shipment.
• plannedCo2EqEmission: plannedCo2EqEmission
  CO2 equivalent emissions recorded while planning the shipment.
• planningParameterSetGid: string
  This column holds the planning parameter set gid which is used in building this shipment
• rateGeoGid: string
  No description.
• rateOfferingGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• rule7: boolean
  Y,N NOTIFICATION FROM SHIPPER TO CARRIER THAT SHIPPER IS NOT LIABLE FOR FREIGHT CHARGES.
• scenarioGid: string
  No description.
• servprovGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• shipmentAsWork: boolean
  Flag to indicate the shipment as work
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• shipmentReleased: boolean
  Y/N, USED IN RAIL SHIPPING TO INDICATE THAT THE SHIPMENT IS READY.
• shipmentXid: string
  A system generated unique identifier for the shipment withoout the domain.
• sourceLocationGid: string
  The global identifier of the source location of the shipment.
• startTime: startTime
  The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
• stops: stops
• totalActualCost: totalActualCost
  This field stores the total actual cost of the shipment.
• totalHours: number (double)
  No description.
• totalItemPackageCount: number (int32)
  Summary of ITEM_PACKAGE_COUNT of all line items.
• totalNetVolume: totalNetVolume
  No description.
• totalNetWeight: totalNetWeight
  No description.
• totalPackagingUnitCount: number (int32)
  No description.
• totalShipUnitCount: number (int64)
  No description.
• totalVolume: totalVolume
  No description.
• totalWeight: totalWeight
  No description.
• totalWeightedCost: totalWeightedCost
  No description.
• transportModeGid: string
  A unique identifier to define the transportation modes. (includes the domain name as part of the key)
• unloadedDistance: unloadedDistance
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• volumeUtilization: number (double)
  No description.
• weighCode: string
  THE TYPE OF WEIGHT.
• weightUtilization: number (double)
  No description.
• workAssignmentBulkPlanGid: string
  Work assignment bulk plan ID which is generated during work assignment bulk plan process.

{
    "properties":{
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentXid":{
            "description":"A system generated unique identifier for the shipment withoout the domain.",
            "type":"string"
        },
        "bulkPlanGid":{
            "description":"If the shipment was planned via the bulk plan process, then the global identifier for the bulk plan.",
            "type":"string"
        },
        "perspective":{
            "description":"No description.",
            "type":"string"
        },
        "itineraryGid":{
            "description":"No description.",
            "type":"string"
        },
        "parentLegGid":{
            "description":"No description.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The global identifier of the source location of the shipment.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The global identifier of the destination location of the shipment.",
            "type":"string"
        },
        "servprovGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation modes. (includes the domain name as part of the key)",
            "type":"string"
        },
        "firstEquipmentGroupGid":{
            "description":"No description.",
            "type":"string"
        },
        "startTime":{
            "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"This is the time the shipment is delievered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "planningParameterSetGid":{
            "description":"This column holds the planning parameter set gid which is used in building this shipment",
            "type":"string"
        },
        "totalActualCost":{
            "description":"This field stores the total actual cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "numOrderReleases":{
            "description":"Number of order releases that are on this shipment.",
            "type":"number",
            "format":"int32"
        },
        "numStops":{
            "description":"Number of shipment_stop records related to this shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalShipUnitCount":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "totalPackagingUnitCount":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "totalItemPackageCount":{
            "description":"Summary of ITEM_PACKAGE_COUNT of all line items.",
            "type":"number",
            "format":"int32"
        },
        "numEquipment":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "totalWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightUtilization":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "volumeUtilization":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "equipRefUnitUtilization":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "totalHours":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "rateOfferingGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Indicates whether a shipment is a template.",
            "type":"boolean"
        },
        "isPrimary":{
            "description":"No description.",
            "type":"boolean"
        },
        "isSpotCosted":{
            "description":"Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.",
            "type":"boolean"
        },
        "isCreditNote":{
            "description":"No description.",
            "type":"boolean"
        },
        "isAutoMergeConsolidate":{
            "description":"No description.",
            "type":"boolean"
        },
        "shipmentAsWork":{
            "description":"Flag to indicate the shipment as work",
            "type":"boolean"
        },
        "checkTimeConstraint":{
            "description":"No description.",
            "type":"boolean"
        },
        "checkCostConstraint":{
            "description":"No description.",
            "type":"boolean"
        },
        "checkCapacityConstraint":{
            "description":"No description.",
            "type":"boolean"
        },
        "cmPrevDestLocationGid":{
            "description":"Destination LOCATION_GID of the previous shipment in the CM tour.",
            "type":"string"
        },
        "cmNextSourceLocationGid":{
            "description":"Source LOCATION_GID of the next shipment in the CM tour",
            "type":"string"
        },
        "cmName":{
            "description":"SHIPMENT_GID of the first shipment in the tour. If the CM tour is received as input to GC3, this is the supplied tour id",
            "type":"string"
        },
        "cmSequenceNum":{
            "description":"Indicates the shipment's sequence in the CM tour",
            "type":"number",
            "format":"int32"
        },
        "cmCost":{
            "description":"The shipment cost when the shipment is part of a CM tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "cmEmptyDistance":{
            "description":"The empty leg distance between previous and this shipments",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weighCode":{
            "description":"THE TYPE OF WEIGHT.",
            "type":"string"
        },
        "rule7":{
            "description":"Y,N NOTIFICATION FROM SHIPPER TO CARRIER THAT SHIPPER IS NOT LIABLE FOR FREIGHT CHARGES.",
            "type":"boolean"
        },
        "shipmentReleased":{
            "description":"Y/N, USED IN RAIL SHIPPING TO INDICATE THAT THE SHIPMENT IS READY.",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"No description.",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"No description.",
            "type":"boolean"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "isServiceTimeFixed":{
            "description":"No description.",
            "type":"boolean"
        },
        "isRateGeoFixed":{
            "description":"User assigned rate geo is fixed.",
            "type":"boolean"
        },
        "isRateOfferingFixed":{
            "description":"User assigned rate offering is fixed.",
            "type":"boolean"
        },
        "isServprovFixed":{
            "description":"No description.",
            "type":"boolean"
        },
        "isPreload":{
            "description":"No description.",
            "type":"boolean"
        },
        "isFixedTenderContact":{
            "description":"No description.",
            "type":"boolean"
        },
        "isToBeHeld":{
            "description":"No description.",
            "type":"boolean"
        },
        "isPreferredCarrier":{
            "description":"Flag indicating whether the carrier selected for the shipment is preferred.",
            "type":"boolean"
        },
        "isEquipmentFixed":{
            "description":"Is_Equipment_Fixed is used to check if a service provider can update the equipment_number and equipment_initials when accepting a tendered shipment.",
            "type":"boolean"
        },
        "isRecalcTotals":{
            "description":"Turns on/off totaling logic",
            "type":"boolean"
        },
        "hasAppointments":{
            "description":"Indicates if any stops on the shipment have appointments",
            "type":"boolean"
        },
        "inTrailerBuild":{
            "description":"Flag indicating whether this shipment is in a Trailer Build shipment group",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"No description.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"Boolean, defaults to N.  When set to Y, this flag indicates a user-entered value for the total_loaded_distance field",
            "type":"boolean"
        },
        "isFixedVoyage":{
            "description":"No description.",
            "type":"boolean"
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeCurrency1Base":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeCurrency1Gid":{
            "description":"No description.",
            "type":"string"
        },
        "attributeCurrency2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeCurrency2Base":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeCurrency2Gid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attributeCurrency3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeCurrency3Gid":{
            "description":"No description.",
            "type":"string"
        },
        "attributeCurrency3Base":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "loadedDistance":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unloadedDistance":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rateGeoGid":{
            "description":"No description.",
            "type":"string"
        },
        "airRailRouteCode":{
            "description":"No description.",
            "type":"string"
        },
        "workAssignmentBulkPlanGid":{
            "description":"Work assignment bulk plan ID which is generated during work assignment bulk plan process.",
            "type":"string"
        },
        "originalShipmentGid":{
            "description":"OTM Shipment GID",
            "type":"string"
        },
        "plannedCo2Emission":{
            "description":"CO2 emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2Emission":{
            "description":"Actual CO2 emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCo2EqEmission":{
            "description":"CO2 equivalent emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2EqEmission":{
            "description":"Actual CO2 equivalent emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/lnmShipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/lnmShipments.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Actual CO2 emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Actual CO2 equivalent emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a CM tour.

Match All

The shipment cost when the shipment is part of a CM tour.

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a CM tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments

Match All

The empty leg distance between previous and this shipments

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

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

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

Nested Schema : endTime

This is the time the shipment is delievered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Match All

This is the time the shipment is delievered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Show Source

• object dateTimeType

{
    "description":"This is the time the shipment is delievered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : loadedDistance

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

CO2 emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

CO2 equivalent emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startTime

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Match All

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Show Source

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : stops

Type: object

Show Source

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

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

Nested Schema : totalActualCost

This field stores the total actual cost of the shipment.

Match All

This field stores the total actual cost of the shipment.

Show Source

• object currencyType

{
    "description":"This field stores the total actual cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalVolume

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeightedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unloadedDistance

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

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 : 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 : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object lnmShipments.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lnmShipments.costs"
    }
}

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 : lnmShipments.costs

Type: object

Show Source

• accessorialCodeDesc: string
  No description.
• accessorialCodeGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• bulkplanGid: string
  No description.
• bulkplanSpecGid: string
  No description.
• cost: cost
  The cost as it releates to the cost type for the shipment.
• costType: string
  C, A, B
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• isCostFixed: boolean
  Indicates shipment cost is a fixed cost.
• isWeighted: boolean
  Whether or not the cost affects the total weighted cost of the shipment only
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  Override for record to be copied to the sell side during rating.
• scenarioGid: string
  No description.
• shipmentCostSeqNo: number (int64)
  A system generated unique sequence number to define the shipment costs.

{
    "properties":{
        "shipmentCostSeqNo":{
            "description":"A system generated unique sequence number to define the  shipment costs.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"The cost as it releates to the cost type for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "accessorialCodeDesc":{
            "description":"No description.",
            "type":"string"
        },
        "costType":{
            "description":"C, A, B",
            "type":"string"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"Override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "isWeighted":{
            "description":"Whether or not the cost affects the total weighted cost of the shipment only",
            "type":"boolean"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost as it releates to the cost type for the shipment.

Match All

The cost as it releates to the cost type for the shipment.

Show Source

• object currencyType

{
    "description":"The cost as it releates to the cost type for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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 : items

Type: array

Show Source

• Array of: object lnmShipments.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lnmShipments.stops"
    }
}

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 : lnmShipments.stops

Type: object

Show Source

• accessorialTime: accessorialTime
  The sum of fixed_accessorial_time for a particular stop.
• activityTime: activityTime
  The time spent at the stop for pickup or delivery.
• arbitraryType: string
  SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• bulkplanGid: string
  No description.
• bulkplanSpecGid: string
  No description.
• details: details
• distFromPrevStop: distFromPrevStop
  The distance from the last stop.
• domainName: string
  No description.
• driverNonPayable: boolean
  Allows the user to specify that stop is payable or not.
• driveTime: driveTime
  The drive time to teh stop from the last stop.
• isDepot: boolean
  No description.
• isFixedArrival: boolean
  No description.
• isFixedDeparture: boolean
  No description.
• isFixedDistance: boolean
  When set to Y, indicates the existence of a user-entered value for the dis_from_prev_stop field
• isMotherVessel: boolean
  Desginating a leg as mother vessel to automatically populated header.
• isPermanent: boolean
  No description.
• links: array links
  Read Only: true
• locationGid: string
  A unique identifier to define the locations withing GC3. The gid contains the domain portion.
• plannedArrival: plannedArrival
  The planned date and time of arrival at the stop.
• plannedDeparture: plannedDeparture
  The planned departure date and time at the stop.
• restTime: restTime
  The time the truck or the transportation mode should take for rest at the stop.
• routeCodeGid: string
  No description.
• rushHourTime: rushHourTime
  No description.
• scenarioGid: string
  No description.
• stopNum: number (int32)
  This field defines the stop number within the shipment. Stop Num = 1 is the Pickup stop, and the max (Stop Num) for a shipment is the delivery stop.
• stopType: string
  Define the type of this stop.
• waitTime: waitTime
  The time the truck or the transportation mode has to wait at the stop.

{
    "properties":{
        "stopNum":{
            "description":"This field defines the stop number within the shipment. Stop Num = 1 is the Pickup stop, and the max (Stop Num) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "locationGid":{
            "description":"A unique identifier to define the locations withing GC3. The gid contains the domain portion.",
            "type":"string"
        },
        "stopType":{
            "description":"Define the type of this stop.",
            "type":"string"
        },
        "plannedArrival":{
            "description":"The planned date and time of arrival at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDeparture":{
            "description":"The planned departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedArrival":{
            "description":"No description.",
            "type":"boolean"
        },
        "isFixedDeparture":{
            "description":"No description.",
            "type":"boolean"
        },
        "isPermanent":{
            "description":"No description.",
            "type":"boolean"
        },
        "isDepot":{
            "description":"No description.",
            "type":"boolean"
        },
        "isFixedDistance":{
            "description":"When set to Y, indicates the existence of a user-entered value for the dis_from_prev_stop field",
            "type":"boolean"
        },
        "isMotherVessel":{
            "description":"Desginating a leg as mother vessel to automatically populated header.",
            "type":"boolean"
        },
        "driverNonPayable":{
            "description":"Allows the user to specify that stop is payable or not.",
            "type":"boolean"
        },
        "waitTime":{
            "description":"The time the truck or the transportation mode has to wait at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "restTime":{
            "description":"The time the truck or the transportation mode should take for rest at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "driveTime":{
            "description":"The drive time to teh stop from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distFromPrevStop":{
            "description":"The distance from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "activityTime":{
            "description":"The time spent at the stop for pickup or delivery.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "accessorialTime":{
            "description":"The sum of fixed_accessorial_time for a particular stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rushHourTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanGid":{
            "description":"No description.",
            "type":"string"
        },
        "arbitraryType":{
            "description":"SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.",
            "type":"string"
        },
        "routeCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/lnmShipments.stops.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorialTime

The sum of fixed_accessorial_time for a particular stop.

Match All

The sum of fixed_accessorial_time for a particular stop.

Show Source

• object amountType

{
    "description":"The sum of fixed_accessorial_time for a particular stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTime

The time spent at the stop for pickup or delivery.

Match All

The time spent at the stop for pickup or delivery.

Show Source

• object amountType

{
    "description":"The time spent at the stop for pickup or delivery.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/lnmShipments.stops.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distFromPrevStop

The distance from the last stop.

Match All

The distance from the last stop.

Show Source

• object amountType

{
    "description":"The distance from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driveTime

The drive time to teh stop from the last stop.

Match All

The drive time to teh stop from the last stop.

Show Source

• object amountType

{
    "description":"The drive time to teh stop from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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 : plannedArrival

The planned date and time of arrival at the stop.

Match All

The planned date and time of arrival at the stop.

Show Source

• object dateTimeType

{
    "description":"The planned date and time of arrival at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : plannedDeparture

The planned departure date and time at the stop.

Match All

The planned departure date and time at the stop.

Show Source

• object dateTimeType

{
    "description":"The planned departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : restTime

The time the truck or the transportation mode should take for rest at the stop.

Match All

The time the truck or the transportation mode should take for rest at the stop.

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode should take for rest at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : rushHourTime

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waitTime

The time the truck or the transportation mode has to wait at the stop.

Match All

The time the truck or the transportation mode has to wait at the stop.

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode has to wait at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object lnmShipments.stops.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lnmShipments.stops.details"
    }
}

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 : lnmShipments.stops.details

Type: object

Show Source

• activity: string
  The activity performed at the stop. For example: Pickup, Delivery etc.
• activityTime: activityTime
  No description.
• bulkplanGid: string
  No description.
• bulkplanSpecGid: string
  No description.
• domainName: string
  No description.
• isPermanent: boolean
  No description.
• links: array links
  Read Only: true
• scenarioGid: string
  No description.
• shipUnitDwellTime: shipUnitDwellTime
  This field represents ship unit dwell time at the stop location as entered.
• sShipUnitGid: string
  A unique pointer to define the shipment ship unit. The gid contains the domain portion.

{
    "properties":{
        "sShipUnitGid":{
            "description":"A unique pointer to define the shipment ship unit. The gid contains the domain portion.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop.   For example:  Pickup,  Delivery etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"No description.",
            "type":"boolean"
        },
        "shipUnitDwellTime":{
            "description":"This field represents ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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 : shipUnitDwellTime

This field represents ship unit dwell time at the stop location as entered.

Match All

This field represents ship unit dwell time at the stop location as entered.

Show Source

• object amountType

{
    "description":"This field represents ship unit dwell time at the stop location as entered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Back to Top