Jump to

• Request
• Response

Get Shipment Groups

get

/shipmentGroups

Request

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/shipmentGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipmentGroups

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : shipmentGroups

Type: object

Show Source

• appointmentPriorityGid: string
  shipment group appointment priority used for dock scheduling priority feature
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• destLocationGid: string
  The destination location of the shipment group.
• domainName: string
  No description.
• endTime: endTime
  Indicates the end time of the shipment group.
• equipmentGroupGid: string
  Indicates the equipment group ID for trailer build.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• links: array links
  Read Only: true
• numberOfShipments: number (int64)
  Total number of shipments in the shipment group
• orderReleaseDetails: orderReleaseDetails
• orDestLocationGid: string
  The Destination Location ID with which shipment group was created using a shipment group rule having Same Order Destination as true.
• orSourceLocationGid: string
  The Source Location ID with which the shipment group was created using a shipment group rule having Same Order Source as true.
• pickupTransactionNo: number (int64)
  No description.
• portOfDisLocationGid: string
  The Port of discharge ID with which the shipment group was created using a shipment group rule having Match Port of discharge as true.
• portOfLoadLocationGid: string
  The Port of loading ID with which shipment group was created using a shipment group rule having Match Port of loading as true.
• refnums: refnums
• remarks: remarks
• secondaryCharges: secondaryCharges
• sEquipmentGid: string
  The Equipment ID with which the shipment group was created using a shipment group rule having Same Equipment as true.
• servprovGid: string
  The service provider for the trailer build. If the shipment group was created from a rule, the service provider will be copied to the shipment group matched from the rule.
• shipGroupGid: string
  The GID for the shipment group.
• shipGroupRuleGid: string
  Indicates the rule by which the shipment group is created.
• shipGroupTypeGid: string
  Indicates the shipment group type.
• shipGroupXid: string
  The XID for the shipment group.
• shipmentDetails: shipmentDetails
• sourceLocationGid: string
  The source location of the shipment group.
• startTime: startTime
  Indicates the start time of the shipment group.
• statuses: statuses
• totalVolume: totalVolume
  Total volume of all the shipments in the shipment group.
• totalWeight: totalWeight
  Total weight of all the shipments in the shipment group
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• voyageGid: string
  The Voyage ID with which the shipment group was created using a shipment group rule having Match Schedule as true.

{
    "properties":{
        "shipGroupGid":{
            "description":"The GID for the shipment group.",
            "type":"string"
        },
        "shipGroupXid":{
            "description":"The XID for the shipment group.",
            "type":"string"
        },
        "shipGroupTypeGid":{
            "description":"Indicates the shipment group type.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The source location of the shipment group.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The destination location of the shipment group. ",
            "type":"string"
        },
        "shipGroupRuleGid":{
            "description":"Indicates the rule by which the shipment group is created.",
            "type":"string"
        },
        "startTime":{
            "description":"Indicates the start time of the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"Indicates the end time of the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "equipmentGroupGid":{
            "description":"Indicates the equipment group ID for trailer build. ",
            "type":"string"
        },
        "totalWeight":{
            "description":"Total weight of all the shipments in the shipment group",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"Total volume of all the shipments in the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "numberOfShipments":{
            "description":"Total number of shipments in the shipment group",
            "type":"number",
            "format":"int64"
        },
        "servprovGid":{
            "description":"The service provider for the trailer build. If the shipment group was created from a rule, the service provider will be copied to the shipment group matched from the rule.",
            "type":"string"
        },
        "pickupTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"shipment group appointment priority used for dock scheduling priority feature",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "voyageGid":{
            "description":"The Voyage ID with which the shipment group was created using a shipment group rule having Match Schedule as true.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The Port of loading ID with which shipment group was created using a shipment group rule having Match Port of loading as true.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The Port of discharge ID with which the shipment group was created using a shipment group rule having Match Port of discharge as true.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The Equipment ID with which the shipment group was created using a shipment group rule having Same Equipment as true.",
            "type":"string"
        },
        "orSourceLocationGid":{
            "description":"The Source Location ID with which the shipment group was created using a shipment group rule having Same Order Source as true.",
            "type":"string"
        },
        "orDestLocationGid":{
            "description":"The Destination Location ID with which shipment group was created using a shipment group rule having Same Order Destination as true.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipmentDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderReleaseDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : endTime

Indicates the end time of the shipment group.

Match All

Show Source

• object dateTimeType

{
    "description":"Indicates the end time of the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.involvedParties"
            }
        },
        "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 : orderReleaseDetails

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
            }
        },
        "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/shipmentGroups.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/shipmentGroups.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

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

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

Nested Schema : shipmentDetails

Type: object

Show Source

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

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

Nested Schema : startTime

Indicates the start time of the shipment group.

Match All

Show Source

• object dateTimeType

{
    "description":"Indicates the start time of the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

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

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

Nested Schema : totalVolume

Total volume of all the shipments in the shipment group.

Match All

Show Source

• object amountType

{
    "description":"Total volume of all the shipments in the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

Total weight of all the shipments in the shipment group

Match All

Show Source

• object amountType

{
    "description":"Total weight of all the shipments in the shipment group",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipmentGroups.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.involvedParties"
    }
}

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 : shipmentGroups.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method GID related to the involved party.
• domainName: string
  No description.
• involvedPartyContactGid: string
  The contact GID for the involved party.
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party. ",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party. ",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method GID related to the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 shipmentGroups.orderReleaseDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
    }
}

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 : shipmentGroups.orderReleaseDetails

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• domainName: string
  No description.
