Jump to

• Request
• Response

Get S Ship Units

get

/orderMovements/{orderMovementGid}/sShipUnits

Request

Path Parameters

• orderMovementGid(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/orderMovements.sShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : orderMovements.sShipUnits

Type: object

Show Source

• accessorials: accessorials
• domainName: string
  Database domain where this data is stored.
• lines: lines
• links: array links
  Read Only: true
• pieces: pieces
• refnums: refnums
• remarks: remarks
• seals: seals
• sEquipments: sEquipments
• specialServices: specialServices
• sShipUnitGid: string
  The ship unit identifier joining this ship unit to the order movement.
• trackingEvents: trackingEvents

{
    "properties":{
        "sShipUnitGid":{
            "description":"The ship unit identifier joining this ship unit to the order movement.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "sEquipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.sEquipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "pieces":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.pieces"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : pieces

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.pieces"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sEquipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.sEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.accessorials

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

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 : orderMovements.sShipUnits.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.lines

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

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 : orderMovements.sShipUnits.lines

Type: object

Show Source

• countPerShipUnit: number (int64)
  The count per ship unit.
• declaredValue: declaredValue
  The declared value of the packaged item quantity being shipped.
• domainName: string
  Database domain where this data is stored.
• hazmatItemGid: string
  The GID for the hazmat item.
• hotIndicator: boolean
  A Y/N indicator if the shipment line item is hot.
• itemPackageCount: number (int64)
  The number of packages in this shipment ship unit line for one ship unit. Its shipment ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each shipment ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
• links: array links
  Read Only: true
• marinePollutantIndicator: boolean
  A Y/N indicator if the shipment line item is a marine pollutant.
• orderBaseGid: string
  Read Only: true

  The GID for the order base that is related to the shipment line.
• orderReleaseGid: string
  A unique identifier created by the system for the order release. The GID contains the domain portion.
• orLineGid: string
  A unique identifier to define the multiple order release lines per order release. The GID has the domain portion.
• packagedItemGid: string
  The GID for the packaged item.
• packagingUnitCount: number (int64)
  The packaging unit count for the packaged unit that is being shipped.
• packagingUnitGid: string
  The GID for the packaging unit that is related to the shipment line.
• receivedCountPerShipUnit: number (int64)
  The received count per ship unit. It can be entered as stop debrief. Used for reporting purposes.
• receivedItemPackageCount: number (double)
  The received item package count. It can be entered as a stop debrief.
• receivedPackagingUnitCount: number (int64)
  The received packaging unit count of the shipment line. It can be entered as stop debrief. Used for reporting purposes.
• receivedVolume: receivedVolume
  The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
• receivedWeight: receivedWeight
  The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
• refnums: refnums
• remarks: remarks
• shipUnitGid: string
  The GID for the ship unit that contains this shipping line.
• shipUnitLineNo: number (int32)
  The ship unit line number defined for this shipping line.
• sShipUnitLineNo: number (int64)
  The unique sequence within the ship unit to define the individual line items.
• tOrderReleaseGid: string
  Used as a non-foreign key reference to the order release.
• tOrLineGid: string
  Used as a non-foreign key reference to the order release line.
• trackingTag1: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag2: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag3: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag4: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• tShipUnitGid: string
  Used as a non-foreign key reference to the order release ship unit line.
• tShipUnitLineNo: number (int32)
  Used as a non-foreign key reference to the order release ship unit line.
• userDefined1IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefined2IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefined3IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefinedCommodityGid: string
  Read Only: true

  The user defined commodity identifier associated with the item that is being shipped.
• volume: volume
  The volume of the item.
• volumePer: volumePer
  The weight per shipping line count to handle shipping a multiple count.
• weight: weight
  The weight of the item.
• weightPer: weightPer
  The weight per shipping line count to handle shipping a multiple count.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The unique sequence within the ship unit to define the individual line items.",
            "type":"number",
            "format":"int64"
        },
        "weight":{
            "description":"The weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "trackingTag1":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag2":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag3":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag4":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "orLineGid":{
            "description":"A unique identifier to define the multiple order release lines per order release. The GID has the domain portion.",
            "type":"string"
        },
        "orderReleaseGid":{
            "description":"A unique identifier created by the system for the order release. The GID contains the domain portion.",
            "type":"string"
        },
        "orderBaseGid":{
            "description":"The GID for the order base that is related to the shipment line.",
            "type":"string",
            "readOnly":true
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit that is related to the shipment line.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packaged unit that is being shipped.",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"The number of packages in this shipment ship unit line for one ship unit. Its shipment ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each shipment ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.",
            "type":"number",
            "format":"int64"
        },
        "declaredValue":{
            "description":"The declared value of the packaged item quantity being shipped.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"The GID for the packaged item.",
            "type":"string"
        },
        "hazmatItemGid":{
            "description":"The GID for the hazmat item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight of the shipment line. 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 line. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item package count. It can be entered as a stop debrief.",
            "type":"number",
            "format":"double"
        },
        "shipUnitGid":{
            "description":"The GID for the ship unit that contains this shipping line.",
            "type":"string"
        },
        "shipUnitLineNo":{
            "description":"The ship unit line number defined for this shipping line.",
            "type":"number",
            "format":"int32"
        },
        "weightPer":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volumePer":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "countPerShipUnit":{
            "description":"The count per ship unit.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received packaging unit count of the shipment line. It can be entered as stop debrief. Used for reporting purposes.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received count per ship unit. It can be entered as stop debrief. Used for reporting purposes.",
            "type":"number",
            "format":"int64"
        },
        "tOrderReleaseGid":{
            "description":"Used as a non-foreign key reference to the order release.",
            "type":"string"
        },
        "tOrLineGid":{
            "description":"Used as a non-foreign key reference to the order release line.",
            "type":"string"
        },
        "tShipUnitGid":{
            "description":"Used as a non-foreign key reference to the order release ship unit line.",
            "type":"string"
        },
        "tShipUnitLineNo":{
            "description":"Used as a non-foreign key reference to the order release ship unit line.",
            "type":"number",
            "format":"int32"
        },
        "userDefinedCommodityGid":{
            "description":"The user defined commodity identifier associated with the item that is being shipped.",
            "type":"string",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "marinePollutantIndicator":{
            "description":"A Y/N indicator if the shipment line item is a marine pollutant.",
            "type":"boolean"
        },
        "hotIndicator":{
            "description":"A Y/N indicator if the shipment line item is hot.",
            "type":"boolean"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderMovements.sShipUnits.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared value of the packaged item quantity being shipped.

Match All

Show Source

• object currencyType

{
    "description":"The declared value of the packaged item quantity being shipped.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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 : receivedVolume

The received volume of the shipment line. 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 line. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.

Match All

Show Source

• object amountType

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

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderMovements.sShipUnits.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The volume of the item.

Match All

Show Source

• object amountType

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

Nested Schema : volumePer

The weight per shipping line count to handle shipping a multiple count.

Match All

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the item.

Match All

Show Source

• object amountType

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

Nested Schema : weightPer

The weight per shipping line count to handle shipping a multiple count.

Match All

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.lines.refnums

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

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 : orderMovements.sShipUnits.lines.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The text associated to the remark code.
• sSulRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.

{
    "properties":{
        "sSulRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.lines.remarks

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

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 : orderMovements.sShipUnits.lines.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the shipment.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the shipment.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.pieces

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

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 : orderMovements.sShipUnits.pieces

Type: object

Show Source

• domainName: string
  No description.
• height: height
  No description.
• isSplit: boolean
  To indicate if this is a loading split from the original SSU.
• length: length
  No description.
• links: array links
  Read Only: true
• loadConfig3dPatternGid: string
  Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.
• loadingSequence: number (int32)
  The loading sequence of the SSU singleton.
• orientationGid: string
  Orientation of the ship unit piece.
• patternInstanceCount: number (int32)
  Instance of the user pattern used
• pieceNumber: number (int32)
  A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.
• stackingLayer: number (int32)
  Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.
• totalTopWeight: totalTopWeight
  This is the summation of all weights on the top distributed according to the area touching the pieces
• volume: volume
  No description.
• weight: weight
  No description.
• width: width
  No description.
• xCoordinate: xCoordinate
  The x-coordinate of the unit using container's front lower left corner as the origin.
• yCoordinate: yCoordinate
  The y-coordinate of the unit using container's front lower left corner as the origin.
• zCoordinate: zCoordinate
  The z-coordinate of the unit using container's front lower left corner as the origin.

{
    "properties":{
        "pieceNumber":{
            "description":"A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.",
            "type":"number",
            "format":"int32"
        },
        "loadingSequence":{
            "description":"The loading sequence of the SSU singleton.",
            "type":"number",
            "format":"int32"
        },
        "stackingLayer":{
            "description":"Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.",
            "type":"number",
            "format":"int32"
        },
        "orientationGid":{
            "description":"Orientation of the ship unit piece.",
            "type":"string"
        },
        "xCoordinate":{
            "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "yCoordinate":{
            "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "zCoordinate":{
            "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "totalTopWeight":{
            "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplit":{
            "description":"To indicate if this is a loading split from the original SSU.",
            "type":"boolean"
        },
        "length":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadConfig3dPatternGid":{
            "description":"Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.",
            "type":"string"
        },
        "patternInstanceCount":{
            "description":"Instance of the user pattern used",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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 : totalTopWeight

This is the summation of all weights on the top distributed according to the area touching the pieces

Match All

Show Source

• object amountType

{
    "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : xCoordinate

The x-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : yCoordinate

The y-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : zCoordinate

The z-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.refnums

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

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 : orderMovements.sShipUnits.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The text associated to the remark code.
• sShipUnitRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.

{
    "properties":{
        "sShipUnitRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.remarks

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

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 : orderMovements.sShipUnits.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the shipment.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the shipment.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.seals

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

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 : orderMovements.sShipUnits.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentSeal: string
  The equipment seal number for the shipment ship unit.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentSeal":{
            "description":"The equipment seal number for the shipment ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.sEquipments

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

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 : orderMovements.sShipUnits.sEquipments

Type: object

Show Source

• compartmentNum: number (int32)
  The number associated with the compartment in a multi-compartment equipment. (View Only)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• loadingPatternGid: string
  The loading pattern used to place ship unit into equipment if load configuration algorithm used is pattern based. (View Only)
• loadingSequence: number (int32)
  The sequence that the shipment ship unit is loaded into the equipment. (View Only)
• numLoadingRows: number (int32)
  The number associated with the row the ship unit is placed in. (View Only)
• numStackingLayers: number (int32)
  The number associated with the layer stacked for ship unit. (View Only)
• sEquipmentGid: string
  The GID for the shipment equipment.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the shipment equipment.",
            "type":"string"
        },
        "compartmentNum":{
            "description":"The number associated with the compartment in a multi-compartment equipment. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "loadingSequence":{
            "description":"The sequence that the shipment ship unit is loaded into the equipment. (View Only) ",
            "type":"number",
            "format":"int32"
        },
        "loadingPatternGid":{
            "description":"The loading pattern used to place ship unit into equipment if load configuration algorithm used is pattern based. (View Only) ",
            "type":"string"
        },
        "numStackingLayers":{
            "description":"The number associated with the layer stacked for ship unit. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "numLoadingRows":{
            "description":"The number associated with the row the ship unit is placed in. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.specialServices

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

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 : orderMovements.sShipUnits.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service identifier defining the service to be performed.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service identifier defining the service to be performed.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object orderMovements.sShipUnits.trackingEvents

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

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 : orderMovements.sShipUnits.trackingEvents

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• iTransactionNo: number (int64)
  The transaction identifier linked to the shipment ship unit.
• links: array links
  Read Only: true
• partitionKey: number (double)
  The monthly range partition to manage purging status messages.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier linked to the shipment ship unit.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top