Jump to

• Request
• Response

Create a Quote

post

/quotes

Request

Header Parameters

• Prefer:
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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)
• 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
• availableByDate: availableByDate
  The date the freight will be available by if the shipment will not be available to ship until a certain date.
• consolidationTypeGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
• costOptions: costOptions
• deliverByDate: deliverByDate
  The date the freight must be delivered by if the shipment must be delivered by a certain date.
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationLocationGid: string
  The GID for the destination location.
• destinationLocationType: string
  Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destinationSearchValue: string
  Destination rate search value.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• equipmentGroups: equipmentGroups
• expirationDate: expirationDate
  Identifies the last day the quote is valid.
• incoTermGid: string
  The GID for the Incoterm for the shipment. This can limit the itineraries considered.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isCustomerRatesOnly: boolean
  Flag to limit search to customer specific rates only.
• isHazardous: boolean
  Flag indicating if the quote is for a shipment that contains hazardous material.
• issueDate: issueDate
  The date the quote was sent to the customer.
• links: array links
  Read Only: true
• originAddressLine1: string
  Origin location address line 1 value.
• originAddressLine2: string
  Origin location address line 2 value.
• originAddressLine3: string
  Origin location address line 3 value.
• originCity: string
  Origin location city value.
• originCountryCode3Gid: string
  Origin location country code value.
• originLocationGid: string
  The GID for the origin/source location.
• originLocationType: string
  Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.
• originPostalCode: string
  Origin location postal code value.
• originProvince: string
  Origin location province value.
• originSearchValue: string
  Origin rate search value.
• perspective: string
  Perspective - buy or sell side.
• quoteGid: string
  The GID for the quote.
• quoteOption: string
  Select Optimize, Equipment Groups, or Equipment Configuration.
  Optimize returns quotes that match the search criteria. This is the default setting.
  Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.
  Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.
• quoteXid: string
  The XID for the quote.
• refnums: refnums
• remarks: remarks
• requestDate: requestDate
  The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.
• servprovGid: string
  The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.
• shipUnits: shipUnits
• statuses: statuses
• texts: texts
• transportModeGid: string
  The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.
• updateDate: updateDate
  Read Only: true

  update date
• viaDestinationLocationGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
• viaOriginLocationGid: string
  If applicable, the GID for the origin via location.

{
    "properties":{
        "quoteGid":{
            "description":"The GID for the quote.",
            "type":"string"
        },
        "quoteXid":{
            "description":"The XID for the quote.",
            "type":"string"
        },
        "requestDate":{
            "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "issueDate":{
            "description":"The date the quote was sent to the customer.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"Identifies the last day the quote is valid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originLocationType":{
            "description":"Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.",
            "type":"string"
        },
        "originLocationGid":{
            "description":"The GID for the origin/source location.",
            "type":"string"
        },
        "originAddressLine1":{
            "description":"Origin location address line 1 value.",
            "type":"string"
        },
        "originAddressLine2":{
            "description":"Origin location address line 2 value.",
            "type":"string"
        },
        "originAddressLine3":{
            "description":"Origin location address line 3 value.",
            "type":"string"
        },
        "originCity":{
            "description":"Origin location city value.",
            "type":"string"
        },
        "originProvince":{
            "description":"Origin location province value.",
            "type":"string"
        },
        "originCountryCode3Gid":{
            "description":"Origin location country code value.",
            "type":"string"
        },
        "originPostalCode":{
            "description":"Origin location postal code value.",
            "type":"string"
        },
        "viaOriginLocationGid":{
            "description":"If applicable, the GID for the origin via location.",
            "type":"string"
        },
        "destinationLocationType":{
            "description":"Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.",
            "type":"string"
        },
        "destinationLocationGid":{
            "description":"The GID for the destination location.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "viaDestinationLocationGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.",
            "type":"string"
        },
        "isHazardous":{
            "description":"Flag indicating if the quote is for a shipment that contains hazardous material.",
            "type":"boolean"
        },
        "perspective":{
            "description":"Perspective - buy or sell side.",
            "type":"string"
        },
        "quoteOption":{
            "description":"Select Optimize, Equipment Groups, or Equipment Configuration.<br>Optimize returns quotes that match the search criteria. This is the default setting.<br>Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.<br>Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.",
            "type":"string"
        },
        "availableByDate":{
            "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "deliverByDate":{
            "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originSearchValue":{
            "description":"Origin rate search value.",
            "type":"string"
        },
        "destinationSearchValue":{
            "description":"Destination rate search value.",
            "type":"string"
        },
        "isCustomerRatesOnly":{
            "description":"Flag to limit search to customer specific rates only.",
            "type":"boolean"
        },
        "consolidationTypeGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The GID for the Incoterm for the shipment. This can limit the itineraries considered.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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"
                }
            ]
        },
        "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/quotes.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costOptions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.documents"
                    }
                },
                "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 : availableByDate

