Get Details
get
/shipments/{shipmentGid}/stops/{stopNum}/details
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.
-
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 : shipments.stops.details
Type:
Show Source
object
-
activity: string
The activity performed at the stop. For example: pickup, delivery, etc.
-
activityTime:
activityTime
The time spent performing the activity at the shipment stop.
-
domainName: string
Date and time of the most recent data update.
-
involvedParties:
involvedParties
-
isPermanent: boolean
A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
-
links: array
links
Read Only:
true
-
shipUnitDwellTime:
shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
-
sShipUnitGid: string
A GID to define the shipment ship unit.
Nested Schema : activityTime
The time spent performing the activity at the shipment stop.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : shipments.stops.details.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact ID for the involved party.
-
involvedPartyQualGid: string
The qualifier ID for the involved party.
-
links: array
links
Read Only:
true