• links: array links
  Read Only: true
• orderReleaseGid: string
  The order release of shipments in the shipment group.
• orderReleaseLineGid: string
  The order release lines of shipments in the shipment group.
• remarks: remarks
• seqNum: number (int64)
  The sequence number to make the record unique.
• sEquipmentGid: string
  The equipment for the shipment group.
• shipmentGid: string
  The GID of shipment in the shipment group.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID of shipment in the shipment group. ",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The equipment for the shipment group. ",
            "type":"string"
        },
        "orderReleaseGid":{
            "description":"The order release of shipments in the shipment group. ",
            "type":"string"
        },
        "seqNum":{
            "description":"The sequence number to make the record unique. ",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"The order release lines of shipments in the shipment group. ",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "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 : remarks

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipmentGroups.orderReleaseDetails.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails.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 : shipmentGroups.orderReleaseDetails.remarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group order release

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group order release",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 shipmentGroups.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.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 : shipmentGroups.refnums

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• shipGroupRefnumQualGid: string
  Reference qualiifer.
• shipGroupRefnumValue: string
  Reference value.

{
    "properties":{
        "shipGroupRefnumQualGid":{
            "description":"Reference qualiifer.",
            "type":"string"
        },
        "shipGroupRefnumValue":{
            "description":"Reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 shipmentGroups.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.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 : shipmentGroups.remarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 shipmentGroups.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.secondaryCharges"
    }
}

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 : shipmentGroups.secondaryCharges

Type: object

Show Source

• actualCo2Emission: actualCo2Emission
  Actual CO2 emissions for the shipment.
• actualCo2EqEmission: actualCo2EqEmission
  Actual CO2 equivalent emissions for the shipment.
• aheadLateTime: aheadLateTime
  shipment status
• aheadOrLate: string
  A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user. B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed
• airRailRouteCode: string
  A transportation mode code that is informational for the shipment.
• appointmentPriorityGid: string
  The appointment priority identifier associated with the shipment.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bolIssuanceType: string
  The bill of lading issuance type identifier.
• bolType: string
  The bill of lading type defined for the shipment, used for report management.
• bulkCmGid: string
  The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.
• bulkPlanGid: string
  If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.
• cfsCutoffDate: cfsCutoffDate
  The container freight station cutoff date associated with the shipment.
• cfsLocationGid: string
  The location identifier for the container freight station.
• chargeableVolume: chargeableVolume
  The actual volume used in calculating the cost of the shipment.
• chargeableWeight: chargeableWeight
  The dimensional weight as determined by the rating process.
• checkCapacityConstraint: boolean
  The indicator to check the capacity constraints associated with the shipment.
• checkCostConstraint: boolean
  The indicator to check cost constraints associated with the shipment
• checkTimeConstraint: boolean
  The indicator to check the time constraints associated with the shipment.
• cmCost: cmCost
  The shipment cost when the shipment is part of a continuous move tour.
• cmEmptyDistance: cmEmptyDistance
  The empty leg distance between previous and this shipments.
• cmName: string
  The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.
• cmNextSourceLocationGid: string
  The source location of the next shipment in the continuous move tour.
• cmPrevDestLocationGid: string
  The destination location of the previous shipment in the continuous move tour.
• cmSequenceNum: number (int32)
  Indicates the shipment's sequence in the continuous move tour.
• cofcTofc: string
  The trailer or flat car or the container on flat car code for rail shipments.
• combinationEquipGrpGid: string
  The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments.
• consolGid: string
  The consol identifier if the shipment has been built from a consol structure.
• contactGid: string
  The contact identifier linking in the contact table information to the shipment.
• containerDeliveryLocGid: string
  The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.
• containerPickupLocGid: string
  The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
• currencyGid: string
  Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.
• currentStopNum: number (int32)
  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• customerRateCode: string
  The customer rate identifier associated with the shipment if this shipment is planned using a customer.
• deliveringServprovGid: string
  The service provider who is the delivering service provider for this shipment.
• destArbLevelOfServiceGid: string
  The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.
• destLocationGid: string
  The GID of the destination location of the shipment.
• destLocationOverrideGid: string
  The location identifier that will override the destination location that is defined for the shipment.
• destPierLocationGid: string
  The destination operational location.
• dimVolume: dimVolume
  The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
• dimWeight: dimWeight
  The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
• domainName: string
  The database domain where this data is stored.
• driverAssignBulkPlanGid: string
  Fleet bulk plan ID for driver assignment.
• driverGid: string
  The driver or primary team driver assigned to the shipment.
• dropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for dropping an empty equipment after freight.
• dutyPaid: string
  The duty paid of the shipment.
• earliestStartTime: earliestStartTime
  The earliest start time that will make this shipment feasible.
• emPhoneNumber: string
  The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
• endTime: endTime
  The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
• equipmentAssignBulkPlanGid: string
  Fleet bulk plan ID for equipment assignment.
• equipmentDestination: string
  equipment destination
• equipmentReferenceUnitGid: string
  The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.
• equipRefUnitUtilization: number (double)
  The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.
• etaDate: etaDate
  Estimated time of arrival
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipment.
• feasibilityCodeGid: string
  The feasibility code associated with the shipment can identify shipment infeasibilities.
• firstEquipmentGroupGid: string
  A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.
• firstEquipmentInitial: string
  first equipment intial
• firstEquipmentNumber: string
  first equipment number
• fixedServiceDays: number (int32)
  The fixed number of service days, if returned by the rating engine.
• flightInstanceId: number (int64)
  The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.
• freightTerms: string
  The freight terms for the shipment, such as prepaid or collect.
• hasAppointments: boolean
  Indicates if any stops on the shipment have appointments.
• hazmatModeGid: string
  The hazmat mode identifier that is associated with the shipment.
• hazmatRegionGid: string
  The hazmat region identifier that is associated with the shipment.
• incoTermGid: string
  The Incoterm identifier associated with the shipment.
• insuranceAmount: insuranceAmount
  The insurance amount of the shipment.
• insurancePolicyNumber: string
  The insurance policy number that covers this shipment, for informational purposes.
• insurancePremium: insurancePremium
  The insurance premium of the shipment, for informational purposes.
• intermediaryCorporationGid: string
  The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.
• inTrailerBuild: boolean
  Indicates that this shipment is in a trailer build shipment group.
• isAdvancedCharge: boolean
  A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.
• isArRouteCodeFixed: boolean
  This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.
• isAutoMergeConsolidate: boolean
  Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)
• isCostFixed: boolean
  A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.
• isCpctyOverrideApplicable: boolean
  A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.
• isCreditNote: boolean
  Y/N based on an associated credit note.
• isEquipmentFixed: boolean
  Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.
• isFixedDistance: boolean
  Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.
• isFixedTenderContact: boolean
  A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.
• isFixedVoyage: boolean
  A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.
• isHazardous: boolean
  A Y/N indicator specifying that the shipment is identified as having hazardous material.
• isMemoBl: boolean
  Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.
• isPermanent: boolean
  Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in "delete shipment" action.
• isPreferredCarrier: boolean
  Indicates if the carrier selected for the shipment is preferred.
• isPreload: boolean
  A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.
• isPrimary: boolean
  Indicates if the shipment is the primary shipment related to an order (bookings) path.
• isProfitSplit: boolean
  Indicates if the NFRC shipment will be profit split.
• isRateGeoFixed: boolean
  A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.
• isRateOfferingFixed: boolean
  A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.
• isRecalcTotals: boolean
  Turns on/off totaling logic.
• isServiceTimeFixed: boolean
  A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.
• isServprovFixed: boolean
  A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.
• isSpotCosted: boolean
  Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
• isTemperatureControl: boolean
  A Y/N indicator specifying that the shipment is identified as needing temperature control.
• isTemplate: boolean
  Indicates whether a shipment is a template.
• isToBeHeld: boolean
  A Y/N indicator specifying that the shipment is to be held by the carrier.
• itineraryGid: string
  The itinerary identifier that was used to build the shipment if it was built with the planning logic.
• jobGid: string
  The job GID identifier of the shipment, if the shipment is assigned to a job.
• lastEventGroupGid: string
  The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.
• latestStartTime: latestStartTime
  The latest start time that will make this shipment feasible.
• links: array links
  Read Only: true
• loadConfigEngineTypeGid: string
  Null type means no load configuration is performed on the shipment.
• loadedDistance: loadedDistance
  The total distance that the truck or the transportation mode will travel when the shipment is loaded.
• loadingHallPenalty: number (double)
  The loading hall penalty used while building loading halls for the shipment.
• marketCost: marketCost
  Market cost based on the shipment.
• maxNumRetender: number (int32)
  Maximum number of re-tenders.
• nfrcRuleGid: string
  The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.
• numEquipmentOrdered: number (int32)
  The number of equipment ordered. This is manually set by the user and can be rated on.
• numOrderReleases: number (int32)
  The number of order releases that are on this shipment.
• numStops: number (int32)
  The number of shipment stop records related to this shipment.
• originalInvoiceCost: originalInvoiceCost
  The original invoice cost at the point when the invoice was initially created or matched to the shipment.
• originalShipmentGid: string
  If the shipment represents a secondary charge, this points back to the "parent" shipment for which the secondary shipment is a "child".
• originatingServprovGid: string
  The service provider who is the originating service provider for this shipment.
• parcelZone: string
  The ship to mail zone. A price key used for parcel rate calculations.
• parentLegGid: string
  The parent leg associated with the itinerary that may have been used to plan the shipment.
• paymentMethodCodeGid: string
  The payment method code identifier.
• perspective: string
  The indicates if the shipment is a buy or sell perspective.
• pickInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for picking an empty equipment before freight.
• placeDeliverLocationGid: string
  The place deliver location identifier specifying the location where ownership of freight ends with delivery.
• placeReceiptLocationGid: string
  The place receipt location identifier specifying the location where ownership of freight starts.
• plannedCo2Emission: plannedCo2Emission
  CO2 emissions recorded while planning the shipment.
• plannedCo2EqEmission: plannedCo2EqEmission
  CO2 equivalent emissions recorded while planning the shipment.
• plannedCost: plannedCost
  The cost when the original shipment was created.
• plannedRateGeoGid: string
  The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedRateOfferingGid: string
  The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedServprovGid: string
  The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedTransportModeGid: string
  The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• planningParameterSetGid: string
  The parameter set GID which is used in building this shipment.
• portDischargeEta: portDischargeEta
  The estimated port of discharge date associated with ocean-going shipments.
• portExitLocGid: string
  The designated port the freight will be exiting the country for international shipments.
• portOfDisLocationGid: string
  The location ID of the port of discharge for the primary leg carrier.
• portOfDisOverrideLocGid: string
  The location override ID of the port of discharge for the primary leg carrier.
• portOfExitDate: portOfExitDate
  The estimated port of exit (for international shipments) associated with ocean going shipments.
• portOfLoadLocationGid: string
  The location ID of the port of load for the primary leg carrier.
• portOfLoadOverrideLocGid: string
  The location override ID of the port of load for the primary leg carrier.
• powerUnitGid: string
  The power unit assigned to the shipment.
• prevDropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for driver's previous shipment's equipment.
• prevEquipmentDestination: string
  previous equipment destination
• prevReportedBsStatusCode: string
  previous reported event for shipment
• prevReportingScac: string
  previous reporting scac
• prevSightingDate: prevSightingDate
  The date associated with the previous sighting location and in the tracking event.
• prevSightingLocationGid: string
  The location identifier for the previous sighting location used for rail shipment and tracking events.
• primaryOrderBaseGid: string
  A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.
• processingCodeGid: string
  The processing code GID.
• projectedTourName: string
  Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.
• projectedTourSequenceNum: number (int32)
  Represents the sequence in which the shipment should appear in the projected tour.
• railDate: railDate
  The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
• railInterModalPlanGid: string
  The rail intermodal plan identifier of the shipment used for intermodal rail shipments.
• railReturnLocationGid: string
  The rail return location identifier of the rail shipment.
• railReturnRouteGid: string
  The rail return route identifier of the rail shipment.
• rateGeoGid: string
  The detailed rate record (contract) identifier that is used by the service provider moving this shipment.
• rateOfferingGid: string
  The rate offering (contract) identifier that is used by the service provider moving this shipment.
• repetitionScheduleGid: string
  The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.
• reportedBsStatusCode: string
  latest reported event for shipment
• reportingScac: string
  reporting scac
• reservationNum: string
  Saved here to search shipments based on Reservation Number.
• routeCodeCombinationGid: string
  The route code combination identifier of the shipment used for specifying rail shipments.
• rule11Indicator: string
  The rule 11 indicator of the shipment used for managing rail.
• rule7: boolean
  A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.
• sailCutoffDate: sailCutoffDate
  The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
• sailDate: sailDate
  The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
• scheduleType: string
  When the schedule type is populated, it is a consol.
• secondaryChargeRuleGid: string
  The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.
• secondaryDriverGid: string
  The secondary team driver assigned to the shipment.
• servprovGid: string
  The service provider identifier associated with the shipment.
• shipmentAsWork: boolean
  Indicates the shipment as work.
• shipmentGid: string
  The GID for the shipment.
• shipmentName: string
  A descriptive name of the shipment.
• shipmentReleased: boolean
  A Y/N indicator used for rail shipments that indicate that the shipment is ready.
• shipmentTypeGid: string
  The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.
• shipmentXid: string
  The XID for the shipment.
• shippingAgentContactGid: string
  Indicate if this NFRC is created from the Assign Shipping Agent action on the job.
• siCutoffDate: siCutoffDate
  The shippers instruction cutoff date associated with the shipment.
• sightingDate: sightingDate
  The date and time when the shipment was last sighted at the sighting location.
• sightingLocationGid: string
  The location where the shipment was last sighted.
• solePackagedItemGid: string
  only one equipment and with only one item
• sourceLocationGid: string
  The GID of the source location of the shipment.
• sourceLocationOverrideGid: string
  The location identifier that will override the source location that is defined for the shipment.
• sourcePierLocationGid: string
  The source operational location.
• srcArbLevelOfServiceGid: string
  The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.
• startTime: startTime
  The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
• tariffDate: tariffDate
  The tariff date, for informational purposes.
• tariffName: string
  The tariff name, for informational purposes.
• tariffNumber: string
  The tariff number, for informational purposes.
• tariffOrganizationName: string
  The tariff organization name, for informational purposes.
• tariffOrganizationNumber: string
  The tariff organization number, for informational purposes.
• termLocationText: string
  The term location text that is informational for the shipment.
• totalActualCost: totalActualCost
  The total actual cost of the shipment.
• totalApprovedCost: totalApprovedCost
  The total approved cost associated with the shipment after the approval step in the freight payment process.
• totalDeclaredValue: totalDeclaredValue
  The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
• totalItemPackageCount: number (int32)
  The total item package count of the shipment.
• totalNetVolume: totalNetVolume
  The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
• totalNetWeight: totalNetWeight
  The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
• totalNumReferenceUnits: number (double)
  The total number of reference units of the shipment as defined by the equipment reference units.
• totalPackagingUnitCount: number (int32)
  The total packaging unit count of the shipment.
• totalShipUnitCount: number (int64)
  The total ship unit count of the shipment.
• totalTransCost: totalTransCost
  The total cost of the shipment. It represents the total transportation cost after applying the rebate.
• totalVolume: totalVolume
  The total volume of the shipment.
• totalWeight: totalWeight
  The total weight of the shipment.
• totalWeightedCost: totalWeightedCost
  The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.
• totMatchedInvoiceCost: totMatchedInvoiceCost
  The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.
• transportModeGid: string
  A unique identifier to define the transportation modes.
• unloadedDistance: unloadedDistance
  The total distance that the truck or the transportation mode will travel when empty.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• vesselGid: string
  The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.
• volumeUtilization: number (double)
  The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.
• voyageGid: string
  The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.
• waybillDate: waybillDate
  Waybill date represents contractual agreement of the carriage.
• weighCode: string
  The weigh code of the shipment that identifies the weight type.
• weightUtilization: number (double)
  The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.
• workAssignmentBulkPlanGid: string
  Work assignment bulk plan ID which is generated during work assignment bulk plan process.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID for the shipment.",
            "type":"string"
        },
        "shipmentXid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "shipmentName":{
            "description":"A descriptive name of the shipment.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation modes.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Indicates whether a shipment is a template.",
            "type":"boolean"
        },
        "isPrimary":{
            "description":"Indicates if the shipment is the primary shipment related to an order (bookings) path.",
            "type":"boolean"
        },
        "isSpotCosted":{
            "description":"Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.",
            "type":"boolean"
        },
        "isCreditNote":{
            "description":"Y/N based on an associated credit note.",
            "type":"boolean"
        },
        "cmPrevDestLocationGid":{
            "description":"The destination location of the previous shipment in the continuous move tour.",
            "type":"string"
        },
        "cmNextSourceLocationGid":{
            "description":"The source location of the next shipment in the continuous move tour.",
            "type":"string"
        },
        "totalActualCost":{
            "description":"The total actual cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalTransCost":{
            "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unloadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment.",
            "type":"string"
        },
        "startTime":{
            "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightTerms":{
            "description":"The freight terms for the shipment, such as prepaid or collect.",
            "type":"string"
        },
        "parentLegGid":{
            "description":"The parent leg associated with the itinerary that may have been used to plan the shipment.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider identifier associated with the shipment.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The rate offering (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The detailed rate record (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "originalShipmentGid":{
            "description":"If the shipment represents a secondary charge, this points back to the \"parent\" shipment for which the secondary shipment is a \"child\".",
            "type":"string"
        },
        "isAutoMergeConsolidate":{
            "description":"Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)",
            "type":"boolean"
        },
        "perspective":{
            "description":"The indicates if the shipment is a buy or sell perspective.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.",
            "type":"number",
            "format":"int64"
        },
        "totalWeight":{
            "description":"The total weight of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalShipUnitCount":{
            "description":"The total ship unit count of the shipment.",
            "type":"number",
            "format":"int64"
        },
        "totalPackagingUnitCount":{
            "description":"The total packaging unit count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalItemPackageCount":{
            "description":"The total item package count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "intermediaryCorporationGid":{
            "description":"The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.",
            "type":"string"
        },
        "routeCodeCombinationGid":{
            "description":"The route code combination identifier of the shipment used for specifying rail shipments.",
            "type":"string"
        },
        "railInterModalPlanGid":{
            "description":"The rail intermodal plan identifier of the shipment used for intermodal rail shipments.",
            "type":"string"
        },
        "customerRateCode":{
            "description":"The customer rate identifier associated with the shipment if this shipment is planned using a customer.",
            "type":"string"
        },
        "cofcTofc":{
            "description":"The trailer or flat car or the container on flat car code for rail shipments.",
            "type":"string"
        },
        "railReturnLocationGid":{
            "description":"The rail return location identifier of the rail shipment.",
            "type":"string"
        },
        "railReturnRouteGid":{
            "description":"The rail return route identifier of the rail shipment.",
            "type":"string"
        },
        "rule11Indicator":{
            "description":"The rule 11 indicator of the shipment used for managing rail.",
            "type":"string"
        },
        "currentStopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "shipmentAsWork":{
            "description":"Indicates the shipment as work.",
            "type":"boolean"
        },
        "secondaryChargeRuleGid":{
            "description":"The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.",
            "type":"string"
        },
        "checkTimeConstraint":{
            "description":"The indicator to check the time constraints associated with the shipment.",
            "type":"boolean"
        },
        "checkCostConstraint":{
            "description":"The indicator to check cost constraints associated with the shipment",
            "type":"boolean"
        },
        "checkCapacityConstraint":{
            "description":"The indicator to check the capacity constraints associated with the shipment.",
            "type":"boolean"
        },
        "cmName":{
            "description":"The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "cmSequenceNum":{
            "description":"Indicates the shipment's sequence in the continuous move tour.",
            "type":"number",
            "format":"int32"
        },
        "cmCost":{
            "description":"The shipment cost when the shipment is part of a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "cmEmptyDistance":{
            "description":"The empty leg distance between previous and this shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazmatModeGid":{
            "description":"The hazmat mode identifier that is associated with the shipment.",
            "type":"string"
        },
        "hazmatRegionGid":{
            "description":"The hazmat region identifier that is associated with the shipment.",
            "type":"string"
        },
        "weighCode":{
            "description":"The weigh code of the shipment that identifies the weight type.",
            "type":"string"
        },
        "rule7":{
            "description":"A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.",
            "type":"boolean"
        },
        "shipmentReleased":{
            "description":"A Y/N indicator used for rail shipments that indicate that the shipment is ready.",
            "type":"boolean"
        },
        "processingCodeGid":{
            "description":"The processing code GID.",
            "type":"string"
        },
        "airRailRouteCode":{
            "description":"A transportation mode code that is informational for the shipment.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code identifier.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The Incoterm identifier associated with the shipment.",
            "type":"string"
        },
        "dimWeight":{
            "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCost":{
            "description":"The cost when the original shipment was created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "termLocationText":{
            "description":"The term location text that is informational for the shipment.",
            "type":"string"
        },
        "tariffOrganizationNumber":{
            "description":"The tariff organization number, for informational purposes.",
            "type":"string"
        },
        "tariffOrganizationName":{
            "description":"The tariff organization name, for informational purposes.",
            "type":"string"
        },
        "tariffName":{
            "description":"The tariff name, for informational purposes.",
            "type":"string"
        },
        "tariffNumber":{
            "description":"The tariff number, for informational purposes.",
            "type":"string"
        },
        "tariffDate":{
            "description":"The tariff date, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator specifying that the shipment is identified as having hazardous material.",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"A Y/N indicator specifying that the shipment is identified as needing temperature control.",
            "type":"boolean"
        },
        "isCostFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isServiceTimeFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isRateGeoFixed":{
            "description":"A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.",
            "type":"boolean"
        },
        "isRateOfferingFixed":{
            "description":"A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isServprovFixed":{
            "description":"A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isPreload":{
            "description":"A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.",
            "type":"boolean"
        },
        "isFixedTenderContact":{
            "description":"A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isToBeHeld":{
            "description":"A Y/N indicator specifying that the shipment is to be held by the carrier.",
            "type":"boolean"
        },
        "isPreferredCarrier":{
            "description":"Indicates if the carrier selected for the shipment is preferred.",
            "type":"boolean"
        },
        "isEquipmentFixed":{
            "description":"Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.",
            "type":"boolean"
        },
        "isRecalcTotals":{
            "description":"Turns on/off totaling logic.",
            "type":"boolean"
        },
        "hasAppointments":{
            "description":"Indicates if any stops on the shipment have appointments.",
            "type":"boolean"
        },
        "contactGid":{
            "description":"The contact identifier linking in the contact table information to the shipment.",
            "type":"string"
        },
        "bulkPlanGid":{
            "description":"If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.",
            "type":"string"
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units of the shipment as defined by the equipment reference units.",
            "type":"number",
            "format":"double"
        },
        "itineraryGid":{
            "description":"The itinerary identifier that was used to build the shipment if it was built with the planning logic.",
            "type":"string"
        },
        "feasibilityCodeGid":{
            "description":"The feasibility code associated with the shipment can identify shipment infeasibilities.",
            "type":"string"
        },
        "numOrderReleases":{
            "description":"The number of order releases that are on this shipment.",
            "type":"number",
            "format":"int32"
        },
        "numStops":{
            "description":"The number of shipment stop records related to this shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalNetWeight":{
            "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "earliestStartTime":{
            "description":"The earliest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latestStartTime":{
            "description":"The latest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastEventGroupGid":{
            "description":"The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.",
            "type":"string"
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.",
            "type":"string"
        },
        "inTrailerBuild":{
            "description":"Indicates that this shipment is in a trailer build shipment group.",
            "type":"boolean"
        },
        "firstEquipmentGroupGid":{
            "description":"A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.",
            "type":"string"
        },
        "bulkCmGid":{
            "description":"The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "sourceLocationOverrideGid":{
            "description":"The location identifier that will override the source location that is defined for the shipment.",
            "type":"string"
        },
        "destLocationOverrideGid":{
            "description":"The location identifier that will override the destination location that is defined for the shipment.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.",
            "type":"string"
        },
        "scheduleType":{
            "description":"When the schedule type is populated, it is a consol.",
            "type":"string"
        },
        "weightUtilization":{
            "description":"The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "volumeUtilization":{
            "description":"The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "equipRefUnitUtilization":{
            "description":"The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "jobGid":{
            "description":"The job GID identifier of the shipment, if the shipment is assigned to a job.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The location ID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfLoadOverrideLocGid":{
            "description":"The location override ID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The location ID of the port of discharge for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisOverrideLocGid":{
            "description":"The location override ID of the port of discharge for the primary leg carrier.",
            "type":"string"
        },
        "insurancePolicyNumber":{
            "description":"The insurance policy number that covers this shipment, for informational purposes.",
            "type":"string"
        },
        "insuranceAmount":{
            "description":"The insurance amount of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "insurancePremium":{
            "description":"The insurance premium of the shipment, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "bolType":{
            "description":"The bill of lading type defined for the shipment, used for report management.",
            "type":"string"
        },
        "bolIssuanceType":{
            "description":"The bill of lading issuance type identifier.",
            "type":"string"
        },
        "consolGid":{
            "description":"The consol identifier if the shipment has been built from a consol structure.",
            "type":"string"
        },
        "placeReceiptLocationGid":{
            "description":"The place receipt location identifier specifying the location where ownership of freight starts.",
            "type":"string"
        },
        "placeDeliverLocationGid":{
            "description":"The place deliver location identifier specifying the location where ownership of freight ends with delivery.",
            "type":"string"
        },
        "sailDate":{
            "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portDischargeEta":{
            "description":"The estimated port of discharge date associated with ocean-going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portOfExitDate":{
            "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portExitLocGid":{
            "description":"The designated port the freight will be exiting the country for international shipments.",
            "type":"string"
        },
        "containerDeliveryLocGid":{
            "description":"The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.",
            "type":"string"
        },
        "containerPickupLocGid":{
            "description":"The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.",
            "type":"string"
        },
        "nfrcRuleGid":{
            "description":"The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.",
            "type":"string"
        },
        "isCpctyOverrideApplicable":{
            "description":"A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.",
            "type":"boolean"
        },
        "plannedRateOfferingGid":{
            "description":"The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedTransportModeGid":{
            "description":"The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedServprovGid":{
            "description":"The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedRateGeoGid":{
            "description":"The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "isPermanent":{
            "description":"Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in \"delete shipment\" action.",
            "type":"boolean"
        },
        "isMemoBl":{
            "description":"Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"The duty paid of the shipment.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "currencyGid":{
            "description":"Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "totMatchedInvoiceCost":{
            "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "originalInvoiceCost":{
            "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalApprovedCost":{
            "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sourcePierLocationGid":{
            "description":"The source operational location.",
            "type":"string"
        },
        "destPierLocationGid":{
            "description":"The destination operational location.",
            "type":"string"
        },
        "primaryOrderBaseGid":{
            "description":"A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.",
            "type":"string"
        },
        "totalDeclaredValue":{
            "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isProfitSplit":{
            "description":"Indicates if the NFRC shipment will be profit split.",
            "type":"boolean"
        },
        "shippingAgentContactGid":{
            "description":"Indicate if this NFRC is created from the Assign Shipping Agent action on the job.",
            "type":"string"
        },
        "isAdvancedCharge":{
            "description":"A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.",
            "type":"boolean"
        },
        "loadConfigEngineTypeGid":{
            "description":"Null type means no load configuration is performed on the shipment.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"The appointment priority identifier associated with the shipment.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.",
            "type":"boolean"
        },
        "deliveringServprovGid":{
            "description":"The service provider who is the delivering service provider for this shipment.",
            "type":"string"
        },
        "originatingServprovGid":{
            "description":"The service provider who is the originating service provider for this shipment.",
            "type":"string"
        },
        "chargeableWeight":{
            "description":"The dimensional weight as determined by the rating process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "fixedServiceDays":{
            "description":"The fixed number of service days, if returned by the rating engine.",
            "type":"number",
            "format":"int32"
        },
        "sightingLocationGid":{
            "description":"The location where the shipment was last sighted.",
            "type":"string"
        },
        "sightingDate":{
            "description":"The date and time when the shipment was last sighted at the sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"The location identifier for the previous sighting location used for rail shipment and tracking events.",
            "type":"string"
        },
        "prevSightingDate":{
            "description":"The date associated with the previous sighting location and in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "driverGid":{
            "description":"The driver or primary team driver assigned to the shipment.",
            "type":"string"
        },
        "secondaryDriverGid":{
            "description":"The secondary team driver assigned to the shipment.",
            "type":"string"
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the shipment.",
            "type":"string"
        },
        "driverAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for driver assignment.",
            "type":"string"
        },
        "equipmentAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for equipment assignment.",
            "type":"string"
        },
        "prevDropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for driver's previous shipment's equipment.",
            "type":"boolean"
        },
        "pickInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for picking an empty equipment before freight.",
            "type":"boolean"
        },
        "dropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for dropping an empty equipment after freight.",
            "type":"boolean"
        },
        "dimVolume":{
            "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "chargeableVolume":{
            "description":"The actual volume used in calculating the cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"The database domain where this data is stored.",
            "type":"string"
        },
        "planningParameterSetGid":{
            "description":"The parameter set GID which is used in building this shipment.",
            "type":"string"
        },
        "numEquipmentOrdered":{
            "description":"The number of equipment ordered. This is manually set by the user and can be rated on.",
            "type":"number",
            "format":"int32"
        },
        "emPhoneNumber":{
            "description":"The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.",
            "type":"string"
        },
        "parcelZone":{
            "description":"The ship to mail zone. A price key used for parcel rate calculations.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "combinationEquipGrpGid":{
            "description":"The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments.",
            "type":"string"
        },
        "siCutoffDate":{
            "description":"The shippers instruction cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "cfsCutoffDate":{
            "description":"The container freight station cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.",
            "type":"string"
        },
        "cfsLocationGid":{
            "description":"The location identifier for the container freight station.",
            "type":"string"
        },
        "isFixedVoyage":{
            "description":"A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.",
            "type":"boolean"
        },
        "workAssignmentBulkPlanGid":{
            "description":"Work assignment bulk plan ID which is generated during work assignment bulk plan process.",
            "type":"string"
        },
        "aheadLateTime":{
            "description":"shipment status",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aheadOrLate":{
            "description":"A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user.  B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed  ",
            "type":"string"
        },
        "etaDate":{
            "description":"Estimated time of arrival",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "firstEquipmentInitial":{
            "description":"first equipment intial",
            "type":"string"
        },
        "firstEquipmentNumber":{
            "description":"first equipment number",
            "type":"string"
        },
        "solePackagedItemGid":{
            "description":"only one equipment and with only one item \t",
            "type":"string"
        },
        "reportedBsStatusCode":{
            "description":"latest reported event for shipment",
            "type":"string"
        },
        "reportingScac":{
            "description":"reporting scac",
            "type":"string"
        },
        "equipmentDestination":{
            "description":"equipment destination",
            "type":"string"
        },
        "prevReportedBsStatusCode":{
            "description":"previous reported event for shipment",
            "type":"string"
        },
        "prevReportingScac":{
            "description":"previous reporting scac",
            "type":"string"
        },
        "prevEquipmentDestination":{
            "description":"previous equipment destination",
            "type":"string"
        },
        "maxNumRetender":{
            "description":"Maximum number of re-tenders.",
            "type":"number",
            "format":"int32"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reservationNum":{
            "description":"Saved here to search shipments based on Reservation Number.",
            "type":"string"
        },
        "isArRouteCodeFixed":{
            "description":"This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.",
            "type":"boolean"
        },
        "waybillDate":{
            "description":"Waybill date represents contractual agreement of the carriage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "projectedTourName":{
            "description":"Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "projectedTourSequenceNum":{
            "description":"Represents the sequence in which the shipment should appear in the projected tour.",
            "type":"number",
            "format":"int32"
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipment.",
            "type":"string"
        },
        "plannedCo2Emission":{
            "description":"CO2 emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2Emission":{
            "description":"Actual CO2 emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCo2EqEmission":{
            "description":"CO2 equivalent emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2EqEmission":{
            "description":"Actual CO2 equivalent emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadingHallPenalty":{
            "description":"The loading hall penalty used while building loading halls for the shipment.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : aheadLateTime

shipment status

Match All

Show Source

• object amountType

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

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsCutoffDate

The container freight station cutoff date associated with the shipment.

Match All

Show Source

• object dateTimeType

{
    "description":"The container freight station cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : chargeableVolume

The actual volume used in calculating the cost of the shipment.

Match All

Show Source

• object amountType

{
    "description":"The actual volume used in calculating the cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : chargeableWeight

The dimensional weight as determined by the rating process.

Match All

Show Source

• object amountType

{
    "description":"The dimensional weight as determined by the rating process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a continuous move tour.

Match All

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments.

Match All

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dimVolume

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Match All

Show Source

• object amountType

{
    "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dimWeight

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Match All

Show Source

• object amountType

{
    "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : earliestStartTime

The earliest start time that will make this shipment feasible.

Match All

Show Source

• object dateTimeType

{
    "description":"The earliest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : endTime

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Match All

Show Source

• object dateTimeType

{
    "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : etaDate

Estimated time of arrival

Match All

Show Source

• object dateTimeType

{
    "description":"Estimated time of arrival",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insuranceAmount

The insurance amount of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The insurance amount of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : insurancePremium

The insurance premium of the shipment, for informational purposes.

Match All

Show Source

• object currencyType

{
    "description":"The insurance premium of the shipment, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : latestStartTime

The latest start time that will make this shipment feasible.

Match All

Show Source

• object dateTimeType

{
    "description":"The latest start time that will make this shipment feasible.",
    "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 : loadedDistance

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Match All

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originalInvoiceCost

The original invoice cost at the point when the invoice was initially created or matched to the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCost

The cost when the original shipment was created.

Match All

Show Source

• object currencyType

{
    "description":"The cost when the original shipment was created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : portDischargeEta

The estimated port of discharge date associated with ocean-going shipments.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated port of discharge date associated with ocean-going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portOfExitDate

The estimated port of exit (for international shipments) associated with ocean going shipments.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingDate

The date associated with the previous sighting location and in the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The date associated with the previous sighting location and in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : railDate

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Match All

Show Source

• object dateTimeType

{
    "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailCutoffDate

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Match All

Show Source

• object dateTimeType

{
    "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Match All

Show Source

• object dateTimeType

{
    "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : siCutoffDate

The shippers instruction cutoff date associated with the shipment.

Match All

Show Source

• object dateTimeType

{
    "description":"The shippers instruction cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingDate

The date and time when the shipment was last sighted at the sighting location.

Match All

Show Source

• object dateTimeType

{
    "description":"The date and time when the shipment was last sighted at the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : tariffDate

The tariff date, for informational purposes.

Match All

Show Source

• object dateType

{
    "description":"The tariff date, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The total actual cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalApprovedCost

The total approved cost associated with the shipment after the approval step in the freight payment process.

Match All

Show Source

• object currencyType

{
    "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalDeclaredValue

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Match All

Show Source

• object currencyType

{
    "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Match All

Show Source

• object amountType

{
    "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Match All

Show Source

• object amountType

{
    "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalTransCost

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Match All

Show Source

• object currencyType

{
    "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalVolume

The total volume of the shipment.

Match All

Show Source

• object amountType

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

Nested Schema : totalWeight

The total weight of the shipment.

Match All

Show Source

• object amountType

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

Nested Schema : totalWeightedCost

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.

Match All

Show Source

• object currencyType

{
    "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totMatchedInvoiceCost

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.

Match All

Show Source

• object currencyType

{
    "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unloadedDistance

The total distance that the truck or the transportation mode will travel when empty.

Match All

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waybillDate

Waybill date represents contractual agreement of the carriage.

Match All

Show Source

• object dateTimeType

{
    "description":"Waybill date represents contractual agreement of the carriage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: array

Show Source

• Array of: object shipmentGroups.shipmentDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails"
    }
}

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 : shipmentGroups.shipmentDetails

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks
• shipmentGid: string
  The GID of shipment in the shipment group.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID of shipment in the shipment group. ",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "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 : remarks

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipmentGroups.shipmentDetails.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails.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 : shipmentGroups.shipmentDetails.remarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group detail

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group detail",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 shipmentGroups.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.statuses"
    }
}

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 : shipmentGroups.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type of the shipment group
• statusValueGid: string
  The status value for the status type of the shipment group

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type of the shipment group ",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the status type of  the shipment group ",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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
}

Back to Top