The date the freight will be available by if the shipment will not be available to ship until a certain date.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : costOptions

Type: object

Show Source

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

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

Nested Schema : deliverByDate

The date the freight must be delivered by if the shipment must be delivered by a certain date.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : equipmentGroups

Type: object

Show Source

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

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

Nested Schema : expirationDate

Identifies the last day the quote is valid.

Match All

Show Source

• object dateTimeType

{
    "description":"Identifies the last day the quote is valid.",
    "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/quotes.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : issueDate

The date the quote was sent to the customer.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the quote was sent to the customer.",
    "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 : refnums

Type: object

Show Source

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

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

Nested Schema : requestDate

The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.

Match All

Show Source

• object dateTimeType

{
    "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipUnits

Type: object

Show Source

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

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

Nested Schema : statuses

Type: object

Show Source

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

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

Nested Schema : texts

Type: object

Show Source

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

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

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

Type: array

Show Source

• Array of: object quotes.costOptions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions"
    }
}

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 : quotes.costOptions

Type: object

Show Source

• buyItineraryGid: string
  Database base amount for total non-transport costs for sell side of this quote option.
• buyNonTransCost: buyNonTransCost
  Total non-transport costs for buy side of this quote option.
• buyTransCost: buyTransCost
  Total non-transport costs for buy side of this quote option.
• costOptionSequence: number (int32)
  Option Number: Each possible cost option is assigned an Option Number.
• domainName: string
  Database domain where this data is stored.
• equipments: equipments
• isFeasibleBuy: boolean
  Currency for total non-transport costs for sell side of this quote option.
• isFeasibleSell: boolean
  Indicates if the buy side option is feasible.
• isLateBuy: boolean
  Total non-transport costs for sell side of this quote option.
• isLateSell: boolean
  Indicates if the buy side option is late.
• links: array links
  Read Only: true
• remarks: remarks
• sellItineraryGid: string
  Itinerary used for the buy side option.
• sellNonTransCost: sellNonTransCost
  Total non-transport costs for sell side of this quote option.
• sellTransCost: sellTransCost
  Total buy side transport cost for this quote option
• shipments: shipments

{
    "properties":{
        "costOptionSequence":{
            "description":"Option Number: Each possible cost option is assigned an Option Number.",
            "type":"number",
            "format":"int32"
        },
        "sellTransCost":{
            "description":"Total buy side transport cost for this quote option",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateSell":{
            "description":"Indicates if the buy side option is late.",
            "type":"boolean"
        },
        "isFeasibleSell":{
            "description":"Indicates if the buy side option is feasible.",
            "type":"boolean"
        },
        "sellItineraryGid":{
            "description":"Itinerary used for the buy side option.",
            "type":"string"
        },
        "buyTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateBuy":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "isFeasibleBuy":{
            "description":"Currency for total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "buyItineraryGid":{
            "description":"Database base amount for total non-transport costs for sell side of this quote option.",
            "type":"string"
        },
        "buyNonTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sellNonTransCost":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : buyNonTransCost

Total non-transport costs for buy side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : buyTransCost

Total non-transport costs for buy side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : equipments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.equipments"
            }
        },
        "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 : remarks

Type: object

Show Source

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

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

Nested Schema : sellNonTransCost

