Jump to

• Request
• Response

Get an Equipment

get

/powerUnits/{powerUnitGid}/equipments/{powerUnitEquipmentSeq}

Request

Path Parameters

• powerUnitEquipmentSeq(required): string
  Resource ID
• powerUnitGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

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

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this association with the power unit and equipment.
• equipment: equipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGid: string
  The GID for the equipment defined for the power unit and equipment (trailer) association.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• expirationDate: expirationDate
  The expiration date of this association with the power unit and equipment.
• links: array links
  Read Only: true
• powerUnitEquipmentSeq: number (int64)
  The sequence (key) associated with the power unit and equipment (trailer) join.

{
    "properties":{
        "powerUnitEquipmentSeq":{
            "description":"The sequence (key) associated with the power unit and equipment (trailer) join.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The GID for the equipment defined for the power unit and equipment (trailer) association. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipments"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"The effective date of this association with the power unit and equipment. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this association with the power unit and equipment. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this association with the power unit and equipment.

Match All

The effective date of this association with the power unit and equipment.

Show Source

• object dateTimeType

{
    "description":"The effective date of this association with the power unit and equipment. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipments"
        }
    ],
    "readOnly":true
}

Nested Schema : expirationDate

The expiration date of this association with the power unit and equipment.

Match All

The expiration date of this association with the power unit and equipment.

Show Source

• object dateTimeType

{
    "description":"The expiration date of this association with the power unit and equipment. ",
    "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 : 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 : schema

Type: object

Show Source

• aarCarType: string
  The Association of American Railroads Car Type.
• aarMechDesig: string
  AAR Mechanical Designation.
• arriveDate: arriveDate
  Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.
• assignedProduct: string
  N/A
• 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
• carDestinationEtaDate: carDestinationEtaDate
  This is the estimated arrival time at the car destination.
• carDestinationLocation: carDestinationLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• carDestinationLocationGid: string
  Specifies destination for the car.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• currentChassisInitial: string
  Initial of the current chassis.
• currentChassisNumber: string
  Number of the current chassis.
• customerFleet: string
  This is a more granular field for the organization to specify the customer assignment as the customer wishes. It will identify product, location, customer, or any combination.
• dateBuilt: dateBuilt
  The date this equipment was built.
• divisionName: string
  This is the Business Division name field for part of the organization that is responsible for the asset and the business.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dryCapacity: dryCapacity
  The maximum interior capacity of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from Top of Rail to the Center of Gravity.
• emptyCgLength: emptyCgLength
  When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum permissible weight of the equipment and the load.
• equipmentGid: string
  The GID for equipment.
• equipmentInitial: string
  Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.
• equipmentInitialNumber: string
  Equipment Initial and Number is a concatenation of the equipment initial and equipment number.
• equipmentName: string
  Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS
• equipmentNumber: string
  The number assigned to the equipment and is entered to associate the number with the equipment initial.
• equipmentOwnerType: string
  The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The GID for the equipment type.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentXid: string
  The XID for the equipment type.
• floorHeight: floorHeight
  Actual height of the platform or floor above the ground or the rail.
• insertDate: insertDate
  Read Only: true

  insert date
• interchangeRecvDate: interchangeRecvDate
  Time of the interchange receive.
• interchangeRecvLocation: interchangeRecvLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• interchangeRecvLocationGid: string
  Interchange receive location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• isContainer: boolean
  Yes/No indicator for whether the equipment is a container.
• lastIngateTime: lastIngateTime
  Ingate time stamp at the inbound ramp.
• lastOutgateLocation: lastOutgateLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• lastOutgateLocationGid: string
  The location where the equipment (chassis/container or trailer) was last outgated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• lastOutgateTime: lastOutgateTime
  Outgate time stamp at the outbound ramp.
• lesseeGid: string
  The SCAC for the Lessee of the Equipment.
• licensePlate: string
  The license plate number.
• licenseState: string
  The license state.
• links: array links
  Read Only: true
• liquidCapacity: liquidCapacity
  The number of gallons the equipment will hold.
• loadOrEmpty: string
  Indicates whether the equipment is Load or Empty or Unknown (default)
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• orderCustomerName: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the consignee.
• orderDestination: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
• orderSource: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
• ownerName: string
  Text for the name of the equipment owner.
• ownershipCode: string
  Alpha-numeric code designating the status of the equipment (for example, leased or owned).
• parkLocation: parkLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parkLocationGid: string
  Park location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevReportingRrScac: string
  This is the previous Reporting SCAC. The UPDATE ACTION moves the current value to the previous value before overwriting the current value.
• prevSightingDate: prevSightingDate
  Time of the previous sighting.
• prevSightingEvtScGid: string
  Previous sighting event represents the previous status code of the equipment.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  Previous sighting location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• purchDate: purchDate
  The purchase date of this equipment.
• refnums: refnums
• registrationDate: registrationDate
  The date of the registration.
• registrationNum: string
  Registration number.
• releaseDate: releaseDate
  Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.
• remarks: remarks
• reportingRrScac: string
  This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.
• sightingDate: sightingDate
  Time of the sighting.
• sightingEvtScGid: string
  Sighting event represents the current status code of the equipment.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  Sighting location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• specialServices: specialServices
• statuses: statuses
• tag1: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag2: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag3: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag4: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tareWeight: tareWeight
  The empty weight of the equipment by itself.
• texts: texts
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• trackingEvents: trackingEvents
• truckCenterLength: truckCenterLength
  The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
• truckCount: number (int32)
  The total number of trucks/bogies on the equipment. Applicable only to rail cars.
• umCharge: umCharge
  UMLER Mileage Charge.
• umChargeUnit: umChargeUnit
  UMLER Mileage Charge Unit (example, 2).
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "equipmentGid":{
            "description":"The GID for equipment.",
            "type":"string"
        },
        "equipmentXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentName":{
            "description":"Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "equipmentInitial":{
            "description":"Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number assigned to the equipment and is entered to associate the number with the equipment initial.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"Equipment Initial and Number is a concatenation of the equipment initial and equipment number. ",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Alpha-numeric code designating the status of the equipment (for example, leased or owned).",
            "type":"string"
        },
        "ownerName":{
            "description":"Text for the name of the equipment owner.",
            "type":"string"
        },
        "tag1":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag2":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag3":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag4":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All",
            "type":"string"
        },
        "lesseeGid":{
            "description":"The SCAC for the Lessee of the Equipment.",
            "type":"string"
        },
        "tareWeight":{
            "description":"The empty weight of the equipment by itself.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarCarType":{
            "description":"The Association of American Railroads Car Type.",
            "type":"string"
        },
        "dateBuilt":{
            "description":"The date this equipment was built.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "purchDate":{
            "description":"The purchase date of this equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "registrationNum":{
            "description":"Registration number.",
            "type":"string"
        },
        "registrationDate":{
            "description":"The date of the registration.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "licensePlate":{
            "description":"The license plate number.",
            "type":"string"
        },
        "licenseState":{
            "description":"The license state.",
            "type":"string"
        },
        "sightingLocationGid":{
            "description":"Sighting location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"Time of the sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"Previous sighting location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"Time of the previous sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "interchangeRecvLocationGid":{
            "description":"Interchange receive location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "interchangeRecvLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "interchangeRecvDate":{
            "description":"Time of the interchange receive.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "isContainer":{
            "description":"Yes/No indicator for whether the equipment is a container.",
            "type":"boolean"
        },
        "currentChassisInitial":{
            "description":"Initial of the current chassis.",
            "type":"string"
        },
        "currentChassisNumber":{
            "description":"Number of the current chassis.",
            "type":"string"
        },
        "lastOutgateLocationGid":{
            "description":"The location where the equipment (chassis/container or trailer) was last outgated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "lastOutgateLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "lastOutgateTime":{
            "description":"Outgate time stamp at the outbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastIngateTime":{
            "description":"Ingate time stamp at the inbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "parkLocationGid":{
            "description":"Park location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parkLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "umCharge":{
            "description":"UMLER Mileage Charge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "umChargeUnit":{
            "description":"UMLER Mileage Charge Unit (example, 2).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarMechDesig":{
            "description":"AAR Mechanical Designation.",
            "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"
                }
            ]
        },
        "equipMaxGrossWt":{
            "description":"The maximum permissible weight of the equipment and the load.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"Actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dryCapacity":{
            "description":"The maximum interior capacity of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "liquidCapacity":{
            "description":"The number of gallons the equipment will hold.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "assignedProduct":{
            "description":"N/A",
            "type":"string"
        },
        "carDestinationLocationGid":{
            "description":"Specifies destination for the car. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "carDestinationLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "carDestinationEtaDate":{
            "description":"This is the estimated arrival time at the car destination.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadOrEmpty":{
            "description":"Indicates whether the equipment is Load or Empty or Unknown (default)",
            "type":"string"
        },
        "sightingEvtScGid":{
            "description":"Sighting event represents the current status code of the equipment.",
            "type":"string"
        },
        "prevSightingEvtScGid":{
            "description":"Previous sighting event represents the previous status code of the equipment.",
            "type":"string"
        },
        "divisionName":{
            "description":"This is the Business Division name field for part of the organization that is responsible for the asset and the business.",
            "type":"string"
        },
        "customerFleet":{
            "description":"This is a more granular field for the organization to specify the customer assignment as the customer wishes. It will identify product, location, customer, or any combination.",
            "type":"string"
        },
        "reportingRrScac":{
            "description":"This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.",
            "type":"string"
        },
        "prevReportingRrScac":{
            "description":"This is the previous Reporting SCAC.  The UPDATE ACTION moves the current value to the previous value before overwriting the current value.",
            "type":"string"
        },
        "releaseDate":{
            "description":"Every time a car is released, this field is updated by a customer controlled agent action.  It is used to dynamically calculate in-transit time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "arriveDate":{
            "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "orderSource":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the city and state.",
            "type":"string"
        },
        "orderDestination":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the city and state.",
            "type":"string"
        },
        "orderCustomerName":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the consignee.",
            "type":"string"
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : arriveDate

Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.

Match All

Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.

Show Source

• object dateTimeType

{
    "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

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

Match All

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

This is the estimated arrival time at the car destination.

Match All

This is the estimated arrival time at the car destination.

Show Source

• object dateTimeType

{
    "description":"This is the estimated arrival time at the car destination.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : carDestinationLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : dateBuilt

The date this equipment was built.

Match All

The date this equipment was built.

Show Source

• object dateType

{
    "description":"The date this equipment was built.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : dryCapacity

The maximum interior capacity of the equipment.

Match All

The maximum interior capacity of the equipment.

Show Source

• object amountType

{
    "description":"The maximum interior capacity of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgHeight

When empty, indicates the height from Top of Rail to the Center of Gravity.

Match All

When empty, indicates the height from Top of Rail to the Center of Gravity.

Show Source

• object amountType

{
    "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum permissible weight of the equipment and the load.

Match All

The maximum permissible weight of the equipment and the load.

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the equipment and the load.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : floorHeight

Actual height of the platform or floor above the ground or the rail.

Match All

Actual height of the platform or floor above the ground or the rail.

Show Source

• object amountType

{
    "description":"Actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : interchangeRecvDate

Time of the interchange receive.

Match All

Time of the interchange receive.

Show Source

• object dateTimeType

{
    "description":"Time of the interchange receive.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : interchangeRecvLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : lastIngateTime

Ingate time stamp at the inbound ramp.

Match All

Ingate time stamp at the inbound ramp.

Show Source

• object dateTimeType

{
    "description":"Ingate time stamp at the inbound ramp.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastOutgateLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : lastOutgateTime

Outgate time stamp at the outbound ramp.

Match All

Outgate time stamp at the outbound ramp.

Show Source

• object dateTimeType

{
    "description":"Outgate time stamp at the outbound ramp.",
    "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 : liquidCapacity

The number of gallons the equipment will hold.

Match All

The number of gallons the equipment will hold.

Show Source

• object amountType

{
    "description":"The number of gallons the equipment will hold.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Maximum allowed axle weight. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : parkLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

Time of the previous sighting.

Match All

Time of the previous sighting.

Show Source

• object dateTimeType

{
    "description":"Time of the previous sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : purchDate

The purchase date of this equipment.

Match All

The purchase date of this equipment.

Show Source

• object dateType

{
    "description":"The purchase date of this equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : registrationDate

The date of the registration.

Match All

The date of the registration.

Show Source

• object dateType

{
    "description":"The date of the registration.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : releaseDate

Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.

Match All

Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.

Show Source

• object dateTimeType

{
    "description":"Every time a car is released, this field is updated by a customer controlled agent action.  It is used to dynamically calculate in-transit time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : sightingDate

Time of the sighting.

Match All

Time of the sighting.

Show Source

• object dateTimeType

{
    "description":"Time of the sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : specialServices

Type: object

Show Source

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

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

Nested Schema : tareWeight

The empty weight of the equipment by itself.

Match All

The empty weight of the equipment by itself.

Show Source

• object amountType

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

Nested Schema : texts

Type: object

Show Source

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

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

Nested Schema : trackingEvents

Type: object

Show Source

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

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

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : umCharge

UMLER Mileage Charge.

Match All

UMLER Mileage Charge.

Show Source

• object currencyType

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

Nested Schema : umChargeUnit

UMLER Mileage Charge Unit (example, 2).

Match All

UMLER Mileage Charge Unit (example, 2).

Show Source

• object amountType

{
    "description":"UMLER Mileage Charge Unit (example, 2).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : locations

Type: object

Show Source

• accessorials: accessorials
• addresses: addresses
• addressUpdateDate: addressUpdateDate
  Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.
• addressValidationEde: string
  Indicates which external distance engine is used to validate the location.
• allowDriverRest: boolean
  Indicates if a driver is allowed to take a rest period at this location if he runs out of available HOS.
• appointDisplay: appointDisplay
  The duration of appointment display time period.
• appointDisplayStartTime: number (int32)
  The start time of appointment view display.
• appointmentActivityType: string
  Appointment activity type refers to whether the appointment if for a drop trailer or live unload scenario.
• apptAfterCutoff: apptAfterCutoff
  Service provider appointment duration after cutoff.
• apptBeforeCutoff: apptBeforeCutoff
  Service provider appointment duration before cutoff.
• apptCutoffHours: number (double)
  Service provider appointment cutoff in hours.
• apptEnforceActTimeSg: boolean
  Enforce Activity Time for shipment group appointments.
• apptObjectType: string
  Indicates the types of appointment objects this location handles. Shipments, Shipment Groups or both Shipments and Shipment Groups.
• apptSearchDays: number (double)
  Use the Appointment Search Days field to override the value of the glog.appointment.searchDays property for this location. Set this field to control the number of days to look forward for the first feasible appointment.
• apptShowNumberOfOptions: number (double)
  Use the Appointment Show Number Of Options field to override the value of the glog.appointment.scheduleAppointmentShowOptions.numberOfAppointments property for this location. Set this field to control how many appointments are displayed when running the Schedule Appointment - Show Options action on the Appointment Management page.
• apptStartTimeToleranceSecs: number (int32)
  Stores tolerance value for appointment start time in seconds.
• 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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as 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
• bbIsNewStore: boolean
  Indicates if this location should be treated as a new store by the Batch Balancer logic. New stores can only be assigned by Batch Balancer to a DOOR whose LOAD_NEW_STORE field is set to Y.
• bbMaxCasesPerBatch: number (double)
  Maximum number of cases allowed in each batch. If blank, the system will assume that there is no limit. If the number of cases in the order exceeds this maximum, then the batch balancer's splitting logic will distribute the cases into multiple batches uniformly while honoring certain rules.
• bbOrderSplitMethod: string
  Value of "CONVEYABLE" causes only conveyable cases to be counted toward max cases, value of "ALL" causes all cases (including non-con and repack) to count toward max cases.
• capacityGroups: capacityGroups
• city: string
  The name of the city for the location.
• contacts: contacts
• corporations: corporations
• countryCode3Gid: string
  A GID to define the three digit country code.
• countyQualifier: string
  County Qualifier is used when calling an external distance engine and using an address type of city instead of postal code. Often, there are two cities or towns with the same name in one state. For example, in Pennsylvania there is more than one town with the name "Newtown". If you do not combine the town with a postal code or a county, you may not get the result you want.
  You can manually add values; however, you probably want to import them from the external distance engine that you are using. The county qualifier needs to correspond with the distance engine that you are using.
• deliveryGroupName: string
  Another way of grouping the locations.
• description: string
  Free text to capture different location types or classifications like customer, vendor site, or stores etc.
• destArbLevelOfServiceGid: string
  Preferred destination arbitrary level of service when selecting the destination arbitrary for a location during bulkplan.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
• enforceTimeWindowAppoint: boolean
  Whether or not to enforce the pick up or delivery time window during appointment schedule process."USE_APPOINTMENT_PRIORITY" takes precedence of "ENFORCE_TIME_WINDOW_APPOINT".
• equipmentGroupProfileGid: string
  The GID for the equipment group profile. An Equipment Group Profile is used to categorize Equipment groups by some common attribute or grouping scheme. For example, you can create a Group Profile called Dry Vans that include the 28 FT Dry Van and 24 FT Dry Van (and others if you like) Equipment Groups.
  An Equipment Group Profile consists of an ID and a Profile Name and a collection of specific Equipment Groups that you associate with the profile. Oracle Transportation Management can use the Profile in planning to limit the Equipment Groups that can be used for shipment planning. When Oracle Transportation Management bundles orders and builds shipments, it checks that there is an intersection between the equipment group values identified on the order bases.
  Example: Equipment Group Rule
• erpcGid: string
  The Eastern Region Presidents Commission Code for this Location.
• eruGrouping: string
  To indicate orders going to this location will be grouped together for ERU grouping.
• excludeFromRouteExecution: boolean
  When = Y, this location is excluded from any Route Instance Legs.
• hasMultipleMatches: string
  Indicates if we have multiple matches for the location after address validation.
• insertDate: insertDate
  Read Only: true

  insert date
• isActive: boolean
  Used to activate or deactivate location. When the value is 'N', it can restrain user from planning order to or from the inactive location; from tendering shipment with inactive location.
• isAddressValid: string
  Indicates if the address is considered valid (by checking against the POSTAL_CODE_VALIDATE table).
• isFixedAddress: boolean
  Y/N if address is only allowed to be edited by the UI.
• isLtlSplitable: boolean
  The LTL Splittable check box indicates whether orders from or to this location are permitted to apply the LTL splitting logic. If the check box is not selected, the LTL splitting is disallowed for orders associated with this location.
• isMakeApptBeforePlan: boolean
  A true or false flag to identify if an appointment is required at the location for (example) for pickup, delivery etc.
• isShipperKnown: boolean
  The Known Shipper check box indicates if a shipper is known or unknown. Shippers are considered unknown if they have not filed the appropriate paperwork and gained permission to ship goods on passenger flights. Goods transported by these shippers must be placed on cargo flights. Select Known Shipper if orders coming from this location can be qualified as known, and therefore transported on passenger flights.
• isTemplate: boolean
  Identifies if the location record is a template or represents a physical location.
• isTemporary: boolean
  A flag to identify if the location is created temporarily for a certain shipment or order. This location will not be used for other shipments or processes.
• isWmsFacility: boolean
  Indicates if the location is a warehouse management system facility.
• lat: number (double)
  The latitude for the location.
• links: array links
  Read Only: true
• loadUnloadPoints: loadUnloadPoints
• locationGid: string
  The GID for the location.
• locationGroupGid: string
  The GID for the location group for the location.
• locationName: string
  The name of the location.
• locationXid: string
  The XID for the location.
• lon: number (double)
  The longitude of the location.
• numOfRowsInYard: number (int32)
  The total number of rows in the yard of the location.
• numOfSlotsPerRowInYard: number (int32)
  The number of slots per row in the yard of the location.
• operationalLocations: operationalLocations
• overallQuality: string
  Indicates the overall quality of the location.
• pickupRoutingSequenceGid: string
  Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
• postalCode: string
  The postal code for the location.
• postalSplcGid: string
  The Postal Standard Point Location Code for this Location.
• primaryAddressLineSeq: number (int64)
  The Address Line Number or primary address line sequence number designates which line of the address text box contains the actual street address so when using the External Distance Engine, the correct street address is used.
  For example, if you had this address in the text box, the line number would be 2.
  Care of Someone
  1234 Main St.
  
• province: string
  The province (or U.S. state) for the location.
• provinceCode: string
  The abbreviation for the province (or U.S. state) for the location.
• railJunctionCodeGid: string
  The Rail Junction Code for this Location.
• railSplcGid: string
  The Rail Standard Point Location Code for this Location.
• railStationCodeGid: string
  The Rail Station Code for this Location.
• rateClassificationGid: string
  The GID for the rate classification. Examples include: COMMERCIAL and RESIDENTIAL.
• refnums: refnums
• regionGid: string
  The GID for the region.
• remarks: remarks
• resourceGroups: resourceGroups
• resourceTypes: resourceTypes
• roleProfiles: roleProfiles
• scheduleInfeasibleAppoint: boolean
  Whether or not to schedule appointment if the appointment time available is out of pick up or delivery time window.
• scheduleLowPriorityAppoint: boolean
  Whether or not to schedule appointment for low priority appointment that has been bumped off.
• servingServprovProfileGid: string
  The Serving Service Provider Profile for this Location.
• servprovPrefs: servprovPrefs
• servprovProfileGid: string
  The GID for the service provider for the location.
• shuttleLotEqGrpProfileGid: string
  This specifies the equipment group profile for the shuttle or parking lot of a location. When a shipment uses one of the equipment groups in this equipment group profile, the location cannot be directly accessed for pickup/delivery and is accessed only through the shuttle lot. In this case, additional shuttle lot activity time is computed and added to the activity time at the location.
• slotTimeInterval: slotTimeInterval
  The smallest appointment slot interval for the location.
• sourcingGroupName: string
  Another way of grouping the locations.
• specialServices: specialServices
• srcArbLevelOfServiceGid: string
  Preferred source arbitrary level of service when selecting the source arbitrary for a location during bulkplan.
• standingApptCutoffWindow: number (int32)
  The cutoff window by which unbooked standing appointments to be released.
• statuses: statuses
• substitutes: substitutes
• timeZoneGid: string
  The GID for the time zone of the location. Examples of time zones include America/Curacao and Europe/Monaco.
• updateDate: updateDate
  Read Only: true

  update date
• useAppointmentPriority: boolean
  Whether or not to consider appointment priority.
• useSingleServprovRule: string
  This specifies the use of single service provider rule at a location. The options are: null - rule is not used, P - for pickups only, D - for deliveries only, B - for both pickups and deliveries.
• yardRowLabels: string
  Comma separated list of labels for rows in a yard.
• yardSlotLabels: string
  Comma separated list of labels for slots in a yard.
• zone1: string
  The zone where the location fits in.
• zone2: string
  The zone where the location fits in.
• zone3: string
  The zone where the location fits in.
• zone4: string
  The zone where the location fits in.

{
    "properties":{
        "locationGid":{
            "description":"The GID for the location.",
            "type":"string"
        },
        "locationXid":{
            "description":"The XID for the location.",
            "type":"string"
        },
        "locationName":{
            "description":"The name of the location.",
            "type":"string"
        },
        "city":{
            "description":"The name of the city for the location.",
            "type":"string"
        },
        "province":{
            "description":"The province (or U.S. state) for the location.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The abbreviation for the province (or U.S. state) for the location.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal code for the location.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"A GID to define the three digit country code.",
            "type":"string"
        },
        "zone1":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone2":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone3":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone4":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The GID for the time zone of the location. Examples of time zones include America/Curacao and Europe/Monaco.",
            "type":"string"
        },
        "lat":{
            "description":"The latitude for the location.",
            "type":"number",
            "format":"double"
        },
        "lon":{
            "description":"The longitude of the location.",
            "type":"number",
            "format":"double"
        },
        "sourcingGroupName":{
            "description":"Another way of grouping the locations.",
            "type":"string"
        },
        "deliveryGroupName":{
            "description":"Another way of grouping the locations.",
            "type":"string"
        },
        "regionGid":{
            "description":"The GID for the region.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The GID for the service provider for the location.",
            "type":"string"
        },
        "locationGroupGid":{
            "description":"The GID for the location group for the location.",
            "type":"string"
        },
        "isTemporary":{
            "description":"A flag to identify if the location is created temporarily for a certain shipment or order. This location will not be used for other shipments or processes.",
            "type":"boolean"
        },
        "isMakeApptBeforePlan":{
            "description":"A true or false flag to identify if an appointment is required at the location for (example) for pickup, delivery etc.",
            "type":"boolean"
        },
        "isShipperKnown":{
            "description":"The Known Shipper check box indicates if a shipper is known or unknown. Shippers are considered unknown if they have not filed the appropriate paperwork and gained permission to ship goods on passenger flights. Goods transported by these shippers must be placed on cargo flights. Select Known Shipper if orders coming from this location can be qualified as known, and therefore transported on passenger flights.",
            "type":"boolean"
        },
        "isAddressValid":{
            "description":"Indicates if the address is considered valid (by checking against the POSTAL_CODE_VALIDATE table).",
            "type":"string"
        },
        "rateClassificationGid":{
            "description":"The GID for the rate classification. Examples include: COMMERCIAL and RESIDENTIAL.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The GID for the equipment group profile. An Equipment Group Profile is used to categorize Equipment groups by some common attribute or grouping scheme. For example, you can create a Group Profile called Dry Vans that include the 28 FT Dry Van and 24 FT Dry Van (and others if you like) Equipment Groups.<br>An Equipment Group Profile consists of an ID and a Profile Name and a collection of specific Equipment Groups that you associate with the profile. Oracle Transportation Management can use the Profile in planning to limit the Equipment Groups that can be used for shipment planning. When Oracle Transportation Management bundles orders and builds shipments, it checks that there is an intersection between the equipment group values identified on the order bases.<br>Example: Equipment Group Rule",
            "type":"string"
        },
        "slotTimeInterval":{
            "description":"The smallest appointment slot interval for the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isLtlSplitable":{
            "description":"The LTL Splittable check box indicates whether orders from or to this location are permitted to apply the LTL splitting logic. If the check box is not selected, the LTL splitting is disallowed for orders associated with this location.",
            "type":"boolean"
        },
        "numOfRowsInYard":{
            "description":"The total number of rows in the yard of the location.",
            "type":"number",
            "format":"int32"
        },
        "numOfSlotsPerRowInYard":{
            "description":"The number of slots per row in the yard of the location.",
            "type":"number",
            "format":"int32"
        },
        "useAppointmentPriority":{
            "description":"Whether or not to consider appointment priority.",
            "type":"boolean"
        },
        "scheduleLowPriorityAppoint":{
            "description":"Whether or not to schedule appointment for low priority appointment that has been bumped off.",
            "type":"boolean"
        },
        "enforceTimeWindowAppoint":{
            "description":"Whether or not to enforce the pick up or delivery time window during appointment schedule process.\"USE_APPOINTMENT_PRIORITY\" takes precedence of \"ENFORCE_TIME_WINDOW_APPOINT\".",
            "type":"boolean"
        },
        "scheduleInfeasibleAppoint":{
            "description":"Whether or not to schedule appointment if the appointment time available is out of pick up or delivery time window.",
            "type":"boolean"
        },
        "countyQualifier":{
            "description":"County Qualifier is used when calling an external distance engine and using an address type of city instead of postal code. Often, there are two cities or towns with the same name in one state. For example, in Pennsylvania there is more than one town with the name \"Newtown\". If you do not combine the town with a postal code or a county, you may not get the result you want.<br>You can manually add values; however, you probably want to import them from the external distance engine that you are using. The county qualifier needs to correspond with the distance engine that you are using.",
            "type":"string"
        },
        "bbMaxCasesPerBatch":{
            "description":"Maximum number of cases allowed in each batch.  If blank, the system will assume that there is no limit.  If the number of cases in the order exceeds this maximum, then the batch balancer's splitting logic will distribute the cases into multiple batches uniformly while honoring certain rules.",
            "type":"number",
            "format":"double"
        },
        "bbIsNewStore":{
            "description":"Indicates if this location should be treated as a new store by the Batch Balancer logic.  New stores can only be assigned by Batch Balancer to a DOOR whose LOAD_NEW_STORE field is set to Y.",
            "type":"boolean"
        },
        "bbOrderSplitMethod":{
            "description":"Value of \"CONVEYABLE\" causes only conveyable cases to be counted toward max cases, value of \"ALL\" causes all cases (including non-con and repack) to count toward max cases.",
            "type":"string"
        },
        "excludeFromRouteExecution":{
            "description":"When = Y, this location is excluded from any Route Instance Legs.",
            "type":"boolean"
        },
        "appointDisplay":{
            "description":"The duration of appointment display time period.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "appointDisplayStartTime":{
            "description":"The start time of appointment view display.",
            "type":"number",
            "format":"int32"
        },
        "pickupRoutingSequenceGid":{
            "description":"Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.",
            "type":"string"
        },
        "postalSplcGid":{
            "description":"The Postal Standard Point Location Code for this Location.",
            "type":"string"
        },
        "railSplcGid":{
            "description":"The Rail Standard Point Location Code for this Location.",
            "type":"string"
        },
        "railStationCodeGid":{
            "description":"The Rail Station Code for this Location.",
            "type":"string"
        },
        "erpcGid":{
            "description":"The Eastern Region Presidents Commission Code for this Location.",
            "type":"string"
        },
        "railJunctionCodeGid":{
            "description":"The Rail Junction Code for this Location.",
            "type":"string"
        },
        "servingServprovProfileGid":{
            "description":"The Serving Service Provider Profile for this Location.",
            "type":"string"
        },
        "yardRowLabels":{
            "description":"Comma separated list of labels for rows in a yard.",
            "type":"string"
        },
        "yardSlotLabels":{
            "description":"Comma separated list of labels for slots in a yard.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Identifies if the location record is a template or represents a physical location.",
            "type":"boolean"
        },
        "description":{
            "description":"Free text to capture different location types or classifications like customer, vendor site, or stores etc.",
            "type":"string"
        },
        "standingApptCutoffWindow":{
            "description":"The cutoff window by which unbooked standing appointments to be released.",
            "type":"number",
            "format":"int32"
        },
        "allowDriverRest":{
            "description":"Indicates if a driver is allowed to take a rest period at this location if he runs out of available HOS.",
            "type":"boolean"
        },
        "apptObjectType":{
            "description":"Indicates the types of appointment objects this location handles.  Shipments, Shipment Groups or both Shipments and Shipment Groups.",
            "type":"string"
        },
        "apptSearchDays":{
            "description":"Use the Appointment Search Days field to override the value of the glog.appointment.searchDays property for this location. Set this field to control the number of days to look forward for the first feasible appointment.",
            "type":"number",
            "format":"double"
        },
        "apptShowNumberOfOptions":{
            "description":"Use the Appointment Show Number Of Options field to override the value of the glog.appointment.scheduleAppointmentShowOptions.numberOfAppointments property for this location. Set this field to control how many appointments are displayed when running the Schedule Appointment - Show Options action on the Appointment Management page.",
            "type":"number",
            "format":"double"
        },
        "appointmentActivityType":{
            "description":"Appointment activity type refers to whether the appointment if for a drop trailer or live unload scenario.",
            "type":"string"
        },
        "isFixedAddress":{
            "description":"Y/N if address is only allowed to be edited by the UI.",
            "type":"boolean"
        },
        "primaryAddressLineSeq":{
            "description":"The Address Line Number or primary address line sequence number designates which line of the address text box contains the actual street address so when using the External Distance Engine, the correct street address is used. <br>For example, if you had this address in the text box, the line number would be 2.<br>Care of Someone<br>1234 Main St.<br>",
            "type":"number",
            "format":"int64"
        },
        "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"
                }
            ]
        },
        "isActive":{
            "description":"Used to activate or deactivate location. When the value is 'N', it can restrain user from planning order to or from the inactive location; from tendering shipment with inactive location.",
            "type":"boolean"
        },
        "addressUpdateDate":{
            "description":"Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"Preferred source arbitrary level of service when selecting the source arbitrary for a location during bulkplan.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"Preferred destination arbitrary level of service when selecting the destination arbitrary for a location during bulkplan.",
            "type":"string"
        },
        "useSingleServprovRule":{
            "description":"This specifies the use of single service provider rule at a location. The options are: null - rule is not used, P - for pickups only, D - for deliveries only, B - for both pickups and deliveries.",
            "type":"string"
        },
        "shuttleLotEqGrpProfileGid":{
            "description":"This specifies the equipment group profile for the shuttle or parking lot of a location. When a shipment uses one of the equipment groups in this equipment group profile, the location cannot be directly accessed for pickup/delivery and is accessed only through the shuttle lot. In this case, additional shuttle lot activity time is computed and added to the activity time at the location.",
            "type":"string"
        },
        "isWmsFacility":{
            "description":"Indicates if the location is a warehouse management system facility.",
            "type":"boolean"
        },
        "eruGrouping":{
            "description":"To indicate orders going to this location will be grouped together for ERU grouping.",
            "type":"string"
        },
        "apptEnforceActTimeSg":{
            "description":"Enforce Activity Time for shipment group appointments.",
            "type":"boolean"
        },
        "addressValidationEde":{
            "description":"Indicates which external distance engine is used to validate the location.",
            "type":"string"
        },
        "overallQuality":{
            "description":"Indicates the overall quality of the location.",
            "type":"string"
        },
        "hasMultipleMatches":{
            "description":"Indicates if we have multiple matches for the location after address validation.",
            "type":"string"
        },
        "apptCutoffHours":{
            "description":"Service provider appointment cutoff in hours.",
            "type":"number",
            "format":"double"
        },
        "apptBeforeCutoff":{
            "description":"Service provider appointment duration before cutoff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "apptAfterCutoff":{
            "description":"Service provider appointment duration after cutoff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "apptStartTimeToleranceSecs":{
            "description":"Stores tolerance value for appointment start time in seconds.",
            "type":"number",
            "format":"int32"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "resourceGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contacts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "operationalLocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.operationalLocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "capacityGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.capacityGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "roleProfiles":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "loadUnloadPoints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.loadUnloadPoints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "addresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.addresses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "resourceTypes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "servprovPrefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "substitutes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.substitutes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "corporations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.corporations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

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

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

Nested Schema : addresses

Type: object

Show Source

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

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

Nested Schema : addressUpdateDate

Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointDisplay

The duration of appointment display time period.

Match All

The duration of appointment display time period.

Show Source

• object amountType

{
    "description":"The duration of appointment display time period.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : apptAfterCutoff

Service provider appointment duration after cutoff.

Match All

Service provider appointment duration after cutoff.

Show Source

• object amountType

{
    "description":"Service provider appointment duration after cutoff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : apptBeforeCutoff

Service provider appointment duration before cutoff.

Match All

Service provider appointment duration before cutoff.

Show Source

• object amountType

{
    "description":"Service provider appointment duration before cutoff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

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

Match All

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

• object dateTimeType

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

• object dateTimeType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

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

Nested Schema : contacts

Type: object

Show Source

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

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

Nested Schema : corporations

Type: object

Show Source

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

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

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : loadUnloadPoints

Type: object

Show Source

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

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

Nested Schema : operationalLocations

Type: object

Show Source

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

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

Nested Schema : resourceGroups

Type: object

Show Source

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

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

Nested Schema : resourceTypes

Type: object

Show Source

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

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

Nested Schema : roleProfiles

Type: object

Show Source

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

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

Nested Schema : servprovPrefs

Type: object

Show Source

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

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

Nested Schema : slotTimeInterval

The smallest appointment slot interval for the location.

Match All

The smallest appointment slot interval for the location.

Show Source

• object amountType

{
    "description":"The smallest appointment slot interval for the location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

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

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

Nested Schema : substitutes

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.accessorials

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : locations.accessorials

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.addresses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.addresses"
    }
}

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 : locations.addresses

Type: object

Show Source

• addressLine: string
  Address line data.
• domainName: string
  Database domain where this data is stored.
• lineSequence: number (int64)
  The line sequence number for the address line.
• links: array links
  Read Only: true

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence number for the address line.",
            "type":"number",
            "format":"int64"
        },
        "addressLine":{
            "description":"Address line data.",
            "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 : amountType

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.capacityGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.capacityGroups"
    }
}

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 : locations.capacityGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  Effective date for the location capacity group assigned to the location.
• expirationDate: expirationDate
  Expiration date for the location capacity group assigned to the location.
• links: array links
  Read Only: true
• locCapacityGroupGid: string
  The GID for the location capacity group for this location.

{
    "properties":{
        "locCapacityGroupGid":{
            "description":"The GID for the location capacity group for this location.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective date for the location capacity group assigned to the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"Expiration date for the location capacity group assigned to the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

Effective date for the location capacity group assigned to the location.

Match All

Effective date for the location capacity group assigned to the location.

Show Source

• object dateTimeType

{
    "description":"Effective date for the location capacity group assigned to the location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

Expiration date for the location capacity group assigned to the location.

Match All

Expiration date for the location capacity group assigned to the location.

Show Source

• object dateTimeType

{
    "description":"Expiration date for the location capacity group assigned to the location.",
    "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 : items

Type: array

Show Source

• Array of: object locations.contacts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts"
    }
}

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 : locations.contacts

Type: object

Show Source

• alternateName: string
  If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
  Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
• 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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as 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
• cellPhone: string
  Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
• comMethods: comMethods
• companyName: string
  Company name for this party.
• consolidatedNotifyOnly: boolean
  Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
• consolidationProfileGid: string
  The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
• contactGid: string
  The GID for the contact for the location.
• contactPreferences: contactPreferences
• contactType: string
  Defines whether a contact is a person or group.
• contactXid: string
  The XID for the contact for the location.
• description: string
  Enter any additional descriptive information for this party/contact.
• domainName: string
  Database domain where this data is stored.
• ecmUser: string
  If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
• emailAddress: string
  The email address of the contact person for the location.
• externalSystemGid: string
  The external system GID.
• fax: string
  The facsimile number for the contact person for the location.
• firstName: string
  The given name of the contact person for the location.
• fromAddrContact: fromAddrContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fromAddrContactGid: string
  The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• glUserGid: string
  The GL user GID.
• groupSavedQueryGid: string
  Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• ippPrinterGid: string
  Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
• isBroadcast: boolean
  Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
• isEmailVirusProtected: boolean
  If Y, document attachments may be sent to the contact without virus checking.
• isFromAddress: boolean
  Indicates if a contact is a 'From-Address' contact.
• isNotificationOn: boolean
  No notification will be sent to the contact if this field is set to false ('N').
• isPrimaryContact: boolean
  Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.
• jobTitle: string
  The title for the contact person at the location.
• languageSpoken: string
  The language the contact person at the location speaks.
• lastName: string
  The surname of the contact person for the location.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• messageProfileGid: string
  The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
• middleName: string
  The middle name of the contact.
• nameAddressUpdateDate: nameAddressUpdateDate
  Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
• notes: string
  Text describing something regarding the contact person for the location or the location itself.
• phone1: string
  The primary telephone number for the location's contact person.
• phone2: string
  The secondary telephone number for the location's contact person.
• recipientDomainName: string
  The domain of a message recipient.
• routeThroughLocation: boolean
  Indicates if the notification should use location.
• sendAsMessage: boolean
  Indicates that messages should be sent to message center.
• telex: string
  The telephone number for telex communications for the location's contact person.
• timeZoneGid: string
  Time zone for the contact.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact for the location.",
            "type":"string"
        },
        "contactXid":{
            "description":"The XID for the contact for the location.",
            "type":"string"
        },
        "firstName":{
            "description":"The given name of the contact person for the location.",
            "type":"string"
        },
        "lastName":{
            "description":"The surname of the contact person for the location.",
            "type":"string"
        },
        "jobTitle":{
            "description":"The title for the contact person at the location.",
            "type":"string"
        },
        "emailAddress":{
            "description":"The email address of the contact person for the location.",
            "type":"string"
        },
        "phone1":{
            "description":"The primary telephone number for the location's contact person.",
            "type":"string"
        },
        "phone2":{
            "description":"The secondary telephone number for the location's contact person.",
            "type":"string"
        },
        "fax":{
            "description":"The facsimile number for the contact person for the location.",
            "type":"string"
        },
        "languageSpoken":{
            "description":"The language the contact person at the location speaks.",
            "type":"string"
        },
        "isPrimaryContact":{
            "description":"Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "telex":{
            "description":"The telephone number for telex communications for the location's contact person.",
            "type":"string"
        },
        "externalSystemGid":{
            "description":"The external system GID.",
            "type":"string"
        },
        "notes":{
            "description":"Text describing something regarding the contact person for the location or the location itself.",
            "type":"string"
        },
        "glUserGid":{
            "description":"The GL user GID.",
            "type":"string"
        },
        "recipientDomainName":{
            "description":"The domain of a message recipient.",
            "type":"string"
        },
        "routeThroughLocation":{
            "description":"Indicates if the notification should use location.",
            "type":"boolean"
        },
        "contactType":{
            "description":"Defines whether a contact is a person or group.",
            "type":"string"
        },
        "isBroadcast":{
            "description":"Valid only if the contact_type = 'GROUP'.  This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.",
            "type":"boolean"
        },
        "groupSavedQueryGid":{
            "description":"Valid only if the contact_type = 'GROUP'.  The saved_query could then define which individual contacts belong to the contact_group.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isEmailVirusProtected":{
            "description":"If Y, document attachments may be sent to the contact without virus checking.",
            "type":"boolean"
        },
        "consolidationProfileGid":{
            "description":"The GID for the consolidation profile.  You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.",
            "type":"string"
        },
        "consolidatedNotifyOnly":{
            "description":"Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.",
            "type":"boolean"
        },
        "isNotificationOn":{
            "description":"No notification will be sent to the contact if this field is set to false ('N').",
            "type":"boolean"
        },
        "timeZoneGid":{
            "description":"Time zone for the contact.",
            "type":"string"
        },
        "fromAddrContactGid":{
            "description":"The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fromAddrContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "isFromAddress":{
            "description":"Indicates if a contact is a 'From-Address' contact.",
            "type":"boolean"
        },
        "middleName":{
            "description":"The middle name of the contact.",
            "type":"string"
        },
        "cellPhone":{
            "description":"Contains the mobile/cell  phone number for the location's contact person.  Do not include special characters such as \"+\" and \"-\".",
            "type":"string"
        },
        "sendAsMessage":{
            "description":"Indicates that messages should be sent to message center.",
            "type":"boolean"
        },
        "messageProfileGid":{
            "description":"The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "alternateName":{
            "description":"If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.<br>Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name for this party.",
            "type":"string"
        },
        "description":{
            "description":"Enter any additional descriptive information for this party/contact.",
            "type":"string"
        },
        "ippPrinterGid":{
            "description":"Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.",
            "type":"string"
        },
        "ecmUser":{
            "description":"If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.",
            "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"
                }
            ]
        },
        "nameAddressUpdateDate":{
            "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "comMethods":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts.comMethods"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contactPreferences":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts.contactPreferences"
                    }
                },
                "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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

• object dateTimeType

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

• object dateTimeType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.contacts.comMethods"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contactPreferences

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.contacts.contactPreferences"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fromAddrContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : nameAddressUpdateDate

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.contacts.comMethods

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts.comMethods"
    }
}

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 : locations.contacts.comMethods

Type: object

Show Source

• calendarGid: string
  The calendar GID.
• comMethodGid: string
  The communication method GID.
• comMethodRank: number (int32)
  A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
• domainName: string
  Database domain where this data is stored.
• expectedResponseTime: expectedResponseTime
  This value is used when the location represents the service provider. It specifies the response time for a shipment tender.
• links: array links
  Read Only: true

{
    "properties":{
        "comMethodRank":{
            "description":"A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.",
            "type":"number",
            "format":"int32"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID.",
            "type":"string"
        },
        "expectedResponseTime":{
            "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : expectedResponseTime

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Match All

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Show Source

• object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "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 : items

Type: array

Show Source

• Array of: object locations.contacts.contactPreferences

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts.contactPreferences"
    }
}

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 : locations.contacts.contactPreferences

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• preferenceGid: string
  The preference GID.
• value: string
  The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "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 : schema

Type: object

Show Source

• alternateName: string
  If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
  Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
• 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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as 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
• cellPhone: string
  Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
• comMethods: comMethods
• companyName: string
  Company name for this party.
• consolidatedNotifyOnly: boolean
  Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
• consolidationProfileGid: string
  The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
• contactGid: string
  The GID for the contact for the location.
• contactType: string
  Defines whether a contact is a person or group.
• contactXid: string
  The XID for the contact for the location.
• corporations: corporations
• description: string
  Enter any additional descriptive information for this party/contact.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• ecmUser: string
  If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
• emailAddress: string
  The email address of the contact person for the location.
• externalSystemGid: string
  The external system GID.
• fax: string
  The facsimile number for the contact person for the location.
• firstName: string
  The given name of the contact person for the location.
• fromAddrContact: fromAddrContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fromAddrContactGid: string
  The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• glUserGid: string
  The GL user GID.
• groups: groups
• groupSavedQueryGid: string
  Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• ippPrinterGid: string
  Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
• isBroadcast: boolean
  Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
• isEmailVirusProtected: boolean
  If Y, document attachments may be sent to the contact without virus checking.
• isFromAddress: boolean
  Indicates if a contact is a 'From-Address' contact.
• isNotificationOn: boolean
  No notification will be sent to the contact if this field is set to false ('N').
• isPrimaryContact: boolean
  Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N).
• jobTitle: string
  The title for the contact person at the location.
• languageSpoken: string
  The language the contact person at the location speaks.
• lastName: string
  The surname of the contact person for the location.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• messageProfileGid: string
  The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
• middleName: string
  The middle name of the contact.
• nameAddressUpdateDate: nameAddressUpdateDate
  Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
• notes: string
  Text describing something regarding the contact person for the location or the location itself.
• partyCodes: partyCodes
• partyScreenings: partyScreenings
• phone1: string
  The primary telephone number for the location's contact person.
• phone2: string
  The secondary telephone number for the location's contact person.
• preferences: preferences
• recipientDomainName: string
  The domain of a message recipient.
• refnums: refnums
• remarks: remarks
• routeThroughLocation: boolean
  Indicates if the notification should use location.
• sanctionedScreenings: sanctionedScreenings
• sendAsMessage: boolean
  Indicates that messages should be sent to message center.
• statuses: statuses
• telex: string
  The telephone number for telex communications for the location's contact person.
• timeZoneGid: string
  Time zone for the contact.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact for the location.",
            "type":"string"
        },
        "contactXid":{
            "description":"The XID for the contact for the location.",
            "type":"string"
        },
        "firstName":{
            "description":"The given name of the contact person for the location.",
            "type":"string"
        },
        "lastName":{
            "description":"The surname of the contact person for the location.",
            "type":"string"
        },
        "jobTitle":{
            "description":"The title for the contact person at the location.",
            "type":"string"
        },
        "emailAddress":{
            "description":"The email address of the contact person for the location.",
            "type":"string"
        },
        "phone1":{
            "description":"The primary telephone number for the location's contact person.",
            "type":"string"
        },
        "phone2":{
            "description":"The secondary telephone number for the location's contact person.",
            "type":"string"
        },
        "fax":{
            "description":"The facsimile number for the contact person for the location.",
            "type":"string"
        },
        "languageSpoken":{
            "description":"The language the contact person at the location speaks.",
            "type":"string"
        },
        "isPrimaryContact":{
            "description":"Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N).",
            "type":"boolean"
        },
        "telex":{
            "description":"The telephone number for telex communications for the location's contact person.",
            "type":"string"
        },
        "externalSystemGid":{
            "description":"The external system GID.",
            "type":"string"
        },
        "notes":{
            "description":"Text describing something regarding the contact person for the location or the location itself.",
            "type":"string"
        },
        "glUserGid":{
            "description":"The GL user GID.",
            "type":"string"
        },
        "recipientDomainName":{
            "description":"The domain of a message recipient.",
            "type":"string"
        },
        "routeThroughLocation":{
            "description":"Indicates if the notification should use location.",
            "type":"boolean"
        },
        "contactType":{
            "description":"Defines whether a contact is a person or group.",
            "type":"string"
        },
        "isBroadcast":{
            "description":"Valid only if the contact_type = 'GROUP'.  This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.",
            "type":"boolean"
        },
        "groupSavedQueryGid":{
            "description":"Valid only if the contact_type = 'GROUP'.  The saved_query could then define which individual contacts belong to the contact_group.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isEmailVirusProtected":{
            "description":"If Y, document attachments may be sent to the contact without virus checking.",
            "type":"boolean"
        },
        "consolidationProfileGid":{
            "description":"The GID for the consolidation profile.  You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.",
            "type":"string"
        },
        "consolidatedNotifyOnly":{
            "description":"Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.",
            "type":"boolean"
        },
        "isNotificationOn":{
            "description":"No notification will be sent to the contact if this field is set to false ('N').",
            "type":"boolean"
        },
        "timeZoneGid":{
            "description":"Time zone for the contact.",
            "type":"string"
        },
        "fromAddrContactGid":{
            "description":"The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fromAddrContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "isFromAddress":{
            "description":"Indicates if a contact is a 'From-Address' contact.",
            "type":"boolean"
        },
        "middleName":{
            "description":"The middle name of the contact.",
            "type":"string"
        },
        "cellPhone":{
            "description":"Contains the mobile/cell  phone number for the location's contact person.  Do not include special characters such as \"+\" and \"-\".",
            "type":"string"
        },
        "sendAsMessage":{
            "description":"Indicates that messages should be sent to message center.",
            "type":"boolean"
        },
        "messageProfileGid":{
            "description":"The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "alternateName":{
            "description":"If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.<br>Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name for this party.",
            "type":"string"
        },
        "description":{
            "description":"Enter any additional descriptive information for this party/contact.",
            "type":"string"
        },
        "ippPrinterGid":{
            "description":"Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.",
            "type":"string"
        },
        "ecmUser":{
            "description":"If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.",
            "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"
                }
            ]
        },
        "nameAddressUpdateDate":{
            "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "comMethods":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.comMethods"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "sanctionedScreenings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partyCodes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyCodes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "corporations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.corporations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "preferences":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.preferences"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "groups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.groups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partyScreenings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyScreenings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

• object dateTimeType

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

• object dateTimeType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

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

Nested Schema : corporations

Type: object

Show Source

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

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

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : fromAddrContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : groups

Type: object

Show Source

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

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : nameAddressUpdateDate

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : partyCodes

Type: object

Show Source

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

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

Nested Schema : partyScreenings

Type: object

Show Source

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

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

Nested Schema : preferences

Type: object

Show Source

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

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

Nested Schema : sanctionedScreenings

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.comMethods"
    }
}

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

Type: object

Show Source

• calendarGid: string
  The calendar GID.
• comMethodGid: string
  The communication method GID.
• comMethodRank: number (int32)
  A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
• domainName: string
  Database domain where this data is stored.
• expectedResponseTime: expectedResponseTime
  This value is used when the location represents the service provider. It specifies the response time for a shipment tender.
• links: array links
  Read Only: true

{
    "properties":{
        "comMethodRank":{
            "description":"A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.",
            "type":"number",
            "format":"int32"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID.",
            "type":"string"
        },
        "expectedResponseTime":{
            "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : expectedResponseTime

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Match All

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Show Source

• object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "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 : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.corporations"
    }
}

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

Type: object

Show Source

• corporation: corporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• corporationGid: string
  The GID for the corporation related to the contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "corporationGid":{
            "description":"The GID for the corporation related to the contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "corporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object corporations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "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 : corporations

Type: object

Show Source

• corporationGid: string
  Contains the GID for the corporation.
• corporationName: string
  Contains the name of the corporation.
• corporationXid: string
  Contains the XID for the corporation.
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isAllowHouseCollect: boolean
  The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms. Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.
• isDomainMaster: boolean
  Check box field to identify a corporation record as the domain master. The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.
• isShippingAgentsActive: boolean
  Indicates if corporation is active. Used with agents.
• links: array links
  Read Only: true
• maxHouseCollectAmt: maxHouseCollectAmt
  If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.
• pickupRoutingSequenceGid: string
  The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• updateDate: updateDate
  Read Only: true

  update date
• vatProvincialRegistrations: vatProvincialRegistrations
• vatRegistrations: vatRegistrations

{
    "properties":{
        "corporationGid":{
            "description":"Contains the GID for the corporation.",
            "type":"string"
        },
        "corporationXid":{
            "description":"Contains the XID for the corporation.",
            "type":"string"
        },
        "corporationName":{
            "description":"Contains the name of the corporation.",
            "type":"string"
        },
        "isDomainMaster":{
            "description":"Check box field to identify a corporation record as the domain master.  The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.",
            "type":"boolean"
        },
        "isShippingAgentsActive":{
            "description":"Indicates if corporation is active. Used with agents.",
            "type":"boolean"
        },
        "isAllowHouseCollect":{
            "description":"The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms.  Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.",
            "type":"boolean"
        },
        "maxHouseCollectAmt":{
            "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pickupRoutingSequenceGid":{
            "description":"The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "vatProvincialRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : maxHouseCollectAmt

If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.

Match All

If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.

Show Source

• object currencyType

{
    "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : vatProvincialRegistrations

Type: object

Show Source

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

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

Nested Schema : vatRegistrations

Type: object

Show Source

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

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

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 corporations.involvedParties

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

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the 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 : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 : 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 corporations.vatProvincialRegistrations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
    }
}

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 : corporations.vatProvincialRegistrations

Type: object

Show Source

• countryCode3Gid: string
  The country code for the provincial VAT registration.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• provinceCode: string
  The province code of the registration.
• vatProvincialRegGid: string
  The provincial VAT registration ID.
• vatProvincialRegXid: string
  The XID for the provincial VAT registration.

{
    "properties":{
        "vatProvincialRegGid":{
            "description":"The provincial VAT registration ID.",
            "type":"string"
        },
        "vatProvincialRegXid":{
            "description":"The XID for the provincial VAT registration.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code for the provincial VAT registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code of the registration.",
            "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 corporations.vatRegistrations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatRegistrations"
    }
}

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 : corporations.vatRegistrations

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• vatRegNoGid: string
  VAT registration linked to the corporation indicated by the corporation GID.

{
    "properties":{
        "vatRegNoGid":{
            "description":"VAT registration linked to the corporation indicated by the corporation GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object tradeParties.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.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 : tradeParties.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.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• 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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

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

Nested Schema : documents

Type: object

Show Source

• cmsParams: cmsParams
• contentManagementSystemGid: string
  No description.
• contents: contents
• contexts: contexts
• documentCmsId: string
  Read Only: true

  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. This attribute is marked as Create-Only.
• documentTrackingNum: string
  No description.
• documentType: string
  Read Only: true

  No description.
• documentUrl: string
  Read Only: true

  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
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• ownerObjectGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• statuses: statuses
• updateDate: updateDate
  Read Only: true

  update date
• 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",
            "readOnly":true
        },
        "documentType":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentMimeType":{
            "description":"No description. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "ownerObjectGid":{
            "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",
            "readOnly":true
        },
        "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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "contexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "cmsParams":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.cmsParams"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cmsParams

Type: object

Show Source

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

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

Nested Schema : contents

Type: object

Show Source

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

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

Nested Schema : contexts

Type: object

Show Source

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

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

Show Source

• object dateTimeType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "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/documents.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

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 documents.cmsParams

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

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

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• paramName: string
  Parameter name
• paramValue: string
  Parameter value

{
    "properties":{
        "paramName":{
            "description":"Parameter name",
            "type":"string"
        },
        "paramValue":{
            "description":"Parameter value",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object documents.contents

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

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

Type: object

Show Source

• documentContentGid: string
  NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContentGid":{
            "description":"NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object documents.contexts

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

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

Type: object

Show Source

• documentContextQualGid: string
  Represents the document context qualifier.
• documentContextValue: string
  Represents the value of a document context qualifier.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContextQualGid":{
            "description":"Represents the document context qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "documentContextValue":{
            "description":"Represents the value of a document context qualifier.",
            "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 documents.statuses

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

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.groups"
    }
}

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

Type: object

Show Source

• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The contact GID references a person contact which will inherit notifications, etc. from it's contact group. A contact may belong to more than one contact group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The contact GID references a person contact which will inherit notifications, etc. from it's contact group.  A contact may belong to more than one contact group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 schema

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

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method.
• domainName: string
  Database domain where this data is stored.
• gtmRegistrationGid: string
  The GID for the registration being assigned to the party.
• involvedPartyQualGid: string
  The GID for the involved party qualifier related to the registration.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmRegistrationGid":{
            "description":"The GID for the registration being assigned to the party.",
            "type":"string"
        },
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier related to the registration.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the 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 schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyCodes"
    }
}

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmCode: string
  The code is related to the type which is related to the user defined party classification.
• gtmTypeGid: string
  The GID for the type related to the user defined party classification.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTypeGid":{
            "description":"The GID for the type related to the user defined party classification.",
            "type":"string"
        },
        "gtmCode":{
            "description":"The code is related to the type which is related to the user defined party classification.",
            "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 schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings"
    }
}

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

Type: object

Show Source

• approvedBy: string
  Approver for matches requiring review.
• domainName: string
  Database domain where this data is stored.
• gtmDeniedPartyGid: string
  The GID for the denied party.
• gtmServicePrefGid: string
  The unique GID for the service preference used for screening.
• links: array links
  Read Only: true
• matchFactor: number (int32)
  Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.
• partyScreeningComments: partyScreeningComments
• partyScreeningSequence: number (int64)
  Sequence number for potential matches.
• screeningStatus: string
  Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened. Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user. Not a Match
  - No similarity exists between the restricted party list and the contact being screened. Escalated -
  The potential match was referred to another person for review.

{
    "properties":{
        "partyScreeningSequence":{
            "description":"Sequence number for potential matches.",
            "type":"number",
            "format":"int64"
        },
        "gtmDeniedPartyGid":{
            "description":"The GID for the denied party.",
            "type":"string"
        },
        "screeningStatus":{
            "description":"Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened.  Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user.  Not a Match<br> - No similarity exists between the restricted party list and the contact being screened.  Escalated -<br>The potential match was referred to another person for review.",
            "type":"string"
        },
        "approvedBy":{
            "description":"Approver for matches requiring review.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "matchFactor":{
            "description":"Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.",
            "type":"number",
            "format":"int32"
        },
        "gtmServicePrefGid":{
            "description":"The unique GID for the service preference used for screening.",
            "type":"string"
        },
        "partyScreeningComments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : partyScreeningComments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
    }
}

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

Type: object

Show Source

• commentBy: string
  User entering the comment.
• commentText: string
  Text related to comment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partyCommentSequence: number (int64)
  Sequence number for potential matches comment.

{
    "properties":{
        "partyCommentSequence":{
            "description":"Sequence number for potential matches comment.",
            "type":"number",
            "format":"int64"
        },
        "commentText":{
            "description":"Text related to comment.",
            "type":"string"
        },
        "commentBy":{
            "description":"User entering the comment.",
            "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 schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.preferences"
    }
}

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• preferenceGid: string
  The preference GID.
• value: string
  The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "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 schema

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmPartyRefnumQualGid: string
  The GID for the party reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value for the reference number.

{
    "properties":{
        "gtmPartyRefnumQualGid":{
            "description":"The GID for the party reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value for the reference number.",
            "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 schema

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The unique GID for the remark qualifier.
• remarkSeqNo: number (int64)
  Sequence number for remark. Not visible in the UI.
• remarkText: string
  Remark text.

{
    "properties":{
        "remarkSeqNo":{
            "description":"Sequence number for remark. Not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The unique GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "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 schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
    }
}

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

Type: object

Show Source

• complianceRuleGid: string
  The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.
• complianceRuleGroupGid: string
  The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.
• controlCode: string
  The control type and control code are linked to the compliance rule.
• controlTypeGid: string
  The GID for the GTM control type. The control type is linked to the compliance rule.
• domainName: string
  Database domain where this data is stored.
• gtmContactStScreenGid: string
  The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
• gtmContactStScreenXid: string
  The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
• links: array links
  Read Only: true
• regulationReferenceGid: string
  The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.

{
    "properties":{
        "gtmContactStScreenGid":{
            "description":"The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "controlTypeGid":{
            "description":"The GID for the GTM control type. The control type is linked to the compliance rule.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control type and control code are linked to the compliance rule.",
            "type":"string"
        },
        "regulationReferenceGid":{
            "description":"The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.",
            "type":"string"
        },
        "gtmContactStScreenXid":{
            "description":"The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "complianceRuleGroupGid":{
            "description":"The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.",
            "type":"string"
        },
        "complianceRuleGid":{
            "description":"The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.",
            "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 schema

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

Type: object

Show Source

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

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the contact status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type.",
            "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 locations.corporations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.corporations"
    }
}

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 : locations.corporations

Type: object

Show Source

• corporation: corporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• corporationGid: string
  CORPORATION_GID contains the unique identifier for the location's corporation.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "corporationGid":{
            "description":"CORPORATION_GID contains the unique identifier for the location's corporation. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "corporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object corporations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "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 locations.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.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 : locations.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.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• 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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

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 locations.loadUnloadPoints

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.loadUnloadPoints"
    }
}

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 : locations.loadUnloadPoints

Type: object

Show Source

• description: string
  Description for the load/unload point.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupProfileGid: string
  Equipment group profile for the load/unload point; overrides any at the location.
• isLoad: boolean
  Indicates if this dock or point make be used for loading.
• isUnload: boolean
  Indicates if this dock or point make be used for loading.
• links: array links
  Read Only: true
• loadSequence: number (int32)
  Indicates where dock should be in a load sequence.
• loadUnloadPoint: string
  Load/unload point such as a loading dock.
• unloadSequence: number (int32)
  Indicates where dock should be in an unload sequence.

{
    "properties":{
        "loadUnloadPoint":{
            "description":"Load/unload point such as a loading dock.",
            "type":"string"
        },
        "description":{
            "description":"Description for the load/unload point.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"Equipment group profile for the load/unload point; overrides any at the location.",
            "type":"string"
        },
        "isLoad":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "loadSequence":{
            "description":"Indicates where dock should be in a load sequence.",
            "type":"number",
            "format":"int32"
        },
        "isUnload":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "unloadSequence":{
            "description":"Indicates where dock should be in an unload sequence.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.operationalLocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.operationalLocations"
    }
}

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 : locations.operationalLocations

Type: object

Show Source

• details: details
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• operationalLocation: operationalLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• operationalLocationGid: string
  Sub location belonging to a main location. Sub location may only belong to one location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "operationalLocationGid":{
            "description":"Sub location belonging to a main location. Sub location may only belong to one location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "operationalLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.operationalLocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.operationalLocations.details"
            }
        },
        "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 : operationalLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.operationalLocations.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.operationalLocations.details"
    }
}

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 : locations.operationalLocations.details

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exclusionRegionGid: string
  If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.
• inboundOutboundType: string
  Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).
• inclusionRegionGid: string
  If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.
• links: array links
  Read Only: true
• primaryLegLocProfileGid: string
  The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.
• primaryLegServprov: primaryLegServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryLegServprovGid: string
  The service provider of the main leg which will help indicate which operational location applies.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• seqNo: number (int64)
  Sequence to allow multiple data records for the same operational location.

{
    "properties":{
        "seqNo":{
            "description":"Sequence to allow multiple data records for the same operational location.",
            "type":"number",
            "format":"int64"
        },
        "primaryLegServprovGid":{
            "description":"The service provider of the main leg which will help indicate which operational location applies. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryLegServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "primaryLegLocProfileGid":{
            "description":"The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.",
            "type":"string"
        },
        "inboundOutboundType":{
            "description":"Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).",
            "type":"string"
        },
        "inclusionRegionGid":{
            "description":"If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.",
            "type":"string"
        },
        "exclusionRegionGid":{
            "description":"If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.",
            "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 : primaryLegServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• aliases: aliases
• allocationRuleProfileGid: string
  The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
• allowSgTender: boolean
  Ship group allow tender determines whether the system can automatically tender ship group to this service provider.By default it is set to 'N'
• allowSpotRating: boolean
  Flag to indicate that service provider is valid for Spot Rating actions
• allowTender: boolean
  Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.
  Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.
• 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
• autoApproveRuleProfileGid: string
  The GID for the auto approve rule profile.
• autoPaymentFlag: boolean
  Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.
• broadcastSpotContact: broadcastSpotContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• broadcastSpotContactGid: string
  Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• doConditionalAccepts: boolean
  Determines if the service provider can participate in conditional booking.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• epaIndexValue: number (double)
  If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.
• equipmentMarkListGid: string
  The Equipment Mark List for this Service Provider.
• incumbent: boolean
  Select the Incumbent check box to indicate that this service provider has been used previously.
• insertDate: insertDate
  Read Only: true

  insert date
• invoicingProcess: string
  The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.
• isAcceptBroadcastTenders: boolean
  Is set to Y(es) if the service provider will participate in broadcast tendering.
• isAcceptBySsuAllowed: boolean
  Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.
• isAcceptSpotBids: boolean
  Is set to Y(es) if the service provider will participate in spot bid tendering.
• isActive: boolean
  This flag will define whether service provider is active or not.By default this flag will be Y.
• isCopyInvDeltaBackToShip: boolean
  The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.
• isDispatchByRegion: boolean
  A flag to turn on/off the Tender by Locale feature.
• isFleet: boolean
  Only shipments created for fleet service providers can perform fleet related actions.
• isInternalNvocc: boolean
  The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job.
• isLocalizeBroadcastContact: boolean
  If "Y", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.
• isMinority: boolean
  Select the Minority check box if the business is minority-owned.
• lineApproveTolProfileGid: string
  Indicates the line approval tolerance rule profile to apply.
• links: array links
  Read Only: true
• matchRuleProfileGid: string
  The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.
• matchValidRuleProfileGid: string
  A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.
• modeProfileGid: string
  A GID to define the mode profiles(group) that the service provider uses.
• nvoccDomainName: string
  The NVOCC Domain field determines the domain in which the buy shipments and new job are created.
• obtXmlProfileGid: string
  Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.
• outXmlProfileGid: string
  Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.
• rateServiceGid: string
  Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment
• scacGid: string
  The Standard Carrier Alpha Code for this Service Provider.
• scorecardValue: number (double)
  If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.
• servprovGid: string
  The service provider GID.
• servprovLocation: servprovLocation
  The primary location for the service provider.
• servprovXid: string
  The service provider XID.
• sgTenderOutXmlProfileGid: string
  Associates the service provider with an out_xml_profile, which helps define the content of outgoing ship group tender XML to this service provider.
• sourcingContact: sourcingContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourcingContactGid: string
  The GID for the contact at the service provider who is responsible for sourcing activities.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• spotRateAdjustmentFactor: number (double)
  Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.
• tenderResponseTime: tenderResponseTime
  The expected response time by this service provider for shipment tenders.
• tier: number (double)
  Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "servprovGid":{
            "description":"The service provider GID.",
            "type":"string"
        },
        "servprovXid":{
            "description":"The service provider XID.",
            "type":"string"
        },
        "tenderResponseTime":{
            "description":"The expected response time by this service provider for shipment tenders.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "modeProfileGid":{
            "description":"A GID to define the mode profiles(group) that the service provider uses.",
            "type":"string"
        },
        "matchRuleProfileGid":{
            "description":"The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.",
            "type":"string"
        },
        "matchValidRuleProfileGid":{
            "description":"A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.",
            "type":"string"
        },
        "autoPaymentFlag":{
            "description":"Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.",
            "type":"boolean"
        },
        "autoApproveRuleProfileGid":{
            "description":"The GID for the auto approve rule profile.",
            "type":"string"
        },
        "allocationRuleProfileGid":{
            "description":"The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.",
            "type":"string"
        },
        "isDispatchByRegion":{
            "description":"A flag to turn on/off the Tender by Locale feature.",
            "type":"boolean"
        },
        "allowTender":{
            "description":"Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.<br>Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.",
            "type":"boolean"
        },
        "outXmlProfileGid":{
            "description":"Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment",
            "type":"string"
        },
        "isAcceptSpotBids":{
            "description":"Is set to Y(es) if the service provider will participate in spot bid tendering.",
            "type":"boolean"
        },
        "isAcceptBroadcastTenders":{
            "description":"Is set to Y(es) if the service provider will participate in broadcast tendering.",
            "type":"boolean"
        },
        "isLocalizeBroadcastContact":{
            "description":"If \"Y\", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.",
            "type":"boolean"
        },
        "spotRateAdjustmentFactor":{
            "description":"Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.",
            "type":"number",
            "format":"double"
        },
        "broadcastSpotContactGid":{
            "description":"Overrides the shipper's primary contact to be used to determine localization preferences for tender notification. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "broadcastSpotContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "doConditionalAccepts":{
            "description":"Determines if the service provider can participate in conditional booking.",
            "type":"boolean"
        },
        "isInternalNvocc":{
            "description":"The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job. ",
            "type":"boolean"
        },
        "nvoccDomainName":{
            "description":"The NVOCC Domain field determines the domain in which the buy shipments and new job are created.",
            "type":"string"
        },
        "isAcceptBySsuAllowed":{
            "description":"Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.",
            "type":"boolean"
        },
        "isCopyInvDeltaBackToShip":{
            "description":"The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.",
            "type":"boolean"
        },
        "invoicingProcess":{
            "description":"The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.",
            "type":"string"
        },
        "lineApproveTolProfileGid":{
            "description":"Indicates the line approval tolerance rule profile to apply.",
            "type":"string"
        },
        "scacGid":{
            "description":"The Standard Carrier Alpha Code for this Service Provider.",
            "type":"string"
        },
        "equipmentMarkListGid":{
            "description":"The Equipment Mark List for this Service Provider.",
            "type":"string"
        },
        "isMinority":{
            "description":"Select the Minority check box if the business is minority-owned.",
            "type":"boolean"
        },
        "incumbent":{
            "description":"Select the Incumbent check box to indicate that this service provider has been used previously.",
            "type":"boolean"
        },
        "tier":{
            "description":"Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.",
            "type":"number",
            "format":"double"
        },
        "scorecardValue":{
            "description":"If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.",
            "type":"number",
            "format":"double"
        },
        "epaIndexValue":{
            "description":"If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.",
            "type":"number",
            "format":"double"
        },
        "isFleet":{
            "description":"Only shipments created for fleet service providers can perform fleet related actions.",
            "type":"boolean"
        },
        "sourcingContactGid":{
            "description":"The GID for the contact at the service provider who is responsible for sourcing activities. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourcingContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "allowSpotRating":{
            "description":"Flag to indicate that service provider is valid for Spot Rating actions",
            "type":"boolean"
        },
        "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"
        },
        "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"
                }
            ]
        },
        "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"
        },
        "obtXmlProfileGid":{
            "description":"Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.",
            "type":"string"
        },
        "isActive":{
            "description":"This flag will define whether service provider is active or not.By default this flag will be Y.",
            "type":"boolean"
        },
        "sgTenderOutXmlProfileGid":{
            "description":"Associates the service provider with an out_xml_profile, which helps define the content of outgoing ship group tender XML to this service provider.",
            "type":"string"
        },
        "allowSgTender":{
            "description":"Ship group allow tender determines whether the system can automatically tender  ship group to this service provider.By default it is set to 'N'",
            "type":"boolean"
        },
        "servprovLocation":{
            "description":"The primary location for the service provider.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "aliases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceProviders.aliases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceProviders.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : aliases

Type: object

Show Source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : servprovLocation

The primary location for the service provider.

Match All

The primary location for the service provider.

Show Source

• object locations

{
    "description":"The primary location for the service provider.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : sourcingContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : tenderResponseTime

The expected response time by this service provider for shipment tenders.

Match All

The expected response time by this service provider for shipment tenders.

Show Source

• object amountType

{
    "description":"The expected response time by this service provider for shipment tenders.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceProviders.aliases"
    }
}

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

Type: object

Show Source

• alias: string
  Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider. Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• servprovAliasQualGid: string
  The GID for the service provider alias qualifier.

{
    "properties":{
        "servprovAliasQualGid":{
            "description":"The GID for the service provider alias qualifier.",
            "type":"string"
        },
        "alias":{
            "description":"Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider.  Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.",
            "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 serviceProviders.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceProviders.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 : serviceProviders.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.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• 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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

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 locations.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationRefnumQualGid: string
  The GID for the location reference number qualifier.
• locationRefnumValue: string
  The value associated with the location reference number qualifier.

{
    "properties":{
        "locationRefnumQualGid":{
            "description":"The GID for the location reference number qualifier.",
            "type":"string"
        },
        "locationRefnumValue":{
            "description":"The value associated with the location 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 locations.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.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 : locations.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 for the location.
• remarkSequence: number (int64)
  The sequence number for the remark for this location.
• remarkText: string
  The text of the remark for the location.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the remark for this location.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier for the location.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark for the location.",
            "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 locations.resourceGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceGroups"
    }
}

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 : locations.resourceGroups

Type: object

Show Source

• calendarGid: string
  The calendar GID that will be applied to the location of the location resource group.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationResourceGroupGid: string
  The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.
• preferenceLevel: number (int32)
  Used to get preference level of location resource group for Appointment scheduling

{
    "properties":{
        "locationResourceGroupGid":{
            "description":"The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID that will be applied to the location of the location resource group.",
            "type":"string"
        },
        "preferenceLevel":{
            "description":"Used to get preference level of location resource group for Appointment scheduling",
            "type":"number",
            "format":"int32"
        },
        "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 locations.resourceTypes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes"
    }
}

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 : locations.resourceTypes

Type: object

Show Source

• autoScheduleAppointment: boolean
  Indicate whether appointment should be automatically scheduled for the resource type.
• calendarGid: string
  The calendar GID that applies to the location resource type.
• constraintAppointment: boolean
  Whether the location resource type constraints scheduling appointments.
• description: string
  The description of the location resource type.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• resources: resources
• resourceTypeGid: string
  Resource Type GID for the location.

{
    "properties":{
        "resourceTypeGid":{
            "description":"Resource Type GID for the location.",
            "type":"string"
        },
        "description":{
            "description":"The description of the location resource type.",
            "type":"string"
        },
        "constraintAppointment":{
            "description":"Whether the location resource type constraints scheduling appointments.",
            "type":"boolean"
        },
        "calendarGid":{
            "description":"The calendar GID that applies to the location resource type.",
            "type":"string"
        },
        "autoScheduleAppointment":{
            "description":"Indicate whether appointment should be automatically scheduled for the resource type.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "resources":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : resources

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources"
    }
}

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 : locations.resourceTypes.resources

Type: object

Show Source

• appointmentActivityType: string
  Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.
• apptRuleSets: apptRuleSets
• calendarGid: string
  The calendar GID that will be applied to the resource.
• contactProfileGid: string
  The contact profile GID.
• description: string
  The description of the resource.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupProfileGid: string
  The equipment group profile ID that associates to the location resource.
• flexCommodityCheckOption: string
  Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.
• flexCommodityProfileGid: string
  The flex commodity profile ID that associates to the location resource.
• links: array links
  Read Only: true
• locationResourceGid: string
  The location resource GID.
• locationResourceGroupGid: string
  The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.
• locationResourceName: string
  The name of the resource.
• locationResourceXid: string
  The XID of the location resource.
• modeProfileGid: string
  The mode profile ID that associates to the location resource.
• preferenceLevel: number (int32)
  Gets the preference level of resource for Appointment scheduling
• servprovProfileGid: string
  The service provider profile ID that associates to the location resource.

{
    "properties":{
        "locationResourceGid":{
            "description":"The location resource GID.",
            "type":"string"
        },
        "locationResourceXid":{
            "description":"The XID of the location resource.",
            "type":"string"
        },
        "locationResourceName":{
            "description":"The name of the resource.",
            "type":"string"
        },
        "description":{
            "description":"The description of the resource.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID that will be applied to the resource.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The flex commodity profile ID that associates to the location resource.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile ID that associates to the location resource.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The mode profile ID that associates to the location resource.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The service provider profile ID that associates to the location resource.",
            "type":"string"
        },
        "contactProfileGid":{
            "description":"The contact profile GID.",
            "type":"string"
        },
        "flexCommodityCheckOption":{
            "description":"Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.",
            "type":"string"
        },
        "appointmentActivityType":{
            "description":"Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "preferenceLevel":{
            "description":"Gets the preference level of resource for Appointment scheduling",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGroupGid":{
            "description":"The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.",
            "type":"string"
        },
        "apptRuleSets":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : apptRuleSets

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
            }
        },
        "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 locations.resourceTypes.resources.apptRuleSets

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
    }
}

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 : locations.resourceTypes.resources.apptRuleSets

Type: object

Show Source

• apptRuleSetGid: string
  The GID for the appointment rule set.
• domainName: string
  Database domain where this data is stored.
• flexFields: flexFields
• links: array links
  Read Only: true
• refnums: refnums

{
    "properties":{
        "apptRuleSetGid":{
            "description":"The GID for the appointment rule set.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFields":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : flexFields

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
            }
        },
        "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 : refnums

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets.flexFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
    }
}

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 : locations.resourceTypes.resources.apptRuleSets.flexFields

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• flexFieldName: string
  Flex field name
• flexFieldValue: string
  Flex field value.
• isCompatible: boolean
  If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
  If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.
• links: array links
  Read Only: true

{
    "properties":{
        "flexFieldName":{
            "description":"Flex field name",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFieldValue":{
            "description":"Flex field value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.<br>If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.",
            "type":"boolean"
        },
        "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 locations.resourceTypes.resources.apptRuleSets.refnums

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

Type: object

Show Source

• apptRefnumQualGid: string
  The appointment reference number qualifier. The qualifier related to shipment is used.
• apptRefnumValue: string
  The appointment reference number value.
• domainName: string
  Database domain where this data is stored.
• isCompatible: boolean
  If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
  If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.
  For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.
  Shipment Reference Number Qualifier and Value
  Appointment Rule Set Reference Number Qualifier and Value
  Q1 V1 Q1 V1, selected
  Q2 V2 Q2 V2, selected
  Q3 V3
  Q4 V4
  In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.
  To define shipment reference numbers constraints, enter or select the following fields, which are optional:
  Reference Number Qualifier ID.
  Reference Number.
• links: array links
  Read Only: true

{
    "properties":{
        "apptRefnumQualGid":{
            "description":"The appointment reference number qualifier. The qualifier related to shipment is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "apptRefnumValue":{
            "description":"The appointment reference number value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.<br>If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.<br>For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.<br>Shipment Reference Number Qualifier and Value<br>Appointment Rule Set Reference Number Qualifier and Value<br>Q1 V1 Q1 V1, selected<br>Q2 V2 Q2 V2, selected<br>Q3 V3  <br>Q4 V4  <br>In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.  <br>To define shipment reference numbers constraints, enter or select the following fields, which are optional:<br>Reference Number Qualifier ID.<br>Reference Number.",
            "type":"boolean"
        },
        "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 locations.roleProfiles

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles"
    }
}

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 : locations.roleProfiles

Type: object

Show Source

• activityTimeDefs: activityTimeDefs
• calendarGid: string
  The GID for the calendar used for the location role profile.
• calendars: calendars
• createPoolHandlingShipment: boolean
  Creates pool handling shipments.
• createXdockHandlingShipment: boolean
  Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.
  Fixed Handling Time: Same as above.
  The Variable Handling Time and the Variable Handling Weight: Same as above.
  Max Freight Idle Time: Same as above.
• domainName: string
  Database domain where this data is stored.
• fixedHandlingTime: fixedHandlingTime
  Fixed amount of time. No matter the size of the shipment required for handling.
• handlings: handlings
• isAllowMixedFreight: boolean
  Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.
• links: array links
  Read Only: true
• locationRoleGid: string
  The GID for the location role.
• maxFreightIdleTime: maxFreightIdleTime
  Maximum time freight can sit idle at the cross-dock.
• pctActivityAfterLocClose: number (double)
  This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100 100. when null, treat as for location role shipping receiving< div>
• pctActivityBeforeLocOpen: number (double)
  This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 0 100. when it is null, treat as for location role shipping receiving< div>
• thuCapacities: thuCapacities
• thuProfileGid: string
  The GID for the transport profile.
  To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details.
• varHandlingTime: varHandlingTime
  Amount of time required to handle the amount of weight defined by the variable handling weight value.
• varHandlingWeight: varHandlingWeight
  Variable handling time weight defines rate of handling defined by weight.
• varHndcstVol: varHndcstVol
  The planning handling cost volume at this location.
• varHndcstVolCost: varHndcstVolCost
  The variable handling cost per volume at this location.
• varHndcstWgt: varHndcstWgt
  The planning handling cost weight at this location.
• varHndcstWgtCost: varHndcstWgtCost
  Variable Handling Cost Per Weight at this location.
• xDockIsInboundBias: boolean
  The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.

{
    "properties":{
        "locationRoleGid":{
            "description":"The GID for the location role.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar used for the location role profile.",
            "type":"string"
        },
        "xDockIsInboundBias":{
            "description":"The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.",
            "type":"boolean"
        },
        "fixedHandlingTime":{
            "description":"Fixed amount of time. No matter the size of the shipment required for handling.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHandlingTime":{
            "description":"Amount of time required to handle the amount of weight defined by the variable handling weight value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "createXdockHandlingShipment":{
            "description":"Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.<br>Fixed Handling Time: Same as above.<br>The Variable Handling Time and the Variable Handling Weight: Same as above.<br>Max Freight Idle Time: Same as above.",
            "type":"boolean"
        },
        "createPoolHandlingShipment":{
            "description":"Creates pool handling shipments.",
            "type":"boolean"
        },
        "varHandlingWeight":{
            "description":"Variable handling time weight defines rate of handling defined by weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxFreightIdleTime":{
            "description":"Maximum time freight can sit idle at the cross-dock.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "pctActivityBeforeLocOpen":{
            "description":"This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100. When it is null, treat as 0 for location role SHIPPING/RECEIVING",
            "type":"number",
            "format":"double"
        },
        "pctActivityAfterLocClose":{
            "description":"This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100. When null, treat as 100 for location role SHIPPING/RECEIVING",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isAllowMixedFreight":{
            "description":"Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.",
            "type":"boolean"
        },
        "thuProfileGid":{
            "description":"The GID for the transport profile.<br>To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details.",
            "type":"string"
        },
        "varHndcstWgt":{
            "description":"The planning handling cost weight at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHndcstWgtCost":{
            "description":"Variable Handling Cost Per Weight at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "varHndcstVol":{
            "description":"The planning handling cost volume at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHndcstVolCost":{
            "description":"The variable handling cost per volume at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "activityTimeDefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "calendars":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.calendars"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "thuCapacities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "handlings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.handlings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTimeDefs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : calendars

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.calendars"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fixedHandlingTime

Fixed amount of time. No matter the size of the shipment required for handling.

Match All

Fixed amount of time. No matter the size of the shipment required for handling.

Show Source

• object amountType

{
    "description":"Fixed amount of time. No matter the size of the shipment required for handling.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : handlings

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.handlings"
            }
        },
        "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 : maxFreightIdleTime

Maximum time freight can sit idle at the cross-dock.

Match All

Maximum time freight can sit idle at the cross-dock.

Show Source

• object amountType

{
    "description":"Maximum time freight can sit idle at the cross-dock.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : thuCapacities

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : varHandlingTime

Amount of time required to handle the amount of weight defined by the variable handling weight value.

Match All

Amount of time required to handle the amount of weight defined by the variable handling weight value.

Show Source

• object amountType

{
    "description":"Amount of time required to handle the amount of weight defined by the variable handling weight value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHandlingWeight

Variable handling time weight defines rate of handling defined by weight.

Match All

Variable handling time weight defines rate of handling defined by weight.

Show Source

• object amountType

{
    "description":"Variable handling time weight defines rate of handling defined by weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstVol

The planning handling cost volume at this location.

Match All

The planning handling cost volume at this location.

Show Source

• object amountType

{
    "description":"The planning handling cost volume at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstVolCost

The variable handling cost per volume at this location.

Match All

The variable handling cost per volume at this location.

Show Source

• object currencyType

{
    "description":"The variable handling cost per volume at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : varHndcstWgt

The planning handling cost weight at this location.

Match All

The planning handling cost weight at this location.

Show Source

• object amountType

{
    "description":"The planning handling cost weight at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstWgtCost

Variable Handling Cost Per Weight at this location.

Match All

Variable Handling Cost Per Weight at this location.

Show Source

• object currencyType

{
    "description":"Variable Handling Cost Per Weight at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.activityTimeDefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
    }
}

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 : locations.roleProfiles.activityTimeDefs

Type: object

Show Source

• activityTimeDefGid: string
  The GID for the activity time definition for this location and location role combination.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "activityTimeDefGid":{
            "description":"The GID for the activity time definition for this location and location role combination.",
            "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 locations.roleProfiles.calendars

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.calendars"
    }
}

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 : locations.roleProfiles.calendars

Type: object

Show Source

• calendarGid: string
  The GID for the calendar entry associated with each row of the location role profile calendar entry.
• domainName: string
  Database domain where this data is stored.
• flexCommodityProfileGid: string
  The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
• inboundLocationProfileGid: string
  The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
• links: array links
  Read Only: true
• locationRoleProfCalSeq: number (int32)
  The internal sequence number for the location role profile calendar combination.
• modeProfileGid: string
  The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
• outboundLocationProfileGid: string
  The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.

{
    "properties":{
        "locationRoleProfCalSeq":{
            "description":"The internal sequence number for the location role profile calendar combination.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.",
            "type":"string"
        },
        "inboundLocationProfileGid":{
            "description":"The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.",
            "type":"string"
        },
        "outboundLocationProfileGid":{
            "description":"The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar entry associated with each row of the location role profile calendar entry.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.",
            "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 locations.roleProfiles.handlings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.handlings"
    }
}

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 : locations.roleProfiles.handlings

Type: object

Show Source

• destRegionGid: string
  The GID for the destination region. Used to match an order to an entry.
• domainName: string
  Database domain where this data is stored.
• fixedHandlingTime: fixedHandlingTime
  Amount fixed handling time to add. Days, hours, and minutes.
• links: array links
  Read Only: true
• locationRoleProfHandSeq: number (int32)
  Internal key for the 1 to n location role profile handling time entries.
• sourceRegionGid: string
  The GID for the source region. Used to match an order to an entry.

{
    "properties":{
        "locationRoleProfHandSeq":{
            "description":"Internal key for the 1 to n location role profile handling time entries.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sourceRegionGid":{
            "description":"The GID for the source region. Used to match an order to an entry.",
            "type":"string"
        },
        "destRegionGid":{
            "description":"The GID for the destination region. Used to match an order to an entry.",
            "type":"string"
        },
        "fixedHandlingTime":{
            "description":"Amount fixed handling time to add. Days, hours, and minutes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fixedHandlingTime

Amount fixed handling time to add. Days, hours, and minutes.

Match All

Amount fixed handling time to add. Days, hours, and minutes.

Show Source

• object amountType

{
    "description":"Amount fixed handling time to add. Days, hours, and minutes.",
    "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 : items

Type: array

Show Source

• Array of: object locations.roleProfiles.thuCapacities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
    }
}

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 : locations.roleProfiles.thuCapacities

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• isFullyLayered: boolean
  You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.
  Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.
• links: array links
  Read Only: true
• maxHeight: maxHeight
  Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• maxLength: maxLength
  Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• maxVolume: maxVolume
  Value for the maximum volume of the transportation handling unit.
• maxWeight: maxWeight
  Value for the maximum weight of the transportation handling unit.
• maxWidth: maxWidth
  Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• pruCapacities: pruCapacities
• transportHandlingUnitGid: string
  The GID for the transport handling unit.

{
    "properties":{
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "maxLength":{
            "description":"Value for the maximum length of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWidth":{
            "description":"Value for the maximum width of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxHeight":{
            "description":"Value for the maximum height of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeight":{
            "description":"Value for the maximum weight of the  transportation handling unit. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Value for the maximum volume of the  transportation handling unit. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isFullyLayered":{
            "description":"You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.<br>Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.",
            "type":"boolean"
        },
        "pruCapacities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : maxHeight

Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum height of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLength

Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum length of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxVolume

Value for the maximum volume of the transportation handling unit.

Match All

Value for the maximum volume of the transportation handling unit.

Show Source

• object amountType

{
    "description":"Value for the maximum volume of the  transportation handling unit. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Value for the maximum weight of the transportation handling unit.

Match All

Value for the maximum weight of the transportation handling unit.

Show Source

• object amountType

{
    "description":"Value for the maximum weight of the  transportation handling unit. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWidth

Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum width of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruCapacities

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.thuCapacities.pruCapacities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
    }
}

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 : locations.roleProfiles.thuCapacities.pruCapacities

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• limitPruCount: number (double)
  Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the package unit reference unit.
• totalPruCount: number (double)
  Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.

{
    "properties":{
        "packagingReferenceUnitGid":{
            "description":"The GID for the package unit reference unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "totalPruCount":{
            "description":"Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.",
            "type":"number",
            "format":"double"
        },
        "limitPruCount":{
            "description":"Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs"
    }
}

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 : locations.servprovPrefs

Type: object

Show Source

• details: details
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationServprovPrefGid: string
  The unique identifier of location service provider preference.
• locationServprovPrefXid: string
  The XID of location service provider preference.
• maxSlotsPerDay: number (int32)
  The maximum number of slots per day.
• serviceLocation: serviceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• serviceLocationGid: string
  Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The Service Provider GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "locationServprovPrefGid":{
            "description":"The unique identifier of location service provider preference.",
            "type":"string"
        },
        "locationServprovPrefXid":{
            "description":"The XID of location service provider preference.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The Service Provider GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "maxSlotsPerDay":{
            "description":"The maximum number of slots per day.",
            "type":"number",
            "format":"int32"
        },
        "serviceLocationGid":{
            "description":"Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "serviceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs.details"
            }
        },
        "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 : serviceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs.details"
    }
}

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 : locations.servprovPrefs.details

Type: object

Show Source

• begin: number (int32)
  The begin time.
• dayOfWeek: number (int32)
  The day of week.
• domainName: string
  Database domain where this data is stored.
• duration: number (int32)
  The duration of the time window.
• isStanding: boolean
  Indicates if the defined preference is for standing appointment.
• links: array links
  Read Only: true
• locationResourceGid: string
  Indicates the resource that preference defined on.
• locationServprovPrefDSeq: number (int64)
  Sequence with in a particular location service provider preference GID.
• maxSlot: number (int32)
  The maximum number of slots during this time.
• preferenceLevel: number (int32)
  The preference level.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "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 locations.specialServices

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : locations.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceCodeGid: string
  The GID for the special service code for the location.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The GID for the special service code for the location.",
            "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 locations.statuses

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the location status.
• statusValueGid: string
  Status value for the status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the location status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Status value for the 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 locations.substitutes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.substitutes"
    }
}

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 : locations.substitutes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• substituteLocationGid: string
  The GID for the substitute location. Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.

{
    "properties":{
        "substituteLocationGid":{
            "description":"The GID for the substitute location.  Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.",
            "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 equipments.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.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 : equipments.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.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• 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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

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

Nested Schema : equipmentTypes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentDesc: string
  A textual description of the equipment type.
• equipmentDescCode: string
  The equipment description code is a user-defined code for the equipment type description.
• equipmentDescCodeDef: string
  The equipment description code definition is a definition of the equipment type description code.
• equipmentGroups: equipmentGroups
• equipmentTypeGid: string
  The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.
• equipmentTypeName: string
  Text for the name of the equipment type.
• equipmentTypeXid: string
  The XID for the equipment type.
• exteriorHeight: exteriorHeight
  The height of the exterior of the equipment type.
• exteriorLength: exteriorLength
  The length of the exterior of the equipment type.
• exteriorWidth: exteriorWidth
  The width of the exterior of the equipment type.
• grossWeight: grossWeight
  The equipment type's gross weight.
• insertDate: insertDate
  Read Only: true

  insert date
• interiorHeight: interiorHeight
  The height of the equipment type's interior.
• interiorLength: interiorLength
  The length of the equipment type's interior.
• interiorWidth: interiorWidth
  The width of the equipment type's interior.
• isoEquipmentCode: string
  This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.
• isoEquipmentCodeDef: string
  The ISO equipment code definition is an explanation of the ISO equipment code.
• links: array links
  Read Only: true
• metric3: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• metric4: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• netWeight: netWeight
  The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.
• remarks: remarks
• specialServices: specialServices
• substituteEqTypeProfileGid: string
  Indicates which equipment types can be substituted for this type in fleet equipment planning.
• tag1: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag2: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag3: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag4: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tareWeight: tareWeight
  Weight of the empty equipment type.
• temperatureControl: boolean
  Check box used to enable temperature control functionality to be used for this equipment type.
• temperatureControlGid: string
  A GID to define the temperature controls value for the commodity.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  The volume of the equipment type.

{
    "properties":{
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.",
            "type":"string"
        },
        "equipmentTypeXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentTypeName":{
            "description":"Text for the name of the equipment type.",
            "type":"string"
        },
        "equipmentDesc":{
            "description":"A textual description of the equipment type.",
            "type":"string"
        },
        "equipmentDescCode":{
            "description":"The equipment description code is a user-defined code for the equipment type description.",
            "type":"string"
        },
        "equipmentDescCodeDef":{
            "description":"The equipment description code definition is a definition of the equipment type description code.",
            "type":"string"
        },
        "isoEquipmentCode":{
            "description":"This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.",
            "type":"string"
        },
        "isoEquipmentCodeDef":{
            "description":"The ISO equipment code definition is an explanation of the ISO equipment code.",
            "type":"string"
        },
        "grossWeight":{
            "description":"The equipment type's gross weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of the empty equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netWeight":{
            "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "metric3":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "metric4":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "interiorLength":{
            "description":"The length of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorWidth":{
            "description":"The width of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorHeight":{
            "description":"The height of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorLength":{
            "description":"The length of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorWidth":{
            "description":"The width of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorHeight":{
            "description":"The height of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControl":{
            "description":"Check box used to enable temperature control functionality to be used for this equipment type.",
            "type":"boolean"
        },
        "temperatureControlGid":{
            "description":"A GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "tag1":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag2":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag3":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag4":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "substituteEqTypeProfileGid":{
            "description":"Indicates which equipment types can be substituted for this type in fleet equipment planning.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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/equipmentTypes.equipmentGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exteriorHeight

The height of the exterior of the equipment type.

Match All

The height of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The height of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorLength

The length of the exterior of the equipment type.

Match All

The length of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The length of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorWidth

The width of the exterior of the equipment type.

Match All

The width of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The width of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossWeight

The equipment type's gross weight.

Match All

The equipment type's gross weight.

Show Source

• object amountType

{
    "description":"The equipment type's gross weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : interiorHeight

The height of the equipment type's interior.

Match All

The height of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The height of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorLength

The length of the equipment type's interior.

Match All

The length of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The length of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorWidth

The width of the equipment type's interior.

Match All

The width of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The width of the equipment type's interior.",
    "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 : netWeight

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Match All

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Show Source

• object amountType

{
    "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : specialServices

Type: object

Show Source

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

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

Nested Schema : tareWeight

Weight of the empty equipment type.

Match All

Weight of the empty equipment type.

Show Source

• object amountType

{
    "description":"Weight of the empty equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : volume

The volume of the equipment type.

Match All

The volume of the equipment type.

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.equipmentGroups

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The GID for the equipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "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 : schema

Type: object

Show Source

• allowLifoOnly: boolean
  Indicates whether the equipment is for LIFO only.
• 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
• axleLoadingWeights: axleLoadingWeights
• combEquipGrpStructSeq: number (int32)
  If the equipment group is a composite equipment group, it will have this comb_equip_grp_struct_seq populated. It contains the list of equipment groups that belong to a double or triple.
• commodityGid: string
  The commodity that is compatible with the equipment group.
• compartments: compartments
• compartmentTypeGid: string
  A GID to define the compartment type.
• curveGid: string
  Defined the curve function of the curved roof of the equipment group.
• domainName: string
  Database domain where this data is stored.
• doorHeight: doorHeight
  Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.
• effectiveVolume: effectiveVolume
  The capacity for the equipment.
• effectiveWeight: effectiveWeight
  The weight of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from Top of Rail to the Center of Gravity.
• emptyCgLength: emptyCgLength
  When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum permissible weight of the equipment and the load.
• equipmentGroupGid: string
  The GID for the equipment group.
• equipmentGroupName: string
  Describes the group of equipment.
• equipmentGroupXid: string
  The XID for the equipment group.
• equipmentOwnerType: string
  The type of company that owns the stenciled mark on the equipment. For example private or carrier.
• equipmentRefUnits: equipmentRefUnits
• equipmentTypeCode: string
  Alphanumeric code used to designate a specific type of equipment and attributes.
• equipmentTypes: equipmentTypes
• exteriorHeight: exteriorHeight
  Stores the exterior height of the equipment group.
• exteriorLength: exteriorLength
  Stores the exterior length of the equipment group.
• exteriorWidth: exteriorWidth
  Stores the width length of the equipment group.
• feuEquivalentCount: number (double)
  The forty foot unit equivalent count for this equipment group.
• floorHeight: floorHeight
  Actual height of the platform or floor above the ground or the rail.
• hasMeter: boolean
  Indicates if the compartment has METER or not. (The METER is a device that is used the measure how much product is discharged at any given stop).
• height: height
  The height of the equipment group.
• insertDate: insertDate
  Read Only: true

  insert date
• isBulk: boolean
  Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
• isContainer: boolean
  The is container check box to identifies container equipment groups. Equipment groups with this check box marked are considered during the unitization process that can occur when running the Build Buy Shipment on Primary Leg action for an order release.
• length: length
  The length of the equipment group.
• links: array links
  Read Only: true
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• maxHeightPerUnit: maxHeightPerUnit
  Stores the maximum per ship unit height allowed.
• maxLengthPerUnit: maxLengthPerUnit
  Stores the maximum per ship unit length allowed.
• maxLhsWeight: maxLhsWeight
  The max weight allowed on the left hand side of the equipment.
• maxRhsWeight: maxRhsWeight
  The max weight allowed on the right hand side of the equipment.
• maxSideWeightDiff: maxSideWeightDiff
  The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.
• maxWidthPerUnit: maxWidthPerUnit
  Stores the maximum per ship unit width allowed.
• mechanicalDesignation: string
  Alphabetic code assigned to the physical description of the unit.
• obstructions: obstructions
• packagedItems: packagedItems
• pullingLength: pullingLength
  Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.
• shipUnitSpecCompatibilities: shipUnitSpecCompatibilities
• tareWeight: tareWeight
  The tare weight of the equipment group.
• temperatureControlGid: string
  A GID to define the temperature controls value for the commodity.
• teuEquivalentCount: number (double)
  The twenty foot unit equivalent count for this equipment group.
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• truckCenterLength: truckCenterLength
  The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
• truckCount: number (int32)
  The total number of trucks/bogies on the equipment. Applicable only to rail cars.
• truckTypeGid: string
  An GID to define the Truck Type to Categorize the Equipment Group.
• updateDate: updateDate
  Read Only: true

  update date
• vehicleTypeCompatibilities: vehicleTypeCompatibilities
• width: width
  The width of the equipment group.

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group.",
            "type":"string"
        },
        "equipmentGroupXid":{
            "description":"The XID for the equipment group.",
            "type":"string"
        },
        "equipmentGroupName":{
            "description":"Describes the group of equipment.",
            "type":"string"
        },
        "temperatureControlGid":{
            "description":"A GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "effectiveWeight":{
            "description":"The weight of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "effectiveVolume":{
            "description":"The capacity for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "length":{
            "description":"The length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "teuEquivalentCount":{
            "description":"The twenty foot unit equivalent count for this equipment group.",
            "type":"number",
            "format":"double"
        },
        "feuEquivalentCount":{
            "description":"The forty foot unit equivalent count for this equipment group.",
            "type":"number",
            "format":"double"
        },
        "doorHeight":{
            "description":"Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "curveGid":{
            "description":"Defined the curve function of the curved roof of the equipment group.",
            "type":"string"
        },
        "isContainer":{
            "description":"The is container check box to identifies container equipment groups. Equipment groups with this check box marked are considered during the unitization process that can occur when running the Build Buy Shipment on Primary Leg action for an order release.",
            "type":"boolean"
        },
        "maxLhsWeight":{
            "description":"The max weight allowed on the left hand side of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxRhsWeight":{
            "description":"The max weight allowed on the right hand side of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxSideWeightDiff":{
            "description":"The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allowLifoOnly":{
            "description":"Indicates whether the equipment is for LIFO only.",
            "type":"boolean"
        },
        "maxLengthPerUnit":{
            "description":"Stores the maximum per ship unit length allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWidthPerUnit":{
            "description":"Stores the maximum per ship unit width allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxHeightPerUnit":{
            "description":"Stores the maximum per ship unit height allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "exteriorLength":{
            "description":"Stores the exterior length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorWidth":{
            "description":"Stores the width length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorHeight":{
            "description":"Stores the exterior height of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "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"
                }
            ]
        },
        "combEquipGrpStructSeq":{
            "description":"If the equipment group is a composite equipment group, it will have this comb_equip_grp_struct_seq populated. It contains the list of equipment groups that belong to a double or triple.",
            "type":"number",
            "format":"int32"
        },
        "compartmentTypeGid":{
            "description":"A GID to define the compartment type.",
            "type":"string"
        },
        "hasMeter":{
            "description":"Indicates if the compartment has METER or not. (The METER is a device that is used the measure how much product is discharged at any given stop).",
            "type":"boolean"
        },
        "commodityGid":{
            "description":"The commodity that is compatible with the equipment group.",
            "type":"string"
        },
        "isBulk":{
            "description":"Indicates if it is a BULK. If Y then BULK If N then PACKAGED.",
            "type":"boolean"
        },
        "equipmentTypeCode":{
            "description":"Alphanumeric code used to designate a specific type of equipment and attributes.",
            "type":"string"
        },
        "mechanicalDesignation":{
            "description":"Alphabetic code assigned to the physical description of the unit.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The type of company that owns the stenciled mark on the equipment. For example private or carrier.",
            "type":"string"
        },
        "equipMaxGrossWt":{
            "description":"The maximum permissible weight of the equipment and the load.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"Actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckTypeGid":{
            "description":"An GID to define the Truck Type to Categorize the Equipment Group.",
            "type":"string"
        },
        "pullingLength":{
            "description":"Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"The tare weight of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "equipmentTypes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.equipmentTypes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "compartments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.compartments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnitSpecCompatibilities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.shipUnitSpecCompatibilities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "axleLoadingWeights":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.axleLoadingWeights"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "obstructions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.obstructions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vehicleTypeCompatibilities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.vehicleTypeCompatibilities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.equipmentRefUnits"
                    }
                },
                "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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

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

Nested Schema : compartments

Type: object

Show Source

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

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

Nested Schema : doorHeight

Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.

Match All

Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.

Show Source

• object amountType

{
    "description":"Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : effectiveVolume

The capacity for the equipment.

Match All

The capacity for the equipment.

Show Source

• object amountType

{
    "description":"The capacity for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : effectiveWeight

The weight of the equipment.

Match All

The weight of the equipment.

Show Source

• object amountType

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

Nested Schema : emptyCgHeight

When empty, indicates the height from Top of Rail to the Center of Gravity.

Match All

When empty, indicates the height from Top of Rail to the Center of Gravity.

Show Source

• object amountType

{
    "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum permissible weight of the equipment and the load.

Match All

The maximum permissible weight of the equipment and the load.

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the equipment and the load.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

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

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

Nested Schema : equipmentTypes

Type: object

Show Source

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

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

Nested Schema : exteriorHeight

Stores the exterior height of the equipment group.

Match All

Stores the exterior height of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the exterior height of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorLength

Stores the exterior length of the equipment group.

Match All

Stores the exterior length of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the exterior length of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorWidth

Stores the width length of the equipment group.

Match All

Stores the width length of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the width length of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : floorHeight

Actual height of the platform or floor above the ground or the rail.

Match All

Actual height of the platform or floor above the ground or the rail.

Show Source

• object amountType

{
    "description":"Actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment group.

Match All

The height of the equipment group.

Show Source

• object amountType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : length

The length of the equipment group.

Match All

The length of the equipment group.

Show Source

• object amountType

{
    "description":"The length of the equipment group.",
    "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 : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Maximum allowed axle weight. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxHeightPerUnit

Stores the maximum per ship unit height allowed.

Match All

Stores the maximum per ship unit height allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit height allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLengthPerUnit

Stores the maximum per ship unit length allowed.

Match All

Stores the maximum per ship unit length allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit length allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLhsWeight

The max weight allowed on the left hand side of the equipment.

Match All

The max weight allowed on the left hand side of the equipment.

Show Source

• object amountType

{
    "description":"The max weight allowed on the left hand side of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxRhsWeight

The max weight allowed on the right hand side of the equipment.

Match All

The max weight allowed on the right hand side of the equipment.

Show Source

• object amountType

{
    "description":"The max weight allowed on the right hand side of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxSideWeightDiff

The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.

Match All

The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.

Show Source

• object amountType

{
    "description":"The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWidthPerUnit

Stores the maximum per ship unit width allowed.

Match All

Stores the maximum per ship unit width allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit width allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : obstructions

Type: object

Show Source

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

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

Nested Schema : packagedItems

Type: object

Show Source

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

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

Nested Schema : pullingLength

Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Match All

Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Show Source

• object amountType

{
    "description":"Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : shipUnitSpecCompatibilities

Type: object

Show Source

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

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

Nested Schema : tareWeight

The tare weight of the equipment group.

Match All

The tare weight of the equipment group.

Show Source

• object amountType

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

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : vehicleTypeCompatibilities

Type: object

Show Source

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

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

Nested Schema : width

The width of the equipment group.

Match All

The width of the equipment group.

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• axleDistance: axleDistance
  The distance from the nose of the equipment where the max weight can be loaded.
• axleName: string
  User-specified name for the axle where the distance and max weight are defined, such as front axle or rear axle.
• axleSequenceNo: number (int32)
  The axle sequence number.
• domainName: string
  Axle distance in the base unit of measure.
• links: array links
  Read Only: true
• maxWeight: maxWeight
  The max loading weight allowed.

{
    "properties":{
        "axleSequenceNo":{
            "description":"The axle sequence number.",
            "type":"number",
            "format":"int32"
        },
        "axleName":{
            "description":"User-specified name for the axle where the distance and max weight are defined, such as front axle or rear axle.",
            "type":"string"
        },
        "axleDistance":{
            "description":"The distance from the nose of the equipment where the max weight can be loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeight":{
            "description":"The max loading weight allowed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Axle distance in the base unit of measure.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : axleDistance

The distance from the nose of the equipment where the max weight can be loaded.

Match All

The distance from the nose of the equipment where the max weight can be loaded.

Show Source

• object amountType

{
    "description":"The distance from the nose of the equipment where the max weight can be loaded.",
    "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 : maxWeight

The max loading weight allowed.

Match All

The max loading weight allowed.

Show Source

• object amountType

{
    "description":"The max loading weight allowed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• allowCommodityMixing: boolean
  Specifies if different commodity items can be shipped in the same compartment in an equipment group. Valid values are Y for yes and N for no.
• commodityGid: string
  Commodity that is compatible with the compartment.
• compartmentNum: number (int32)
  Identifies the compartment by number.
• compartmentTypeGid: string
  A GID to define the compartment type.
• curveGid: string
  The curve function for the roof of the compartment.
• domainName: string
  Database domain where this data is stored.
• doorHeight: doorHeight
  Defines the height of the door for the compartment.
• hasMeter: boolean
  Indicates if the compartment has METER or not (The METER is a device that is used the measure how much product is discharged at any given stop).
• height: height
  The height of the equipment group compartment.
• isBulk: boolean
  Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
• length: length
  The length of the equipment group compartment.
• lengthFwdOffset: lengthFwdOffset
  Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.
• links: array links
  Read Only: true
• maxMetric3: number (double)
  N/A
• maxMetric4: number (double)
  N/A
• maxVolume: maxVolume
  The maximum capacity for the equipment group compartment.
• maxWeight: maxWeight
  The maximum weight for the equipment group compartment.
• packagedItems: packagedItems
• startHeightPosition: startHeightPosition
  Defines the starting position for the compartment, height wise.
• startLengthPosition: startLengthPosition
  Defines the starting position for the compartment length wise.
• startWidthPosition: startWidthPosition
  Defines the starting position for the compartment, width wise.
• temperatureControlGid: string
  The GID to define the temperature controls value for the commodity.
• width: width
  The width of the equipment group compartment.
• widthOffset: widthOffset
  Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

{
    "properties":{
        "compartmentNum":{
            "description":"Identifies the compartment by number.",
            "type":"number",
            "format":"int32"
        },
        "maxWeight":{
            "description":"The maximum weight for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"The maximum capacity for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxMetric3":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "maxMetric4":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "length":{
            "description":"The length of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControlGid":{
            "description":"The GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "allowCommodityMixing":{
            "description":"Specifies if different commodity items can be shipped in the same compartment in an equipment group. Valid values are Y for yes and N for no.",
            "type":"boolean"
        },
        "doorHeight":{
            "description":"Defines the height of the door for the compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "curveGid":{
            "description":"The curve function for the roof of the compartment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "startLengthPosition":{
            "description":"Defines the starting position for the compartment length wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startWidthPosition":{
            "description":"Defines the starting position for the compartment, width wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startHeightPosition":{
            "description":"Defines the starting position for the compartment, height wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "compartmentTypeGid":{
            "description":"A GID to define the compartment type.",
            "type":"string"
        },
        "hasMeter":{
            "description":"Indicates if the compartment has METER or not (The METER is a device that is used the measure how much product is discharged at any given stop).",
            "type":"boolean"
        },
        "commodityGid":{
            "description":"Commodity that is compatible with the compartment.",
            "type":"string"
        },
        "isBulk":{
            "description":"Indicates if it is a BULK. If Y then BULK If N then PACKAGED.",
            "type":"boolean"
        },
        "widthOffset":{
            "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "lengthFwdOffset":{
            "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : doorHeight

Defines the height of the door for the compartment.

Match All

Defines the height of the door for the compartment.

Show Source

• object amountType

{
    "description":"Defines the height of the door for the compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment group compartment.

Match All

The height of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The height of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment group compartment.

Match All

The length of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The length of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : lengthFwdOffset

Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.

Match All

Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.

Show Source

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
    "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 : maxVolume

The maximum capacity for the equipment group compartment.

Match All

The maximum capacity for the equipment group compartment.

Show Source

• object amountType

{
    "description":"The maximum capacity for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

The maximum weight for the equipment group compartment.

Match All

The maximum weight for the equipment group compartment.

Show Source

• object amountType

{
    "description":"The maximum weight for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packagedItems

Type: object

Show Source

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

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

Nested Schema : startHeightPosition

Defines the starting position for the compartment, height wise.

Match All

Defines the starting position for the compartment, height wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, height wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startLengthPosition

Defines the starting position for the compartment length wise.

Match All

Defines the starting position for the compartment length wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment length wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startWidthPosition

Defines the starting position for the compartment, width wise.

Match All

Defines the starting position for the compartment, width wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, width wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment group compartment.

Match All

The width of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The width of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : widthOffset

Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

Match All

Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

Show Source

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item that is linked to the compartment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "packagedItemGid":{
            "description":"The packaged item that is linked to the compartment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "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 : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItems

Type: object

Show Source

• accessorials: accessorials
• 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
• bbHandlingType: string
  Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.
• bulkMixingFamilyGid: string
  Indicates the bulk mixing family the packaged item belongs to.
• categoryGid: string
  The GID for the packaged item category.
• compartmentTypeProfGid: string
  Compartment type profile attached to the packaged item.
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• description: string
  Packaged item free form text field for the description. For example, a case of soda.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• hazmatPackageTypeGid: string
  The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.
• incrNestingHeight: incrNestingHeight
  Specifies the incremental nesting height for the PI
• innerPackCount: number (double)
  The count for the number of items in the inner pack.
• innerPackPackagingUnitGid: string
  The packaging unit related to the count for the number of items in the inner pack.
• innerPackSize: number (double)
  Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.
• innerPackSizeUomCode: string
  Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.
• insertDate: insertDate
  Read Only: true

  insert date
• isAllowMixedFreight: boolean
  Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.
• isDefaultPackaging: boolean
  Check box indicating if the information entered is the default packaging for this item.
• isHazardous: boolean
  Check box indicating if the information entered is the packaged item is considered hazardous.
• isNestable: boolean
  Specifies if the packaged item is nestable or not
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The GID for the item. Product without the packaging.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• loadConfigRuleRank: number (int32)
  During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.
• packagedItemGid: string
  The GID for the packaged item.
• packagedItemTypeGid: string
  Type of packaged item.
• packagedItemXid: string
  The XID for the packaged item.
• packageRefUnits: packageRefUnits
• packageShipUnitWeight: packageShipUnitWeight
  The weight of the ship unit.
• packageSuDiameter: packageSuDiameter
  Packaged ship unit diameter.
• packageSuHeight: packageSuHeight
  Package ship unit ship unit height.
• packageSuLength: packageSuLength
  Package ship unit ship unit length.
• packageSuVolume: packageSuVolume
  Packaged ship unit volume.
• packageSuWidth: packageSuWidth
  Packaged ship unit width.
• packagingUnitGid: string
  The GID for the packaging unit.
• parcelPacktype: string
  Parcel package type.
• priority: number (int32)
  This column defines the priority associated with an packaged item.
• pruUsages: pruUsages
• refnums: refnums
• thuProfileGid: string
  Defines all valid THUs the PI can be packed into.
• tiHis: tiHis
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "packagedItemGid":{
            "description":"The GID for the packaged item.",
            "type":"string"
        },
        "packagedItemXid":{
            "description":"The XID for the packaged item.",
            "type":"string"
        },
        "description":{
            "description":"Packaged item free form text field for the description. For example, a case of soda.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item. Product without the packaging. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "hazmatPackageTypeGid":{
            "description":"The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit. ",
            "type":"string"
        },
        "packageShipUnitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "innerPackCount":{
            "description":"The count for the number of items in the inner pack.",
            "type":"number",
            "format":"double"
        },
        "innerPackPackagingUnitGid":{
            "description":"The packaging unit related to the count for the number of items in the inner pack.",
            "type":"string"
        },
        "innerPackSize":{
            "description":"Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.",
            "type":"number",
            "format":"double"
        },
        "innerPackSizeUomCode":{
            "description":"Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.",
            "type":"string"
        },
        "packageSuVolume":{
            "description":"Packaged ship unit volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuLength":{
            "description":"Package ship unit ship unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuWidth":{
            "description":"Packaged ship unit width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuHeight":{
            "description":"Package ship unit ship unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isDefaultPackaging":{
            "description":"Check box indicating if the information entered is the default packaging for this item. ",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"Check box indicating if the information entered is the packaged item is considered hazardous.",
            "type":"boolean"
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuDiameter":{
            "description":"Packaged ship unit diameter.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bbHandlingType":{
            "description":"Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemTypeGid":{
            "description":"Type of packaged item.",
            "type":"string"
        },
        "loadConfigRuleRank":{
            "description":"During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.",
            "type":"number",
            "format":"int32"
        },
        "thuProfileGid":{
            "description":"Defines all valid THUs the PI can be packed into.",
            "type":"string"
        },
        "parcelPacktype":{
            "description":"Parcel package type.",
            "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"
                }
            ]
        },
        "isAllowMixedFreight":{
            "description":"Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.",
            "type":"boolean"
        },
        "bulkMixingFamilyGid":{
            "description":"Indicates the bulk mixing family the packaged item belongs to.",
            "type":"string"
        },
        "compartmentTypeProfGid":{
            "description":"Compartment type profile attached to the packaged item.",
            "type":"string"
        },
        "categoryGid":{
            "description":"The GID for the packaged item category.",
            "type":"string"
        },
        "priority":{
            "description":"This column defines the priority associated with an packaged item.",
            "type":"number",
            "format":"int32"
        },
        "isNestable":{
            "description":"Specifies if the packaged item is nestable or not",
            "type":"boolean"
        },
        "incrNestingHeight":{
            "description":"Specifies the incremental nesting height for the PI",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "pruUsages":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.pruUsages"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tiHis":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.tiHis"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.packageRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Match All

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

Show Source

• object amountType

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

Nested Schema : equipmentRefUnits

Type: object

Show Source

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

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

Nested Schema : incrNestingHeight

Specifies the incremental nesting height for the PI

Match All

Specifies the incremental nesting height for the PI

Show Source

• object amountType

{
    "description":"Specifies the incremental nesting height for the PI",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object itemsWithProdClassCodeGid

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "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 : packageRefUnits

Type: object

Show Source

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

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

Nested Schema : packageShipUnitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

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

Nested Schema : packageSuDiameter

Packaged ship unit diameter.

Match All

Packaged ship unit diameter.

Show Source

• object amountType

{
    "description":"Packaged ship unit diameter.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuHeight

Package ship unit ship unit height.

Match All

Package ship unit ship unit height.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuLength

Package ship unit ship unit length.

Match All

Package ship unit ship unit length.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuVolume

Packaged ship unit volume.

Match All

Packaged ship unit volume.

Show Source

• object amountType

{
    "description":"Packaged ship unit volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuWidth

Packaged ship unit width.

Match All

Packaged ship unit width.

Show Source

• object amountType

{
    "description":"Packaged ship unit width.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruUsages

Type: object

Show Source

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

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

Nested Schema : tiHis

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.accessorials

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : packagedItems.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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/packagedItems.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.accessorials.remarks

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

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The remark sequence associated with the packaged item
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence associated with the packaged item",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.equipmentRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.equipmentRefUnits"
    }
}

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 : packagedItems.equipmentRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  ERU for the packaged item
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of reference units per package for ERU.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"ERU for the packaged item",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of reference units per package for ERU.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : itemsWithProdClassCodeGid

Type: object

Show Source

• accessorials: accessorials
• 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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as 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
• boms: boms
• brandName: string
  The brand name is an informational text field and allows you to enter the brand name for an item.
• classifications: classifications
• commodityGid: string
  The GID for the commodity.
• countryOfOriginGid: string
  Specifies the country of origin for the item
• countryOfOrigins: countryOfOrigins
• description: string
  A description of the item being shipped.
• descriptions: descriptions
• documents: documents
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date is used to set the start time window for when an item should be used on an order.
• expirationDate: expirationDate
  The expiration date is used to set the end time window for when an item should be used on an order.
• features: features
• htsGid: string
  The GID for the Harmonized Tariff System (HTS).
• iataScrCodeGid: string
  Legacy field that was used to capture the IATA source code. This fields is no longer used for visible on the UI.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• insertDate: insertDate
  Read Only: true

  insert date
• isDrawback: boolean
  Legacy field used to identify items that were to be tracked for duty drawback opportunities. This field is no longer used or visible on the UI.
• isTemplate: boolean
  Check box indicating whether or not this item record will be used as an item template or not.
• itemGid: string
  The GID for the item.
• itemName: string
  Text for the name of the item.
• itemOrigins: itemOrigins
• itemTemplateGid: string
  Item template gid indicates the last item template applied on item
• itemTypeGid: string
  Specifies the item type for the item
• itemValueSets: itemValueSets
• itemXid: string
  The XID for the item.
• links: array links
  Read Only: true
• manufacturedCountryCodeGid: string
  Legacy field used to identify an items manufactured country code. GTM now supports the concept of manufactured country code in a more robust fashion. This field is no longer used or visible on the UI.
• nmfcArticleGid: string
  The GID for the National Motor Freight Classification (NMFC) article/item number. The NMFC article refers to the NMFC's standard grouping of items, for example the article Brick(s): Thermal energy storage, ceramic is identified with the item number of 32270. The intended use for this table is to assign the item number related to the NMFC article as the ID for the NMFC Article XID. Note that within the system the NMFC article and the relationship between the article and the NMFC freight class are for information only.
• 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.
• packagedItems: packagedItems
• partnerItems: partnerItems
• partnerSites: partnerSites
• pricePerUnit: pricePerUnit
  The price per unit based on the unit of measure selected.
• priority: number (int32)
  The priority associated with an item.
• prodClassTemplateGid: string
  Product Class template gid indicates the last classification template applied on the item
• refnums: refnums
• relationships: relationships
• remarks: remarks
• reqdocDocReviews: reqdocDocReviews
• reqdocDocs: reqdocDocs
• reqdocReviewers: reqdocReviewers
• reqdocs: reqdocs
• reqdocStatuses: reqdocStatuses
• reqdocSubscribers: reqdocSubscribers
• reqdocTexts: reqdocTexts
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC).
• specialServices: specialServices
• statuses: statuses
• stccGid: string
  The GID for the Standard Commodity Code (STCC).
• texts: texts
• udcClassificationListGid: string
  List of User Defined commodities for item.
• unitOfMeasure: string
  The price per unit of measure.
• uomConversions: uomConversions
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefinedCommodityGid: string
  The GID for the user-defined commodity.
• whollyOriginating: string
  Indicates if the item is wholly originating.

{
    "properties":{
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "itemXid":{
            "description":"The XID for the item.",
            "type":"string"
        },
        "itemName":{
            "description":"Text for the name of the item.",
            "type":"string"
        },
        "commodityGid":{
            "description":"The GID for the commodity.",
            "type":"string"
        },
        "nmfcArticleGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC) article/item number. The NMFC article refers to the NMFC's standard grouping of items, for example the article Brick(s): Thermal energy storage, ceramic is identified with the item number of 32270. The intended use for this table is to assign the item number related to the NMFC article as the ID for the NMFC Article XID. Note that within the system the NMFC article and the relationship between the article and the NMFC freight class are for information only.",
            "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 Commodity Code (STCC).",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC).",
            "type":"string"
        },
        "description":{
            "description":"A description of the item being shipped.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user-defined commodity.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"List of User Defined commodities for item.",
            "type":"string"
        },
        "brandName":{
            "description":"The brand name is an informational text field and allows you to enter the brand name for an item.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date is used to set the start time window for when an item should be used on an order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date is used to set the end time window for when an item should be used on an order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "manufacturedCountryCodeGid":{
            "description":"Legacy field used to identify an items manufactured country code. GTM now supports the concept of manufactured country code in a more robust fashion. This field is no longer used or visible on the UI.",
            "type":"string"
        },
        "isDrawback":{
            "description":"Legacy field used to identify items that were to be tracked for duty drawback opportunities. This field is no longer used or visible on the UI.",
            "type":"boolean"
        },
        "iataScrCodeGid":{
            "description":"Legacy field that was used to capture the IATA source code. This fields is no longer used for visible on the UI.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "unitOfMeasure":{
            "description":"The price per unit of measure.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"The price per unit based on the unit of measure selected.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isTemplate":{
            "description":"Check box indicating whether or not this item record will be used as an item template or not.",
            "type":"boolean"
        },
        "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"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object. ",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "priority":{
            "description":"The priority associated with an item.",
            "type":"number",
            "format":"int32"
        },
        "itemTypeGid":{
            "description":"Specifies the item type for the item",
            "type":"string"
        },
        "countryOfOriginGid":{
            "description":"Specifies the country of origin for the item",
            "type":"string"
        },
        "itemTemplateGid":{
            "description":"Item template gid indicates the last item template applied on item",
            "type":"string"
        },
        "prodClassTemplateGid":{
            "description":"Product Class template gid indicates the last classification template applied on the item",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "whollyOriginating":{
            "description":"Indicates if the item is wholly originating.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocReviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocReviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocSubscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocSubscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocDocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocTexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocTexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocDocReviews":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocReviews"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "relationships":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.relationships"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "boms":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.boms"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "features":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.features"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "descriptions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.descriptions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "uomConversions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.uomConversions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "classifications":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "countryOfOrigins":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.countryOfOrigins"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "itemOrigins":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partnerItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partnerSites":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerSites"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "itemValueSets":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

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

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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

• object dateTimeType

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

• object dateTimeType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

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

Nested Schema : classifications

Type: object

Show Source

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

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

Nested Schema : countryOfOrigins

Type: object

Show Source

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

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

Nested Schema : descriptions

Type: object

Show Source

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

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

Nested Schema : documents

Type: object

Show Source

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

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

Nested Schema : effectiveDate

The effective date is used to set the start time window for when an item should be used on an order.

Match All

The effective date is used to set the start time window for when an item should be used on an order.

Show Source

• object dateType

{
    "description":"The effective date is used to set the start time window for when an item should be used on an order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date is used to set the end time window for when an item should be used on an order.

Match All

The expiration date is used to set the end time window for when an item should be used on an order.

Show Source

• object dateType

{
    "description":"The expiration date is used to set the end time window for when an item should be used on an order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : features

Type: object

Show Source

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

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : itemOrigins

Type: object

Show Source

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

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

Nested Schema : itemValueSets

Type: object

Show Source

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

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

Type: object

Show Source

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

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

Nested Schema : partnerItems

Type: object

Show Source

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

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

Nested Schema : partnerSites

Type: object

Show Source

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

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

Nested Schema : pricePerUnit

The price per unit based on the unit of measure selected.

Match All

The price per unit based on the unit of measure selected.

Show Source

• object currencyType

{
    "description":"The price per unit based on the unit of measure selected.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : relationships

Type: object

Show Source

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

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

Nested Schema : reqdocDocReviews

Type: object

Show Source

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

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

Nested Schema : reqdocDocs

Type: object

Show Source

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

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

Nested Schema : reqdocReviewers

Type: object

Show Source

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

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

Nested Schema : reqdocs

Type: object

Show Source

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

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

Nested Schema : reqdocStatuses

Type: object

Show Source

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

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

Nested Schema : reqdocSubscribers

Type: object

Show Source

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

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

Nested Schema : reqdocTexts

Type: object

Show Source

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

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

Nested Schema : specialServices

Type: object

Show Source

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

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

Nested Schema : uomConversions

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.accessorials

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : itemsWithProdClassCodeGid.accessorials

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.boms

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.boms"
    }
}

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 : itemsWithProdClassCodeGid.boms

Type: object

Show Source

• childItemCount: number (int32)
  The number of child items in the parent item's BOM.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• parentItem: parentItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentItemGid: string
  The GID for the item that is having the item BOM added, updated, or removed.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "parentItemGid":{
            "description":"The GID for the item that is having the item BOM added, updated, or removed. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "childItemCount":{
            "description":"The number of child items in the parent item's BOM.",
            "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 : parentItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object itemsWithProdClassCodeGid

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.classifications

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications"
    }
}

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 : itemsWithProdClassCodeGid.classifications

Type: object

Show Source

• approverNotes: string
  Approver notes is a notes field is to capture any comments the classification approver may have related to their approval of this classification type and code to this particular item.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• bindingRulingEffectiveDate: bindingRulingEffectiveDate
  Effective date of the binding ruling
• bindingRulingExpirationDate: bindingRulingExpirationDate
  Indicates the binding rule expiration date.
• bindingRulingNumber: string
  Binding ruling number to justify classification
• classificationCode: string
  Classification code for an item.
• classificationDate: classificationDate
  Date when classification is done
• classificationNotes: string
  Classification notes is a notes field available to enter any hints or insights into the item classification reasoning.
• classificationStatus: string
  Classification status is a read only field that reflects the status of the product classification. For example, Classification Created, Classification Approved.
• classificationUser: string
  User who does classification
• codeAttributes: codeAttributes
• customsDescription: string
  Customs description is a description field available to enter any hints or insights into the item customs reasoning.
• domainName: string
  Database domain where this data is stored.
• eligibilityScreeningDate: eligibilityScreeningDate
  Date when eligibility screening is done
• eligibilityScreeningUser: string
  User who does eligibility screening
• gtmItemClassificationGid: string
  A GID field available to enter any hints or insights into the item gtm_item_classification reasoning.
• gtmItemClassificationXid: string
  An XID field available to enter any hints or insights into the item gtm_item_classification reasoning.
• gtmProdClassCodeGid: string
  The GID for the product classification code that is being added, updated, or removed for the item. The product classification code is qualified/filtered by the product classification type.
• gtmProdClassPurposeGid: string
  Product Classification Purpose
• gtmProdClassTypeGid: string
  The GID for the product classification type that is being added, updated, or removed. The product classification type qualifies/filters the values of the product classification code being added. For example the product classification type of HTS US is related to the product classification codes for the Harmonized Tariff Schedule of the United States. GTM will check to see if the product classification code is valid and matches the selected classification type.
• gtmTariffRoiGid: string
  Unique identifier for the gtm tariff rules of interpretation used to justify classification
• links: array links
  Read Only: true
• refnums: refnums
• remarks: remarks
• reviewDate: reviewDate
  Date when review is done
• reviewUser: string
  User who reviews classification

{
    "properties":{
        "gtmItemClassificationGid":{
            "description":"A GID field available to enter any hints or insights into the item gtm_item_classification reasoning.",
            "type":"string"
        },
        "gtmProdClassTypeGid":{
            "description":"The GID for the product classification type that is being added, updated, or removed. The product classification type qualifies/filters the values of the product classification code being added. For example the product classification type of HTS US is related to the product classification codes for the Harmonized Tariff Schedule of the United States. GTM will check to see if the product classification code is valid and matches the selected classification type.",
            "type":"string"
        },
        "gtmProdClassCodeGid":{
            "description":"The GID for the product classification code that is being added, updated, or removed for the item. The product classification code is qualified/filtered by the product classification type.",
            "type":"string"
        },
        "classificationStatus":{
            "description":"Classification status is a read only field that reflects the status of the product classification. For example, Classification Created, Classification Approved.",
            "type":"string"
        },
        "classificationNotes":{
            "description":"Classification notes is a notes field available to enter any hints or insights into the item classification reasoning.",
            "type":"string"
        },
        "approverNotes":{
            "description":"Approver notes is a notes field is to capture any comments the classification approver may have related to their approval of this classification type and code to this particular item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmItemClassificationXid":{
            "description":"An XID field available to enter any hints or insights into the item gtm_item_classification reasoning.",
            "type":"string"
        },
        "customsDescription":{
            "description":"Customs description is a description field available to enter any hints or insights into the item customs reasoning.",
            "type":"string"
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bindingRulingNumber":{
            "description":"Binding ruling number to justify classification",
            "type":"string"
        },
        "bindingRulingEffectiveDate":{
            "description":"Effective date of the binding ruling",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "classificationUser":{
            "description":"User who does classification",
            "type":"string"
        },
        "classificationDate":{
            "description":"Date when classification is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reviewUser":{
            "description":"User who reviews classification",
            "type":"string"
        },
        "reviewDate":{
            "description":"Date when review is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eligibilityScreeningUser":{
            "description":"User who does eligibility screening",
            "type":"string"
        },
        "eligibilityScreeningDate":{
            "description":"Date when eligibility screening is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "gtmTariffRoiGid":{
            "description":"Unique identifier for the gtm tariff rules of interpretation used to justify classification",
            "type":"string"
        },
        "bindingRulingExpirationDate":{
            "description":"Indicates the binding rule expiration date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "gtmProdClassPurposeGid":{
            "description":"Product Classification Purpose",
            "type":"string"
        },
        "classificationCode":{
            "description":"Classification code for an item.",
            "type":"string"
        },
        "codeAttributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : bindingRulingEffectiveDate

Effective date of the binding ruling

Match All

Effective date of the binding ruling

Show Source

• object dateType

{
    "description":"Effective date of the binding ruling",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : bindingRulingExpirationDate

Indicates the binding rule expiration date.

Match All

Indicates the binding rule expiration date.

Show Source

• object dateType

{
    "description":"Indicates the binding rule expiration date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : classificationDate

Date when classification is done

Match All

Date when classification is done

Show Source

• object dateTimeType

{
    "description":"Date when classification is done",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : codeAttributes

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eligibilityScreeningDate

Date when eligibility screening is done

Match All

Date when eligibility screening is done

Show Source

• object dateTimeType

{
    "description":"Date when eligibility screening is done",
    "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/itemsWithProdClassCodeGid.classifications.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/itemsWithProdClassCodeGid.classifications.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reviewDate

Date when review is done

Match All

Date when review is done

Show Source

• object dateTimeType

{
    "description":"Date when review is done",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.classifications.codeAttributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
    }
}

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 : itemsWithProdClassCodeGid.classifications.codeAttributes

Type: object

Show Source

• attributeDescription: string
  The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.
• attributeName: string
  The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.
• attributeSequence: number (int64)
  The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.
• attributeValue: string
  The attribute value - qualified by the attribute name - of the GTM product classification code attribute that is being added, updated, or deleted.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "attributeSequence":{
            "description":"The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"number",
            "format":"int64"
        },
        "attributeName":{
            "description":"The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "attributeValue":{
            "description":"The attribute value - qualified by the attribute name -  of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attributeDescription":{
            "description":"The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.",
            "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 itemsWithProdClassCodeGid.classifications.refnums

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

Type: object

Show Source

• domainName: string
  No description.
• gtmItemClassRefnumQualGid: string
  The GID for the item classification reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "gtmItemClassRefnumQualGid":{
            "description":"The GID for the item classification reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of the reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.classifications.remarks

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

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int64)
  The sequence number for the item classification remark.
• remarkText: string
  The text of the remark about the item classification.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item classification remark.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark about the item classification.",
            "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 itemsWithProdClassCodeGid.countryOfOrigins

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.countryOfOrigins"
    }
}

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 : itemsWithProdClassCodeGid.countryOfOrigins

Type: object

Show Source

• countryOfOriginGid: string
  Country code of the country of origin related to this supplier's source for this item. May be the two or three digit ISO country code depending on which option has been selected.
• domainName: string
  Database domain where this data is stored.
• isDefault: boolean
  Check box indicating - in the case of multiple country of origin entries for a supplier - which record is the default/assumed country of origin.
• links: array links
  Read Only: true
• manufacturingCountryGid: string
  Country code for the country of manufacturing related to this supplier's manufacturing of this item. May be the two or three digit ISO country code depending on which option has been selected.
• manufacturingDesc: string
  Supplier's description for this item.
• manufacturingPartNo: string
  Supplier's part number for this item.
• supplierSite: supplierSite
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• supplierSiteGid: string
  The GID for the supplier's party identification for where this item is sourced for this supplier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "supplierSiteGid":{
            "description":"The GID for the supplier's party identification for where this item is sourced for this supplier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "supplierSite":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "countryOfOriginGid":{
            "description":"Country code of the country of origin related to this supplier's source for this item. May be the two or three digit ISO country code depending on which option has been selected.",
            "type":"string"
        },
        "manufacturingCountryGid":{
            "description":"Country code for the country of manufacturing related to this supplier's manufacturing of this item. May be the two or three digit ISO country code depending on which option has been selected.",
            "type":"string"
        },
        "isDefault":{
            "description":"Check box indicating - in the case of multiple country of origin entries for a supplier - which record is the default/assumed country of origin.",
            "type":"boolean"
        },
        "manufacturingPartNo":{
            "description":"Supplier's part number for this item.",
            "type":"string"
        },
        "manufacturingDesc":{
            "description":"Supplier's description for this item.",
            "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 : supplierSite

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.descriptions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.descriptions"
    }
}

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 : itemsWithProdClassCodeGid.descriptions

Type: object

Show Source

• description: string
  Description text.
• domainName: string
  Database domain where this data is stored.
• gtmLanguageGid: string
  The GID for the country that is being used to qualify the language associated with the description.
• links: array links
  Read Only: true
• seqNo: number (double)
  Internal sequence number for the description.

{
    "properties":{
        "seqNo":{
            "description":"Internal sequence number for the description.",
            "type":"number",
            "format":"double"
        },
        "description":{
            "description":"Description text.",
            "type":"string"
        },
        "gtmLanguageGid":{
            "description":"The GID for the country that is being used to qualify the language associated with the description. ",
            "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 itemsWithProdClassCodeGid.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.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 : itemsWithProdClassCodeGid.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.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• 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. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "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

represents effective date for a document

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

Represents expiration date for a document.

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

If preparation, date/time content was last generated

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

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 itemsWithProdClassCodeGid.features

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.features"
    }
}

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 : itemsWithProdClassCodeGid.features

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for this feature.
• expirationDate: expirationDate
  The expiration date for the feature.
• itemFeatureQualGid: string
  The GID for the item feature qualifier/attribute that is used to identify the feature. For example, color.
• itemFeatureValue: string
  The value qualified by the feature qualifier. For example, item feature qualifier = color, then item feature value = red.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The GID for the item feature qualifier/attribute  that is used to identify the feature.  For example, color.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The value qualified by the feature qualifier. For example, item feature qualifier = color, then item feature value = red.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this feature.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the feature.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this feature.

Match All

The effective date for this feature.

Show Source

• object dateType

{
    "description":"The effective date for this feature.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the feature.

Match All

The expiration date for the feature.

Show Source

• object dateType

{
    "description":"The expiration date for the feature.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 itemsWithProdClassCodeGid.itemOrigins

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins

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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• countryOfManufacture: string
  The country of manufacture for the item origin.
• countryOfOrigin: string
  The country of origin for the item origin.
• description: string
  Identifies the description of item by partner/partner site, inventory organization, and bill of material.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for the item origin.
• expirationDate: expirationDate
  The expiration date for the item origin.
• gtmStructureGid: string
  Identifies the Bill of Material of item for which country of origin is captured.
• inventoryOrganization: inventoryOrganization
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• inventoryOrganizationGid: string
  The GID for the inventory organization/contact associated with the item origin.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• itemOriginGid: string
  The GID for the item origin.
• itemOriginXid: string
  The XID for the item origin.
• links: array links
  Read Only: true
• partner: partner
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• partnerGid: string
  The GID for the partner/party associated with the item origin.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partnerSiteGid: string
  The GID for the party site associated with the item origin.
• percentageSourced: number (double)
  The percentage sourced from the supplier.
• qualifications: qualifications
• values: values
• whollyOriginating: string
  Indicates if the item is wholly originating.

{
    "properties":{
        "itemOriginGid":{
            "description":"The GID for the item origin.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "itemOriginXid":{
            "description":"The XID for the item origin.",
            "type":"string"
        },
        "inventoryOrganizationGid":{
            "description":"The GID for the inventory organization/contact associated with the item origin. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "inventoryOrganization":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerGid":{
            "description":"The GID for the partner/party associated with the item origin. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "partner":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerSiteGid":{
            "description":"The GID for the party site associated with the item origin.",
            "type":"string"
        },
        "countryOfOrigin":{
            "description":"The country of origin for the item origin.",
            "type":"string"
        },
        "countryOfManufacture":{
            "description":"The country of manufacture for the item origin.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "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"
                }
            ]
        },
        "description":{
            "description":"Identifies the description of item by partner/partner site, inventory organization, and bill of material.",
            "type":"string"
        },
        "gtmStructureGid":{
            "description":"Identifies the Bill of Material of item for which country of origin is captured.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "whollyOriginating":{
            "description":"Indicates if the item is wholly originating.",
            "type":"string"
        },
        "percentageSourced":{
            "description":"The percentage sourced from the supplier.",
            "type":"number",
            "format":"double"
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "qualifications":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
                    }
                },
                "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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The effective date for the item origin.

Match All

The effective date for the item origin.

Show Source

• object dateType

{
    "description":"The effective date for the item origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the item origin.

Match All

The expiration date for the item origin.

Show Source

• object dateType

{
    "description":"The expiration date for the item origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : inventoryOrganization

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 : partner

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : qualifications

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : values

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications

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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• classificationCode: string
  The product classification code associated with the product classification type of the item qualification.
• conditions: conditions
• countryOfImport: string
  This describes the country of import for the item
• description: string
  Describes the item qualification.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for the item qualification.
• expirationDate: expirationDate
  The expiration date for the item qualification.
• gtmProdClassTypeGid: string
  The GID for the product classification type of the importing country.
• gtmReasonCodeGid: string
  Reason Code Id when status is evaluated to REQUIRES REVIEW
• gtmStructureGid: string
  Identifies the Bill of Material of item for which qualification is captured.
• gtmTariffCode: string
  Specifies the tariff code for a particular item qualification.
• gtmTradeAgreementGid: string
  The GID for the trade agreement associated with the item qualification.
• isQualified: string
  Indicates if an item qualified for a trade agreement. Can have "Y","N" and "NS" and default value is "NS"
• itemQfGid: string
  The GID for the item qualification.
• itemQfXid: string
  The XID for the item qualification.
• links: array links
  Read Only: true
• minOpsMeet: string
  This flag indicates if minimum operations are met under Rules of Origin.
• producer: string
  Indicates if the supplier/partner is the producer of the goods.
• qfPreferenceCriteriaGid: string
  The GID for the preference criteria associated with an item qualification.
• qfRvcMethodGid: string
  The GID for the regional value content method associated with an item qualification.
• refnums: refnums
• remarks: remarks
• reqdocs: reqdocs
• rooAttribute: string
  Indicates the attribute description under the product specific rule(suffix/ex) after the Rules of Origin Qualification
• rvcPercentage: number (double)
  The percentage of the regional value content method associated with an item qualification.
• status: string
  Indicates the status of an item qualification.
• values: values
• whollyOriginated: string
  Indicates if the Item is wholly originating under the trade agreement

{
    "properties":{
        "itemQfGid":{
            "description":"The GID for the item qualification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "itemQfXid":{
            "description":"The XID for the item qualification.",
            "type":"string"
        },
        "description":{
            "description":"Describes the item qualification.",
            "type":"string"
        },
        "gtmTradeAgreementGid":{
            "description":"The GID for the trade agreement associated with the item qualification.",
            "type":"string"
        },
        "gtmProdClassTypeGid":{
            "description":"The GID for the product classification type of the importing country. ",
            "type":"string"
        },
        "classificationCode":{
            "description":"The product classification code associated with the product classification type of the item qualification.",
            "type":"string"
        },
        "isQualified":{
            "description":"Indicates if an item qualified for a trade agreement. Can have \"Y\",\"N\" and \"NS\" and default value is \"NS\"",
            "type":"string"
        },
        "qfPreferenceCriteriaGid":{
            "description":"The GID for the preference criteria associated with an item qualification. ",
            "type":"string"
        },
        "qfRvcMethodGid":{
            "description":"The GID for the regional value content method associated with an item qualification. ",
            "type":"string"
        },
        "producer":{
            "description":"Indicates if the supplier/partner is the producer of the goods.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "status":{
            "description":"Indicates the status of an item qualification. ",
            "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"
                }
            ]
        },
        "gtmTariffCode":{
            "description":"Specifies the tariff code for a particular item qualification.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "rvcPercentage":{
            "description":"The percentage of the regional value content method associated with an item qualification. ",
            "type":"number",
            "format":"double"
        },
        "minOpsMeet":{
            "description":"This flag indicates if minimum operations are met under Rules of Origin.",
            "type":"string"
        },
        "rooAttribute":{
            "description":"Indicates the attribute description under the product specific rule(suffix/ex) after the Rules of Origin Qualification",
            "type":"string"
        },
        "whollyOriginated":{
            "description":"Indicates if the Item is wholly originating under the trade agreement",
            "type":"string"
        },
        "countryOfImport":{
            "description":"This describes the country of import for the item",
            "type":"string"
        },
        "gtmReasonCodeGid":{
            "description":"Reason Code Id when status is evaluated to REQUIRES REVIEW",
            "type":"string"
        },
        "gtmStructureGid":{
            "description":"Identifies the Bill of Material of item for which qualification is captured.",
            "type":"string"
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "conditions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
                    }
                },
                "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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for the item qualification.

Match All

The effective date for the item qualification.

Show Source

• object dateType

{
    "description":"The effective date for the item qualification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the item qualification.

Match All

The expiration date for the item qualification.

Show Source

• object dateType

{
    "description":"The expiration date for the item qualification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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

Nested Schema : reqdocs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : values

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions

Type: object

Show Source

• conditionDescription: string
  Description field.
• conditionShortName: string
  The short name given to rules of origin rule code.
• domainName: string
  No description.
• isApplied: boolean
  Indicates if the condition applied
• links: array links
  Read Only: true
• seqNumber: number (int64)
  Sequence number of the item qf condition.

{
    "properties":{
        "seqNumber":{
            "description":"Sequence number of the item qf condition.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "conditionShortName":{
            "description":"The short name given to rules of origin rule code.",
            "type":"string"
        },
        "conditionDescription":{
            "description":"Description field.",
            "type":"string"
        },
        "isApplied":{
            "description":"Indicates if the condition applied ",
            "type":"boolean"
        },
        "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 itemsWithProdClassCodeGid.itemOrigins.qualifications.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemQfRefnumQualGid: string
  The GID for the item qualification reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "itemQfRefnumQualGid":{
            "description":"The GID for the item qualification reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of the reference number.",
            "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 itemsWithProdClassCodeGid.itemOrigins.qualifications.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.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 item qualification remark.
• remarkSequence: number (int64)
  The sequence number for the item qualification remark.
• remarkText: string
  The remark text for the item qualification.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item qualification remark. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the item qualification remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text for the item qualification.",
            "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 itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs

Type: object

Show Source

• docs: docs
• documentDefGid: string
  The GID for the required document type.
• domainName: string
  Database domain where this data is stored.
• instructions: string
  Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.
• links: array links
  Read Only: true
• numRevisions: number (int32)
  The number of document revisions generated.
• reviewers: reviewers
• reviewStatus: string
  The review status of the required document.
• statuses: statuses

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the required document type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"The number of document revisions generated.",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "instructions":{
            "description":"Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.",
            "type":"string"
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : docs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
            }
        },
        "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 : reviewers

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
            }
        },
        "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/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs

Type: object

Show Source

• annotations: string
  Annotations for a document revision.
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentRevision: number (int32)
  The revision count for the document.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  The review status of the required document.
• reviewers: reviewers

{
    "properties":{
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"The revision count for the document.",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "annotations":{
            "description":"Annotations for a document revision.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "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 : reviewers

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers

Type: object

Show Source

• comments: string
  Comments from the reviewer for the specific document.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document reviewer.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  The review status of the document.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"The review status of the document.",
            "type":"string"
        },
        "comments":{
            "description":"Comments from the reviewer for the specific document.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers

Type: object

Show Source

• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document reviewer.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type associated with a required document.
• statusValueGid: string
  The status value associated with a required document.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type associated with a required document.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value associated with a required 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
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.values

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.qualifications.values

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the item qualification.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the item qualification.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the item qualification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the item qualification.

Match All

The currency value of the item qualification.

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

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

Match All

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

Show Source

• object dateType

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

Nested Schema : 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 itemsWithProdClassCodeGid.itemOrigins.values

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
    }
}

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 : itemsWithProdClassCodeGid.itemOrigins.values

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the item origin.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the item origin.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the item origin.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the item origin.

Match All

The currency value of the item origin.

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

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

Match All

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

Show Source

• object dateType

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

Nested Schema : 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 itemsWithProdClassCodeGid.itemValueSets

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets"
    }
}

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 : itemsWithProdClassCodeGid.itemValueSets

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• countryOfOriginGid: string
  Identifies the origin of the goods corresponding on the item value set.
• domainName: string
  Database domain where this data is stored.
• identifier1: string
  Indicates the identifier corresponding on the item value set.
• identifier2: string
  Indicates the identifier corresponding on the item value set.
• identifier3: string
  Indicates the identifier corresponding on the item value set.
• inventoryOrganization: inventoryOrganization
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• inventoryOrganizationGid: string
  Identifies the inventory organization corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• itemValues: itemValues
• links: array links
  Read Only: true
• lotNumber: string
  Identifies the lot number corresponding on the item value set.
• packageItem: packageItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packageItemGid: string
  Identifies the package item corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partner: partner
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• partnerGid: string
  Identifies the partner corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partnerSiteGid: string
  Identifies the partner site corresponding to the item value set.
• seqNumber: number (int32)
  Sequence number of the item value set
• serialNumber: string
  Identifies the sequence number corresponding on the item value set

{
    "properties":{
        "seqNumber":{
            "description":"Sequence number of the item value set",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "inventoryOrganizationGid":{
            "description":"Identifies the inventory organization corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "inventoryOrganization":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerGid":{
            "description":"Identifies the partner corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "partner":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerSiteGid":{
            "description":"Identifies the partner site corresponding to the item value set.",
            "type":"string"
        },
        "packageItemGid":{
            "description":"Identifies the package item corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packageItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "countryOfOriginGid":{
            "description":"Identifies the origin of the goods corresponding on the item value set.",
            "type":"string"
        },
        "lotNumber":{
            "description":"Identifies the lot number corresponding on the item value set.",
            "type":"string"
        },
        "serialNumber":{
            "description":"Identifies the sequence number corresponding on the item value set",
            "type":"string"
        },
        "identifier1":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "identifier2":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "identifier3":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "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"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "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"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "itemValues":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
                    }
                },
                "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

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

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

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

Show Source

• object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : itemValues

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
            }
        },
        "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 : packageItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : partner

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemValueSets.itemValues

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
    }
}

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 : itemsWithProdClassCodeGid.itemValueSets.itemValues

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID of the value qualifier corresponding to the item value.
• links: array links
  Read Only: true
• value: value
  The currency value corresponding to the item value.

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID of the value qualifier corresponding to the item value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "value":{
            "description":"The currency value corresponding to the item value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

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

Match All

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

Show Source

• object dateType

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

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

The currency value corresponding to the item value.

Match All

The currency value corresponding to the item value.

Show Source

• object currencyType

{
    "description":"The currency value corresponding to the item value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.packagedItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems"
    }
}

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 : itemsWithProdClassCodeGid.packagedItems

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
• bbHandlingType: string
  Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.
• bulkMixingFamilyGid: string
  Indicates the bulk mixing family the packaged item belongs to.
• categoryGid: string
  The GID for the packaged item category.
• compartmentTypeProfGid: string
  Compartment type profile attached to the packaged item.
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• description: string
  Packaged item free form text field for the description. For example, a case of soda.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• hazmatPackageTypeGid: string
  The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.
• incrNestingHeight: incrNestingHeight
  Specifies the incremental nesting height for the PI
• innerPackCount: number (double)
  The count for the number of items in the inner pack.
• innerPackPackagingUnitGid: string
  The packaging unit related to the count for the number of items in the inner pack.
• innerPackSize: number (double)
  Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.
• innerPackSizeUomCode: string
  Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.
• isAllowMixedFreight: boolean
  Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.
• isDefaultPackaging: boolean
  Check box indicating if the information entered is the default packaging for this item.
• isHazardous: boolean
  Check box indicating if the information entered is the packaged item is considered hazardous.
• isNestable: boolean
  Specifies if the packaged item is nestable or not
• links: array links
  Read Only: true
• loadConfigRuleRank: number (int32)
  During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.
• packagedItemGid: string
  The GID for the packaged item.
• packagedItemTypeGid: string
  Type of packaged item.
• packagedItemXid: string
  The XID for the packaged item.
• packageRefUnits: packageRefUnits
• packageShipUnitWeight: packageShipUnitWeight
  The weight of the ship unit.
• packageSuDiameter: packageSuDiameter
  Packaged ship unit diameter.
• packageSuHeight: packageSuHeight
  Package ship unit ship unit height.
• packageSuLength: packageSuLength
  Package ship unit ship unit length.
• packageSuVolume: packageSuVolume
  Packaged ship unit volume.
• packageSuWidth: packageSuWidth
  Packaged ship unit width.
• packagingUnitGid: string
  The GID for the packaging unit.
• parcelPacktype: string
  Parcel package type.
• priority: number (int32)
  This column defines the priority associated with an packaged item.
• pruUsages: pruUsages
• refnums: refnums
• thuProfileGid: string
  Defines all valid THUs the PI can be packed into.
• tiHis: tiHis

{
    "properties":{
        "packagedItemGid":{
            "description":"The GID for the packaged item.",
            "type":"string"
        },
        "packagedItemXid":{
            "description":"The XID for the packaged item.",
            "type":"string"
        },
        "description":{
            "description":"Packaged item free form text field for the description. For example, a case of soda.",
            "type":"string"
        },
        "hazmatPackageTypeGid":{
            "description":"The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit. ",
            "type":"string"
        },
        "packageShipUnitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "innerPackCount":{
            "description":"The count for the number of items in the inner pack.",
            "type":"number",
            "format":"double"
        },
        "innerPackPackagingUnitGid":{
            "description":"The packaging unit related to the count for the number of items in the inner pack.",
            "type":"string"
        },
        "innerPackSize":{
            "description":"Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.",
            "type":"number",
            "format":"double"
        },
        "innerPackSizeUomCode":{
            "description":"Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.",
            "type":"string"
        },
        "packageSuVolume":{
            "description":"Packaged ship unit volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuLength":{
            "description":"Package ship unit ship unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuWidth":{
            "description":"Packaged ship unit width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuHeight":{
            "description":"Package ship unit ship unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isDefaultPackaging":{
            "description":"Check box indicating if the information entered is the default packaging for this item. ",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"Check box indicating if the information entered is the packaged item is considered hazardous.",
            "type":"boolean"
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuDiameter":{
            "description":"Packaged ship unit diameter.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bbHandlingType":{
            "description":"Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemTypeGid":{
            "description":"Type of packaged item.",
            "type":"string"
        },
        "loadConfigRuleRank":{
            "description":"During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.",
            "type":"number",
            "format":"int32"
        },
        "thuProfileGid":{
            "description":"Defines all valid THUs the PI can be packed into.",
            "type":"string"
        },
        "parcelPacktype":{
            "description":"Parcel package type.",
            "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"
                }
            ]
        },
        "isAllowMixedFreight":{
            "description":"Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.",
            "type":"boolean"
        },
        "bulkMixingFamilyGid":{
            "description":"Indicates the bulk mixing family the packaged item belongs to.",
            "type":"string"
        },
        "compartmentTypeProfGid":{
            "description":"Compartment type profile attached to the packaged item.",
            "type":"string"
        },
        "categoryGid":{
            "description":"The GID for the packaged item category.",
            "type":"string"
        },
        "priority":{
            "description":"This column defines the priority associated with an packaged item.",
            "type":"number",
            "format":"int32"
        },
        "isNestable":{
            "description":"Specifies if the packaged item is nestable or not",
            "type":"boolean"
        },
        "incrNestingHeight":{
            "description":"Specifies the incremental nesting height for the PI",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "pruUsages":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.pruUsages"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tiHis":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
                    }
                },
                "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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Match All

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

Show Source

• object amountType

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

Nested Schema : equipmentRefUnits

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : incrNestingHeight

Specifies the incremental nesting height for the PI

Match All

Specifies the incremental nesting height for the PI

Show Source

• object amountType

{
    "description":"Specifies the incremental nesting height for the PI",
    "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 : packageRefUnits

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : packageShipUnitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

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

Nested Schema : packageSuDiameter

Packaged ship unit diameter.

Match All

Packaged ship unit diameter.

Show Source

• object amountType

{
    "description":"Packaged ship unit diameter.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuHeight

Package ship unit ship unit height.

Match All

Package ship unit ship unit height.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuLength

Package ship unit ship unit length.

Match All

Package ship unit ship unit length.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuVolume

Packaged ship unit volume.

Match All

Packaged ship unit volume.

Show Source

• object amountType

{
    "description":"Packaged ship unit volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuWidth

Packaged ship unit width.

Match All

Packaged ship unit width.

Show Source

• object amountType

{
    "description":"Packaged ship unit width.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruUsages

Type: object

Show Source

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

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

Nested Schema : tiHis

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
    }
}

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 : itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  ERU for the packaged item
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of reference units per package for ERU.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"ERU for the packaged item",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of reference units per package for ERU.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.packagedItems.packageRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
    }
}

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 : itemsWithProdClassCodeGid.packagedItems.packageRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• innerPackCount: number (double)
  Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.
• links: array links
  Read Only: true
• packagingUnitGid: string
  The GID for the packaged unit.

{
    "properties":{
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "innerPackCount":{
            "description":"Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.packagedItems.pruUsages

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.pruUsages"
    }
}

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 : itemsWithProdClassCodeGid.packagedItems.pruUsages

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the packaging reference unit.
• packagingUnitGid: string
  The GID for the packaged unit.
• pruCount: number (double)
  The count for the number of packing reference units.
• sequenceNo: number (int64)
  Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.

{
    "properties":{
        "sequenceNo":{
            "description":"Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "packagingReferenceUnitGid":{
            "description":"The GID for the packaging reference unit.",
            "type":"string"
        },
        "pruCount":{
            "description":"The count for the number of packing reference units.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.packagedItems.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemRefnumQualGid: string
  The GID for the packaged item reference number qualifier.
• refnumValue: string
  Value of reference number being added for this packaged item reference number qualifier.

{
    "properties":{
        "packagedItemRefnumQualGid":{
            "description":"The GID for the packaged item reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Value of reference number being added for this packaged item 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 itemsWithProdClassCodeGid.packagedItems.tiHis

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
    }
}

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 : itemsWithProdClassCodeGid.packagedItems.tiHis

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• numLayers: number (int32)
  Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.
• packagingUnitGid: string
  The GID for the package unit.
• quantityPerLayer: number (int32)
  Number of items per layer. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.
• sequenceNo: number (int64)
  The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.
• transportHandlingUnitGid: string
  The GID for the transport unit for the TiHi information being defined.

{
    "properties":{
        "sequenceNo":{
            "description":"The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the package unit.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport unit for the TiHi information being defined.",
            "type":"string"
        },
        "numLayers":{
            "description":"Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.",
            "type":"number",
            "format":"int32"
        },
        "quantityPerLayer":{
            "description":"Number of items per layer.  For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.",
            "type":"number",
            "format":"int32"
        },
        "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 itemsWithProdClassCodeGid.partnerItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerItems"
    }
}

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 : itemsWithProdClassCodeGid.partnerItems

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partnerItemGid: string
  The GID for the partner item.

{
    "properties":{
        "partnerItemGid":{
            "description":"The GID for the partner item.",
            "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 itemsWithProdClassCodeGid.partnerSites

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerSites"
    }
}

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 : itemsWithProdClassCodeGid.partnerSites

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partnerSiteGid: string
  The GID for the party site.

{
    "properties":{
        "partnerSiteGid":{
            "description":"The GID for the party site.",
            "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 itemsWithProdClassCodeGid.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemRefnumQualGid: string
  The GID for the qualifier used to qualify the reference number being added. For example, part number.
• itemRefnumValue: string
  The value entered qualified by the reference number qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "itemRefnumQualGid":{
            "description":"The GID for the qualifier used to qualify the reference number being added.  For example, part number.",
            "type":"string"
        },
        "itemRefnumValue":{
            "description":"The value entered qualified by 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 itemsWithProdClassCodeGid.relationships

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.relationships"
    }
}

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 : itemsWithProdClassCodeGid.relationships

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The GID for the item that is having the previous item information added, updated, or removed.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "itemGid":{
            "description":"The GID for the item that is having the previous item information added, updated, or removed. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object itemsWithProdClassCodeGid

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "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 itemsWithProdClassCodeGid.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.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 : itemsWithProdClassCodeGid.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 (int64)
  The sequence number for the item remark.
• remarkText: string
  The text of the remark about the item.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark about the item.",
            "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 itemsWithProdClassCodeGid.reqdocDocReviews

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocReviews"
    }
}

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 : itemsWithProdClassCodeGid.reqdocDocReviews

Type: object

Show Source

• comments: string
  Changes.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentDefGid: string
  The GID for the document definition.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  Review info.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "contactGid":{
            "description":"The GID for the document contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"Review info.",
            "type":"string"
        },
        "comments":{
            "description":"Changes.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "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 itemsWithProdClassCodeGid.reqdocDocs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocs"
    }
}

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 : itemsWithProdClassCodeGid.reqdocDocs

Type: object

Show Source

• annotations: string
  Changes.
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentDefGid: string
  The GID for the document definition.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentRevision: number (double)
  Count for the number of document revisions.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  Review info.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"Count for the number of document revisions.",
            "type":"number",
            "format":"double"
        },
        "review":{
            "description":"Review info.",
            "type":"string"
        },
        "annotations":{
            "description":"Changes.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "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 itemsWithProdClassCodeGid.reqdocReviewers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocReviewers"
    }
}

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 : itemsWithProdClassCodeGid.reqdocReviewers

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The GID for the involved party qualifier.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentDefGid: string
  The GID for the document definition.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "contactGid":{
            "description":"The GID for the document contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 itemsWithProdClassCodeGid.reqdocs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocs"
    }
}

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 : itemsWithProdClassCodeGid.reqdocs

Type: object

Show Source

• documentDefGid: string
  The GID for the document definition.
• domainName: string
  Database domain where this data is stored.
• instructions: string
  Document instructions.
• links: array links
  Read Only: true
• numRevisions: number (double)
  Count for the number of document revisions.
• reviewStatus: string
  Current review status for the document.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"Count for the number of document revisions.",
            "type":"number",
            "format":"double"
        },
        "reviewStatus":{
            "description":"Current review status for the document.",
            "type":"string"
        },
        "instructions":{
            "description":"Document instructions.",
            "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 itemsWithProdClassCodeGid.reqdocStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocStatuses"
    }
}

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 : itemsWithProdClassCodeGid.reqdocStatuses

Type: object

Show Source

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

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "statusTypeGid":{
            "description":"The GID for the document status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the document status value.",
            "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 itemsWithProdClassCodeGid.reqdocSubscribers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocSubscribers"
    }
}

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 : itemsWithProdClassCodeGid.reqdocSubscribers

Type: object

Show Source

• asInvolvedPartyQualGid: string
  GID for the involved party qualifier for the subscriber.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  GID for the document definition contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentDefGid: string
  The GID for the document definition that the subscribers are being managed for.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition that the subscribers are being managed for.",
            "type":"string"
        },
        "contactGid":{
            "description":"GID for the document definition contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"GID for the involved party qualifier for the subscriber.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "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 itemsWithProdClassCodeGid.reqdocTexts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocTexts"
    }
}

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 : itemsWithProdClassCodeGid.reqdocTexts

Type: object

Show Source

• documentDefGid: string
  The GID for the document definition that the text template is being added, updated, or removed.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textTemplateGid: string
  The GID for the text template that is being added, updated, or removed.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition that the text template is being added, updated, or removed.",
            "type":"string"
        },
        "textTemplateGid":{
            "description":"The GID for the text template that is being added, updated, or removed.",
            "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 itemsWithProdClassCodeGid.specialServices

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : itemsWithProdClassCodeGid.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service required for the item being shipped.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service required for the item being shipped.",
            "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 itemsWithProdClassCodeGid.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.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 : itemsWithProdClassCodeGid.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 for the item.
• statusValueGid: string
  The GID for the status value for the item.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type for the item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the status value for the item.",
            "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 itemsWithProdClassCodeGid.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.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 : itemsWithProdClassCodeGid.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 the text template.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template.",
            "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.uomConversions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.uomConversions"
    }
}

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 : itemsWithProdClassCodeGid.uomConversions

Type: object

Show Source

• conversionRate: number (double)
  The conversion rate between the from and to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the conversion rate would be - for the standard LB to KG conversion - 0.453592.
• domainName: string
  Database domain where this data is stored.
• fromUomCode: string
  The from unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the from unit of measure would be pounds.
• guicSeqNum: number (int64)
  Internal sequence number for the item unit of measure conversion records.
• links: array links
  Read Only: true
• toUomCode: string
  The to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the to unit of measure would be kilograms.

{
    "properties":{
        "guicSeqNum":{
            "description":"Internal sequence number for the item unit of measure conversion records.",
            "type":"number",
            "format":"int64"
        },
        "fromUomCode":{
            "description":"The from unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the from unit of measure would be pounds.",
            "type":"string"
        },
        "toUomCode":{
            "description":"The to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the to unit of measure would be kilograms.",
            "type":"string"
        },
        "conversionRate":{
            "description":"The conversion rate between the from and to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the conversion rate would be - for the standard LB to KG conversion - 0.453592.",
            "type":"number",
            "format":"double"
        },
        "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 packagedItems.packageRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.packageRefUnits"
    }
}

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 : packagedItems.packageRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• innerPackCount: number (double)
  Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.
• links: array links
  Read Only: true
• packagingUnitGid: string
  The GID for the packaged unit.

{
    "properties":{
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "innerPackCount":{
            "description":"Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.pruUsages

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.pruUsages"
    }
}

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 : packagedItems.pruUsages

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the packaging reference unit.
• packagingUnitGid: string
  The GID for the packaged unit.
• pruCount: number (double)
  The count for the number of packing reference units.
• sequenceNo: number (int64)
  Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.

{
    "properties":{
        "sequenceNo":{
            "description":"Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "packagingReferenceUnitGid":{
            "description":"The GID for the packaging reference unit.",
            "type":"string"
        },
        "pruCount":{
            "description":"The count for the number of packing reference units.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.refnums

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemRefnumQualGid: string
  The GID for the packaged item reference number qualifier.
• refnumValue: string
  Value of reference number being added for this packaged item reference number qualifier.

{
    "properties":{
        "packagedItemRefnumQualGid":{
            "description":"The GID for the packaged item reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Value of reference number being added for this packaged item 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 packagedItems.tiHis

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.tiHis"
    }
}

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 : packagedItems.tiHis

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• numLayers: number (int32)
  Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.
• packagingUnitGid: string
  The GID for the package unit.
• quantityPerLayer: number (int32)
  Number of items per layer. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.
• sequenceNo: number (int64)
  The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.
• transportHandlingUnitGid: string
  The GID for the transport unit for the TiHi information being defined.

{
    "properties":{
        "sequenceNo":{
            "description":"The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the package unit.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport unit for the TiHi information being defined.",
            "type":"string"
        },
        "numLayers":{
            "description":"Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.",
            "type":"number",
            "format":"int32"
        },
        "quantityPerLayer":{
            "description":"Number of items per layer.  For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.",
            "type":"number",
            "format":"int32"
        },
        "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 schema

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

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

Type: object

Show Source

• compartmentNum: number (int32)
  The equipment compartment number for which the ERU capacity is being defined.
• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The GID for the equipment group reference unit being defined.
• limitNumReferenceUnits: number (double)
  Limit for the number of ERUs. The limit allows you to set an artificial limit to allow the placement of up to a certain number of ERUs and then allows the equipment to be filled with other ERUs.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The maximum number of ERUs that can be held in the compartment.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment group reference unit being defined.",
            "type":"string"
        },
        "compartmentNum":{
            "description":"The equipment compartment number for which the ERU capacity is being defined. ",
            "type":"number",
            "format":"int32"
        },
        "numReferenceUnits":{
            "description":"The maximum number of ERUs that can be held in the compartment.",
            "type":"number",
            "format":"double"
        },
        "limitNumReferenceUnits":{
            "description":"Limit for the number of ERUs. The limit allows you to set an artificial limit to allow the placement of up to a certain number of ERUs and then allows the equipment to be filled with other ERUs.",
            "type":"number",
            "format":"double"
        },
        "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 schema

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

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The GID for the equipment type.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "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 schema

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

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

Type: object

Show Source

• compartmentNum: number (int32)
  The equipment compartment number for which the obstruction is being defined.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obstrHeight: obstrHeight
  The height coordinate for the obstruction.
• obstrLength: obstrLength
  The length of the obstruction.
• obstructionName: string
  Name given to obstruction.
• obstructionNum: number (int32)
  Number identifier for the obstruction.
• obstrWidth: obstrWidth
  The width of the obstruction.
• startHeightPosition: startHeightPosition
  The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
• startLengthPosition: startLengthPosition
  The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
• startWidthPosition: startWidthPosition
  The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

{
    "properties":{
        "compartmentNum":{
            "description":"The equipment compartment number for which the obstruction is being defined.",
            "type":"number",
            "format":"int32"
        },
        "obstructionNum":{
            "description":"Number identifier for the obstruction.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "obstructionName":{
            "description":"Name given to obstruction.",
            "type":"string"
        },
        "startLengthPosition":{
            "description":"The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startWidthPosition":{
            "description":"The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startHeightPosition":{
            "description":"The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrLength":{
            "description":"The length of the obstruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrWidth":{
            "description":"The width of the obstruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrHeight":{
            "description":"The height coordinate for the obstruction. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "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 : obstrHeight

The height coordinate for the obstruction.

Match All

The height coordinate for the obstruction.

Show Source

• object amountType

{
    "description":"The height coordinate for the obstruction. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : obstrLength

The length of the obstruction.

Match All

The length of the obstruction.

Show Source

• object amountType

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

Nested Schema : obstrWidth

The width of the obstruction.

Match All

The width of the obstruction.

Show Source

• object amountType

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

Nested Schema : startHeightPosition

The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startLengthPosition

The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startWidthPosition

The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item that is linked to the equipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "packagedItemGid":{
            "description":"The packaged item that is linked to the equipment group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "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 : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• transportHandlingUnitGid: string
  The GID for the transport handling unit.

{
    "properties":{
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• vehicleTypeGid: string
  The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).
  If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.
  If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type "loose freight" scenario.
  If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle type.

{
    "properties":{
        "vehicleTypeGid":{
            "description":"The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).<br>If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.<br>If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type \"loose freight\" scenario.<br>If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle 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 equipmentTypes.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.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 : equipmentTypes.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 being entered for the equipment type.
• remarkSequence: number (int64)
  Sequence number for entered remarks.
• remarkText: string
  The remark text being entered for the selected remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for entered remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier being entered for the equipment type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text being entered for the selected 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 equipmentTypes.specialServices

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : equipmentTypes.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service for this equipment type.
• expirationDate: expirationDate
  The expiration date of this special service for this equipment type.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service being entered for the equipment type.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service being entered for the equipment type.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service for this equipment type.

Match All

The effective date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The effective date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service for this equipment type.

Match All

The expiration date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The expiration date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 schema

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentRefnumQualGid: string
  The equipment reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The equipment reference number value.

{
    "properties":{
        "equipmentRefnumQualGid":{
            "description":"The equipment reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The equipment reference number value.",
            "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 schema

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The Remark Qualifier ID.
• remarkSequence: number (int64)
  The sequence number of the remark.
• remarkText: string
  The Text of the Remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number of the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The Remark Qualifier ID.",
            "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 schema

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service.
• expirationDate: expirationDate
  The expiration date of this special service.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special services being assigned to the equipment.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special services being assigned to the equipment.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service.

Match All

The effective date of this special service.

Show Source

• object dateType

{
    "description":"The effective date of this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service.

Match All

The expiration date of this special service.

Show Source

• object dateType

{
    "description":"The expiration date of this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 schema

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

Type: object

Show Source

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

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the equipment status.",
            "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 schema

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

Type: object

Show Source

• documentDefGid: string
  The GID of the document that should hold the 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 the text template related to equipment, The selected template is used with the text override option to populate the remark text.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template related to equipment, The selected template is used with the text override option to populate the remark text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"The GID of the document that should hold the text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "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 equipments.trackingEvents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : equipments.trackingEvents

Type: object

Show Source

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

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier linked to the equipment.",
            "type":"number",
            "format":"int64"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "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