Get Container Groups
get
/shipments/{shipmentGid}/containerGroups
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.containerGroups
Type:
Show Source
object
-
containerGroupGid: string
The GID for the container group.
-
containerGroupXid: string
The XID for the container group.
-
containerReleaseNumber: string
The container release number is assigned once a sea carrier receives a new booking line item. They return the container release number (CRN) corresponding to the new booking.
-
destuffLocationGid: string
The location where the contents will be unloaded (destuffed) from the container.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
referenceCode: string
This field is populated with the reference code that was entered on the unitization rule that was used to create this container.
-
stuffLocationGid: string
The location where the contents will be loaded (stuffed) into the container.
-
unitizationRequestType: string
The unitization request type for this container group that can accept orders with the same unitization request flag and the same stuffing and destuffing location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.containerGroups.details
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sEquipmentGid: string
The GID for the equipment instance on a shipment for this container group.