Total non-transport costs for sell side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for sell side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : sellTransCost

Total buy side transport cost for this quote option

Match All

Show Source

• object currencyType

{
    "description":"Total buy side transport cost for this quote option",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 quotes.costOptions.equipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.equipments"
    }
}

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 : quotes.costOptions.equipments

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroupCount: number (int32)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option.",
            "type":"string"
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : 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 quotes.costOptions.remarks

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int32)
  Internal sequence number for the remark.
• remarkText: string
  Remark text related to the remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Internal sequence number for the remark.",
            "type":"number",
            "format":"int32"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text related to the remark qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.costOptions.shipments

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

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 : quotes.costOptions.shipments

Type: object

Show Source

• actualCost: actualCost
  Actual cost.
• costs: costs
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destLocationGid: string
  The GID for the Destination location.
• destLocationName: string
  Destination location name.
• destViaLocationGid: string
  The GID for the destination via location.
• distance: distance
  Distance.
• domainName: string
  Database domain where this data is stored.
• endTime: endTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• flightGid: string
  The GID for the flight that must be used.
• isPrimary: boolean
  The Primary check box is used to specify if this is the primary leg of the shipment.
• links: array links
  Read Only: true
• nfrcRuleGid: string
  The NFRC rule used to create this shipment if it is an NFRC and was created by the system.
• perspective: string
  Perspective - Buy or Sell.
• rateExpiration: rateExpiration
  Expiration data of the rate.
• rateFromLocationGid: string
  The GID for the rating from location.
• rateGeoGid: string
  The GID for the rate record that should be used. This rates the cost option leg for the given rate record.
• rateOfferingGid: string
  The GID for the rate offering that should be used.
• rateToLocationGid: string
  The GID for the rating to location.
• servprovGid: string
  The GID for the service provider that should be used.
• shipmentSequence: number (int32)
  Internal sequence number for shipment information provide as part of the quote option.
• shipmentTypeGid: string
  Indicates the shipment type for this quote cost option shipment.
• sourceAddressLine1: string
  Source location address line 1 value.
• sourceAddressLine2: string
  Source location address line 2 value.
• sourceAddressLine3: string
  Source location address line 3 value.
• sourceCity: string
  Source location city value.
• sourceCountryCode3Gid: string
  Source Location country code value.
• sourceLocationGid: string
  The GID for the source location.
• sourceLocationName: string
  Source location name.
• sourcePostalCode: string
  Source location postal code value.
• sourceProvince: string
  Source location province value.
• sourceViaLocationGid: string
  The GID for the source via location.
• startTime: startTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• transportModeGid: string
  The GID for the transport mode that should be used.
• voyageGid: string
  The GID for the voyage that must be used.

