Jump to

• Request
• Response

Get a Stop

get

/orderReleases/{orderReleaseGid}/stops/{orStopGid}

Request

Path Parameters

• orStopGid(required): string
  Resource ID
• orderReleaseGid(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 : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• earlyArrivalTime: earlyArrivalTime
  The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.
• isAppt: boolean
  A Y/N field indicating that the times are for appointments, when IS_APPT is Y, EARLY/LATE_ARRIVAL_TIME are appointment times.
• isApptConfirmed: boolean
  A Y/N field to indicate the appointment is confirmed.
• isApptConfirmRequired: boolean
  A Y/N field to indicate if appointment confirmation is required.
• isApptRequired: boolean
  A Y/N field to indicate if appointment is required.
• lateArrivalTime: lateArrivalTime
  The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.
• legPosition: string
  Define where to insert this stop in a multi-stop situation.
• links: array links
  Read Only: true
• locationGid: string
  The location GID for the shipment stop.
• orStopGid: string
  The GID for the stop associated to the order release for multi-stop orders.
• orStopSeq: number (int32)
  The stop number within the order release. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• orStopXid: string
  The XID for the stop associated to the order release for multi-stop orders.
• remarks: remarks
• specialServices: specialServices

{
    "properties":{
        "orStopGid":{
            "description":"The GID for the stop associated to the order release for multi-stop orders.",
            "type":"string"
        },
        "orStopXid":{
            "description":"The XID for the stop associated to the order release for multi-stop orders.",
            "type":"string"
        },
        "orStopSeq":{
            "description":"The stop number within the order release. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The location GID for the shipment stop.",
            "type":"string"
        },
        "earlyArrivalTime":{
            "description":"The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateArrivalTime":{
            "description":"The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isAppt":{
            "description":"A Y/N field indicating that the times are for appointments, when IS_APPT is Y, EARLY/LATE_ARRIVAL_TIME are appointment times.",
            "type":"boolean"
        },
        "isApptRequired":{
            "description":"A Y/N field to indicate if appointment is required.",
            "type":"boolean"
        },
        "isApptConfirmRequired":{
            "description":"A Y/N field to indicate if appointment confirmation is required.",
            "type":"boolean"
        },
        "isApptConfirmed":{
            "description":"A Y/N field to indicate the appointment is confirmed.",
            "type":"boolean"
        },
        "legPosition":{
            "description":"Define where to insert this stop in a multi-stop situation.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.stops.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.stops.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : earlyArrivalTime

The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.

Match All

Show Source

• object dateTimeType

{
    "description":"The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lateArrivalTime

The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.

Match All

Show Source

• object dateTimeType

{
    "description":"The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : specialServices

Type: object

Show Source

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

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

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

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : items

Type: array

Show Source

• Array of: object orderReleases.stops.remarks

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : orderReleases.stops.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  A user-entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object orderReleases.stops.specialServices

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

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 : orderReleases.stops.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service code identifier defining the service required.
• time: time
  The duration required for the special service at the stop.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service code identifier defining the service required.",
            "type":"string"
        },
        "time":{
            "description":"The duration required for the special service at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : time

The duration required for the special service at the stop.

Match All

Show Source

• object amountType

{
    "description":"The duration required for the special service 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"
        }
    }
}

Back to Top