Jump to

• Request
• Response

Get a Stop

get

/lnmShipments/{shipmentGid}/stops/{stopNum}

Request

Path Parameters

• shipmentGid(required): string
  Resource ID
• stopNum(required): string
  Resource ID

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root 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 : 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 : 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"
        }
    ]
}

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"
        }
    }
}

Back to Top