{
    "properties":{
        "shipmentSequence":{
            "description":"Internal sequence number for shipment information provide as part of the quote option. ",
            "type":"number",
            "format":"int32"
        },
        "isPrimary":{
            "description":"The Primary check box is used to specify if this is the primary leg of the shipment.",
            "type":"boolean"
        },
        "actualCost":{
            "description":"Actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "servprovGid":{
            "description":"The GID for the service provider that should be used.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode that should be used.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The GID for the rate offering that should be used.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the rate record that should be used. This rates the cost option leg for the given rate record. ",
            "type":"string"
        },
        "flightGid":{
            "description":"The GID for the flight that must be used.",
            "type":"string"
        },
        "rateFromLocationGid":{
            "description":"The GID for the rating from location.",
            "type":"string"
        },
        "rateToLocationGid":{
            "description":"The GID for the rating to location.",
            "type":"string"
        },
        "sourceViaLocationGid":{
            "description":"The GID for the source via location.",
            "type":"string"
        },
        "destViaLocationGid":{
            "description":"The GID for the destination via location.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The GID for the voyage that must be used.",
            "type":"string"
        },
        "distance":{
            "description":"Distance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "rateExpiration":{
            "description":"Expiration data of the rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID for the source location.",
            "type":"string"
        },
        "sourceLocationName":{
            "description":"Source location name.",
            "type":"string"
        },
        "sourceAddressLine1":{
            "description":"Source location address line 1 value.",
            "type":"string"
        },
        "sourceAddressLine2":{
            "description":"Source location address line 2 value.",
            "type":"string"
        },
        "sourceAddressLine3":{
            "description":"Source location address line 3 value.",
            "type":"string"
        },
        "sourceCity":{
            "description":"Source location city value.",
            "type":"string"
        },
        "sourceProvince":{
            "description":"Source location province value.",
            "type":"string"
        },
        "sourceCountryCode3Gid":{
            "description":"Source Location country code value.",
            "type":"string"
        },
        "sourcePostalCode":{
            "description":"Source location postal code value.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID for the Destination location.",
            "type":"string"
        },
        "destLocationName":{
            "description":"Destination location name.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"Indicates the shipment type for this quote cost option shipment.",
            "type":"string"
        },
        "nfrcRuleGid":{
            "description":"The NFRC rule used to create this shipment if it is an NFRC and was created by the system.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCost

Actual cost.

Match All

Show Source

• object currencyType

{
    "description":"Actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distance

Distance.

Match All

Show Source

• object amountType

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

Nested Schema : endTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "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 : rateExpiration

Expiration data of the rate.

Match All

Show Source

• object dateType

{
    "description":"Expiration data of the rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : startTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.costOptions.shipments.costs

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

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 : quotes.costOptions.shipments.costs

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial cost (if any) on the quote cost option.
• cost: cost
  Cost.
• costExplanation: string
  Explanation for cost.
• costSequence: number (int32)
  Cost sequence number for different cost provided for the quote cost option.
• costType: string
  Cost type - e.g., Base Cost, Accessorial etc.
• description: string
  Description.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  Indicates the payment method that applies to this quote shipment cost.

{
    "properties":{
        "costSequence":{
            "description":"Cost sequence number for different cost provided for the quote cost option.",
            "type":"number",
            "format":"int32"
        },
        "costType":{
            "description":"Cost type - e.g., Base Cost, Accessorial etc.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial cost (if any) on the quote cost option.",
            "type":"string"
        },
        "cost":{
            "description":"Cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "description":{
            "description":"Description.",
            "type":"string"
        },
        "costExplanation":{
            "description":"Explanation for cost.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"Indicates the payment method that applies to this quote shipment cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

Cost.

Match All

Show Source

• object currencyType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : 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 : 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 quotes.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.documents"
    }
}

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 : quotes.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "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 : uploadedAt

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.equipmentGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.equipmentGroups"
    }
}

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 : quotes.equipmentGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroupCount: number (int64)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option.",
            "type":"string"
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.involvedParties

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

Type: object

Show Source

• comMethodGid: string
  Communication method.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  Involved party related to the qualifier.
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"Involved party related to the qualifier.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"Communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• quoteRefnumQualGid: string
  The GID for the reference number qualifier.
• quoteRefnumValue: string
  Reference number value related to the reference number qualifier.

{
    "properties":{
        "quoteRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "quoteRefnumValue":{
            "description":"Reference number value related to the reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.remarks

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualifierGid: string
  A qualifier for the remark.
• remarkSequence: number (int64)
  The sequence to keep remarks unique. It allows multiple of the same qualifier.
• remarkText: string
  The text of the remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence to keep remarks unique. It allows multiple of the same qualifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualifierGid":{
            "description":"A qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.shipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.shipUnits"
    }
}

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 : quotes.shipUnits

Type: object

Show Source

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• itemGid: string
  The GID for the item.
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Show Source

• object currencyType

{
    "description":"Declared value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : height

Height.

Match All

Show Source

• object amountType

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

Nested Schema : length

Length.

Match All

Show Source

• object amountType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : volume

Volume.

Match All

Show Source

• object amountType

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

Nested Schema : weight

Weight.

Match All

Show Source

• object amountType

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

Nested Schema : width

Width.

Match All

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.statuses

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type.
• statusValueGid: string
  Value of status type

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.texts"
    }
}

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 : quotes.texts

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet). ",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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)
• 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
• availableByDate: availableByDate
  The date the freight will be available by if the shipment will not be available to ship until a certain date.
• consolidationTypeGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
• costOptions: costOptions
• deliverByDate: deliverByDate
  The date the freight must be delivered by if the shipment must be delivered by a certain date.
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationLocationGid: string
  The GID for the destination location.
• destinationLocationType: string
  Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destinationSearchValue: string
  Destination rate search value.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• equipmentGroups: equipmentGroups
• expirationDate: expirationDate
  Identifies the last day the quote is valid.
• incoTermGid: string
  The GID for the Incoterm for the shipment. This can limit the itineraries considered.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isCustomerRatesOnly: boolean
  Flag to limit search to customer specific rates only.
• isHazardous: boolean
  Flag indicating if the quote is for a shipment that contains hazardous material.
• issueDate: issueDate
  The date the quote was sent to the customer.
• links: array links
  Read Only: true
• originAddressLine1: string
  Origin location address line 1 value.
• originAddressLine2: string
  Origin location address line 2 value.
• originAddressLine3: string
  Origin location address line 3 value.
• originCity: string
  Origin location city value.
• originCountryCode3Gid: string
  Origin location country code value.
• originLocationGid: string
  The GID for the origin/source location.
• originLocationType: string
  Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.
• originPostalCode: string
  Origin location postal code value.
• originProvince: string
  Origin location province value.
• originSearchValue: string
  Origin rate search value.
• perspective: string
  Perspective - buy or sell side.
• quoteGid: string
  The GID for the quote.
• quoteOption: string
  Select Optimize, Equipment Groups, or Equipment Configuration.
  Optimize returns quotes that match the search criteria. This is the default setting.
  Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.
  Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.
• quoteXid: string
  The XID for the quote.
• refnums: refnums
• remarks: remarks
• requestDate: requestDate
  The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.
• servprovGid: string
  The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.
• shipUnits: shipUnits
• statuses: statuses
• texts: texts
• transportModeGid: string
  The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.
• updateDate: updateDate
  Read Only: true

  update date
• viaDestinationLocationGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
• viaOriginLocationGid: string
  If applicable, the GID for the origin via location.

{
    "properties":{
        "quoteGid":{
            "description":"The GID for the quote.",
            "type":"string"
        },
        "quoteXid":{
            "description":"The XID for the quote.",
            "type":"string"
        },
        "requestDate":{
            "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "issueDate":{
            "description":"The date the quote was sent to the customer.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"Identifies the last day the quote is valid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originLocationType":{
            "description":"Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.",
            "type":"string"
        },
        "originLocationGid":{
            "description":"The GID for the origin/source location.",
            "type":"string"
        },
        "originAddressLine1":{
            "description":"Origin location address line 1 value.",
            "type":"string"
        },
        "originAddressLine2":{
            "description":"Origin location address line 2 value.",
            "type":"string"
        },
        "originAddressLine3":{
            "description":"Origin location address line 3 value.",
            "type":"string"
        },
        "originCity":{
            "description":"Origin location city value.",
            "type":"string"
        },
        "originProvince":{
            "description":"Origin location province value.",
            "type":"string"
        },
        "originCountryCode3Gid":{
            "description":"Origin location country code value.",
            "type":"string"
        },
        "originPostalCode":{
            "description":"Origin location postal code value.",
            "type":"string"
        },
        "viaOriginLocationGid":{
            "description":"If applicable, the GID for the origin via location.",
            "type":"string"
        },
        "destinationLocationType":{
            "description":"Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.",
            "type":"string"
        },
        "destinationLocationGid":{
            "description":"The GID for the destination location.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "viaDestinationLocationGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.",
            "type":"string"
        },
        "isHazardous":{
            "description":"Flag indicating if the quote is for a shipment that contains hazardous material.",
            "type":"boolean"
        },
        "perspective":{
            "description":"Perspective - buy or sell side.",
            "type":"string"
        },
        "quoteOption":{
            "description":"Select Optimize, Equipment Groups, or Equipment Configuration.<br>Optimize returns quotes that match the search criteria. This is the default setting.<br>Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.<br>Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.",
            "type":"string"
        },
        "availableByDate":{
            "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "deliverByDate":{
            "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originSearchValue":{
            "description":"Origin rate search value.",
            "type":"string"
        },
        "destinationSearchValue":{
            "description":"Destination rate search value.",
            "type":"string"
        },
        "isCustomerRatesOnly":{
            "description":"Flag to limit search to customer specific rates only.",
            "type":"boolean"
        },
        "consolidationTypeGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The GID for the Incoterm for the shipment. This can limit the itineraries considered.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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"
                }
            ]
        },
        "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/quotes.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costOptions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.documents"
                    }
                },
                "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 : availableByDate

