Create a S Ship Unit
post
/shipments/{shipmentGid}/sShipUnits
Request
Path Parameters
-
shipmentGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
Type:
Show Source
object
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
links: array
links
Read Only:
true
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
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 : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Root Schema : schema
Type:
Show Source
object
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
links: array
links
Read Only:
true
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
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 : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
links: array
links
Read Only:
true
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
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 : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format