Jump to

• Request
• Response

Get S Ship Units

get

/shipments/{shipmentGid}/sShipUnits

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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.sShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.sShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.sShipUnits"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : shipments.sShipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The GID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "sShipUnitXid":{
            "description":"The XID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.",
            "type":"string"
        },
        "unitLength":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWidth":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitHeight":{
            "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitVolume":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "isSplitable":{
            "description":"A true or false value to define whether the ship unit can be split when creating the shipments.",
            "type":"boolean"
        },
        "shipUnitCount":{
            "description":"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.",
            "type":"number",
            "format":"int64"
        },
        "earlyPickupDate":{
            "description":"The early pickup date defined for the ship unit",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "receivedWeight":{
            "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedShipUnitCount":{
            "description":"The received item package count. It can be entered as a stop debrief.",
            "type":"number",
            "format":"double"
        },
        "shipUnitGid":{
            "description":"The GID for the order release ship unit that is associated to this shipment ship unit.",
            "type":"string"
        },
        "unitNetWeight":{
            "description":"The unit net weight of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitNetVolume":{
            "description":"The unit net volume of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetWeight":{
            "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetVolume":{
            "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag2":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag3":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag4":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tShipUnitGid":{
            "description":"A GID for the order release ship unit.",
            "type":"string"
        },
        "isCountSplittable":{
            "description":"Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.",
            "type":"boolean"
        },
        "totalGrossWeight":{
            "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalGrossVolume":{
            "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rangeStart":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "rangeEnd":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "releaseMethodGid":{
            "description":"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.",
            "type":"string"
        },
        "isAllowRepack":{
            "description":"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. ",
            "type":"boolean"
        },
        "totalLoadingSplitWeight":{
            "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalLoadingSplitVolume":{
            "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "priority":{
            "description":"Defines the priority associated with ship unit.",
            "type":"number",
            "format":"int32"
        },
        "isFixedEruCount":{
            "description":"Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : earlyPickupDate

The early pickup date defined for the ship unit

Match All

Show Source

• object dateTimeType

{
    "description":"The early pickup date defined for the ship unit",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

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

• object amountType

{
    "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossVolume

The total gross volume of the shipment ship unit (transport handling unit + lines).

Match All

Show Source

• object amountType

{
    "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossWeight

The total gross weight of the shipment ship unit (transport handling unit + lines).

Match All

Show Source

• object amountType

{
    "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitDiameter

For cylindrical objects, this defines the diameter of the ship unit.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetVolume

The unit net volume of the goods contained in the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The unit net volume of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetWeight

The unit net weight of the goods contained in the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The unit net weight of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWeight

The weight of the ship unit.

Match All

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top