The date the freight will be available by if the shipment will not be available to ship until a certain date.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : costOptions

Type: object

Show Source

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

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

Nested Schema : deliverByDate

The date the freight must be delivered by if the shipment must be delivered by a certain date.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : equipmentGroups

Type: object

Show Source

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

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

Nested Schema : expirationDate

Identifies the last day the quote is valid.

Match All

Show Source

• object dateTimeType

{
    "description":"Identifies the last day the quote is valid.",
    "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/quotes.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : issueDate

The date the quote was sent to the customer.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the quote was sent to the customer.",
    "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 : refnums

Type: object

Show Source

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

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

Nested Schema : requestDate

The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.

Match All

Show Source

• object dateTimeType

{
    "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipUnits

Type: object

Show Source

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

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

Nested Schema : statuses

Type: object

Show Source

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

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

Nested Schema : texts

Type: object

Show Source

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

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

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

Type: array

Show Source

• Array of: object quotes.costOptions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions"
    }
}

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 : quotes.costOptions

Type: object

Show Source

• buyItineraryGid: string
  Database base amount for total non-transport costs for sell side of this quote option.
• buyNonTransCost: buyNonTransCost
  Total non-transport costs for buy side of this quote option.
• buyTransCost: buyTransCost
  Total non-transport costs for buy side of this quote option.
