Get Stops
get
/orderReleases/{orderReleaseGid}/stops
Request
Path Parameters
-
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.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : orderReleases.stops
Type:
Show Source
object
-
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
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
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
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : orderReleases.stops.remarks
Type:
Show Source
object
-
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.
Nested Schema : orderReleases.stops.specialServices
Type:
Show Source
object
-
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.
Nested Schema : time
The duration required for the special service at the stop.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount