Get Shipment Equipment
get
/shipments/{shipmentGid}/sEquipments
Request
Path Parameters
-
shipmentGid(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.sEquipments
Type:
Show Source
object
-
capacityUsageGid: string
The capacity usage GID that was used for the shipment.
-
domainName: string
Database domain where this data is stored.
-
dropoffStopNum: number
(int32)
The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.
-
links: array
links
Read Only:
true
-
pickupStopNum: number
(int32)
The stop number where the equipment is picked up. It is null if not picked up in this shipment.
-
sEquipmentGid: string
The GID for the equipment associated with the shipment.
-
sEquipmentIndex: number
(int32)
The standing order of the equipment on the shipment.