• costOptionSequence: number (int32)
  Option Number: Each possible cost option is assigned an Option Number.
• domainName: string
  Database domain where this data is stored.
• equipments: equipments
• isFeasibleBuy: boolean
  Currency for total non-transport costs for sell side of this quote option.
• isFeasibleSell: boolean
  Indicates if the buy side option is feasible.
• isLateBuy: boolean
  Total non-transport costs for sell side of this quote option.
• isLateSell: boolean
  Indicates if the buy side option is late.
• links: array links
  Read Only: true
• remarks: remarks
• sellItineraryGid: string
  Itinerary used for the buy side option.
• sellNonTransCost: sellNonTransCost
  Total non-transport costs for sell side of this quote option.
• sellTransCost: sellTransCost
  Total buy side transport cost for this quote option
• shipments: shipments

{
    "properties":{
        "costOptionSequence":{
            "description":"Option Number: Each possible cost option is assigned an Option Number.",
            "type":"number",
            "format":"int32"
        },
        "sellTransCost":{
            "description":"Total buy side transport cost for this quote option",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateSell":{
            "description":"Indicates if the buy side option is late.",
            "type":"boolean"
        },
        "isFeasibleSell":{
            "description":"Indicates if the buy side option is feasible.",
            "type":"boolean"
        },
        "sellItineraryGid":{
            "description":"Itinerary used for the buy side option.",
            "type":"string"
        },
        "buyTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateBuy":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "isFeasibleBuy":{
            "description":"Currency for total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "buyItineraryGid":{
            "description":"Database base amount for total non-transport costs for sell side of this quote option.",
            "type":"string"
        },
        "buyNonTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sellNonTransCost":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : buyNonTransCost

Total non-transport costs for buy side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : buyTransCost

Total non-transport costs for buy side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : equipments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.equipments"
            }
        },
        "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 : remarks

Type: object

Show Source

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

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

Nested Schema : sellNonTransCost

Total non-transport costs for sell side of this quote option.

Match All

Show Source

• object currencyType

{
    "description":"Total non-transport costs for sell side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : sellTransCost

Total buy side transport cost for this quote option

Match All

Show Source

• object currencyType

{
    "description":"Total buy side transport cost for this quote option",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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 quotes.costOptions.equipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.equipments"
    }
}

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 : quotes.costOptions.equipments

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroupCount: number (int32)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option.",
            "type":"string"
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : 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 quotes.costOptions.remarks

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int32)
  Internal sequence number for the remark.
• remarkText: string
  Remark text related to the remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Internal sequence number for the remark.",
            "type":"number",
            "format":"int32"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text related to the remark qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.costOptions.shipments

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

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 : quotes.costOptions.shipments

Type: object

Show Source

• actualCost: actualCost
  Actual cost.
• costs: costs
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destLocationGid: string
  The GID for the Destination location.
• destLocationName: string
  Destination location name.
• destViaLocationGid: string
  The GID for the destination via location.
• distance: distance
  Distance.
• domainName: string
  Database domain where this data is stored.
• endTime: endTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• flightGid: string
  The GID for the flight that must be used.
• isPrimary: boolean
  The Primary check box is used to specify if this is the primary leg of the shipment.
• links: array links
  Read Only: true
• nfrcRuleGid: string
  The NFRC rule used to create this shipment if it is an NFRC and was created by the system.
• perspective: string
  Perspective - Buy or Sell.
• rateExpiration: rateExpiration
  Expiration data of the rate.
• rateFromLocationGid: string
  The GID for the rating from location.
• rateGeoGid: string
  The GID for the rate record that should be used. This rates the cost option leg for the given rate record.
• rateOfferingGid: string
  The GID for the rate offering that should be used.
• rateToLocationGid: string
  The GID for the rating to location.
• servprovGid: string
  The GID for the service provider that should be used.
• shipmentSequence: number (int32)
  Internal sequence number for shipment information provide as part of the quote option.
• shipmentTypeGid: string
  Indicates the shipment type for this quote cost option shipment.
• sourceAddressLine1: string
  Source location address line 1 value.
• sourceAddressLine2: string
  Source location address line 2 value.
• sourceAddressLine3: string
  Source location address line 3 value.
• sourceCity: string
  Source location city value.
• sourceCountryCode3Gid: string
  Source Location country code value.
• sourceLocationGid: string
  The GID for the source location.
• sourceLocationName: string
  Source location name.
• sourcePostalCode: string
  Source location postal code value.
• sourceProvince: string
  Source location province value.
• sourceViaLocationGid: string
  The GID for the source via location.
• startTime: startTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• transportModeGid: string
  The GID for the transport mode that should be used.
• voyageGid: string
  The GID for the voyage that must be used.

{
    "properties":{
        "shipmentSequence":{
            "description":"Internal sequence number for shipment information provide as part of the quote option. ",
            "type":"number",
            "format":"int32"
        },
        "isPrimary":{
            "description":"The Primary check box is used to specify if this is the primary leg of the shipment.",
            "type":"boolean"
        },
        "actualCost":{
            "description":"Actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "servprovGid":{
            "description":"The GID for the service provider that should be used.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode that should be used.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The GID for the rate offering that should be used.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the rate record that should be used. This rates the cost option leg for the given rate record. ",
            "type":"string"
        },
        "flightGid":{
            "description":"The GID for the flight that must be used.",
            "type":"string"
        },
        "rateFromLocationGid":{
            "description":"The GID for the rating from location.",
            "type":"string"
        },
        "rateToLocationGid":{
            "description":"The GID for the rating to location.",
            "type":"string"
        },
        "sourceViaLocationGid":{
            "description":"The GID for the source via location.",
            "type":"string"
        },
        "destViaLocationGid":{
            "description":"The GID for the destination via location.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The GID for the voyage that must be used.",
            "type":"string"
        },
        "distance":{
            "description":"Distance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "rateExpiration":{
            "description":"Expiration data of the rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID for the source location.",
            "type":"string"
        },
        "sourceLocationName":{
            "description":"Source location name.",
            "type":"string"
        },
        "sourceAddressLine1":{
            "description":"Source location address line 1 value.",
            "type":"string"
        },
        "sourceAddressLine2":{
            "description":"Source location address line 2 value.",
            "type":"string"
        },
        "sourceAddressLine3":{
            "description":"Source location address line 3 value.",
            "type":"string"
        },
        "sourceCity":{
            "description":"Source location city value.",
            "type":"string"
        },
        "sourceProvince":{
            "description":"Source location province value.",
            "type":"string"
        },
        "sourceCountryCode3Gid":{
            "description":"Source Location country code value.",
            "type":"string"
        },
        "sourcePostalCode":{
            "description":"Source location postal code value.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID for the Destination location.",
            "type":"string"
        },
        "destLocationName":{
            "description":"Destination location name.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"Indicates the shipment type for this quote cost option shipment.",
            "type":"string"
        },
        "nfrcRuleGid":{
            "description":"The NFRC rule used to create this shipment if it is an NFRC and was created by the system.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCost

Actual cost.

Match All

Show Source

• object currencyType

{
    "description":"Actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distance

Distance.

Match All

Show Source

• object amountType

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

Nested Schema : endTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "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 : rateExpiration

Expiration data of the rate.

Match All

Show Source

• object dateType

{
    "description":"Expiration data of the rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : startTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.costOptions.shipments.costs

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

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 : quotes.costOptions.shipments.costs

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial cost (if any) on the quote cost option.
• cost: cost
  Cost.
• costExplanation: string
  Explanation for cost.
• costSequence: number (int32)
  Cost sequence number for different cost provided for the quote cost option.
• costType: string
  Cost type - e.g., Base Cost, Accessorial etc.
• description: string
  Description.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  Indicates the payment method that applies to this quote shipment cost.

{
    "properties":{
        "costSequence":{
            "description":"Cost sequence number for different cost provided for the quote cost option.",
            "type":"number",
            "format":"int32"
        },
        "costType":{
            "description":"Cost type - e.g., Base Cost, Accessorial etc.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial cost (if any) on the quote cost option.",
            "type":"string"
        },
        "cost":{
            "description":"Cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "description":{
            "description":"Description.",
            "type":"string"
        },
        "costExplanation":{
            "description":"Explanation for cost.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"Indicates the payment method that applies to this quote shipment cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

Cost.

Match All

Show Source

• object currencyType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : 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 : 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 quotes.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.documents"
    }
}

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 : quotes.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "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 : uploadedAt

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.equipmentGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.equipmentGroups"
    }
}

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 : quotes.equipmentGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroupCount: number (int64)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option.",
            "type":"string"
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.involvedParties

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

Type: object

Show Source

• comMethodGid: string
  Communication method.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  Involved party related to the qualifier.
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"Involved party related to the qualifier.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"Communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• quoteRefnumQualGid: string
  The GID for the reference number qualifier.
• quoteRefnumValue: string
  Reference number value related to the reference number qualifier.

{
    "properties":{
        "quoteRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "quoteRefnumValue":{
            "description":"Reference number value related to the reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.remarks

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualifierGid: string
  A qualifier for the remark.
• remarkSequence: number (int64)
  The sequence to keep remarks unique. It allows multiple of the same qualifier.
• remarkText: string
  The text of the remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence to keep remarks unique. It allows multiple of the same qualifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualifierGid":{
            "description":"A qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.shipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.shipUnits"
    }
}

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 : quotes.shipUnits

Type: object

Show Source

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• itemGid: string
  The GID for the item.
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Show Source

• object currencyType

{
    "description":"Declared value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : height

Height.

Match All

Show Source

• object amountType

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

Nested Schema : length

Length.

Match All

Show Source

• object amountType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : volume

Volume.

Match All

Show Source

• object amountType

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

Nested Schema : weight

Weight.

Match All

Show Source

• object amountType

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

Nested Schema : width

Width.

Match All

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.statuses

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type.
• statusValueGid: string
  Value of status type

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.texts"
    }
}

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 : quotes.texts

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet). ",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top