1. REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources
  2. Tasks
  3. Business Objects
  4. Rate Records

Get Rate Records

get

/rateRecords

Request

Query Parameters
  • 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.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Show Source
Nested Schema : rateRecords
Type: object
Show Source
  • accessorials
  • Allow Uncosted Line Items (Y/N) is used when there are one or more ratable objects on the shipment which are not charged or considered for rating when rating a shipment using rate record.
    Selected: Some basis options within a shipment pass through the rating engine without a charge if other basis options qualify. For example, if a shipment contains four line items, and a rate is found that contains charges for 3 of those items, that rate qualifies for the shipment and the fourth line item ships for free. If there is a conditional charge and a minimum charge, and the conditional charge does not apply, the minimum charge will always be applied. Cleared: This rate only qualifies if all basis options can be charged.
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • The ID of the rate geo profile to be used when building buy shipments.
  • The ID of the service provider profile to be used when building buy shipments.
  • Calculate Chargeable Weight/Volume Using provides you with options for calculating the chargeable weight. If you select this field value as "Shipment Total Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Shipment Total Dimensional Weight/Volume. If you select this field value as "Sum of Individual Ship Unit Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Sum of Individual Ship Unit Dimensional Weight/Volume.
  • The allowed amount of out of route distance (as a percent of the direct source to final destination distance) that is free before circuitous distance cost are charged.
    Circuity Allowance Percent = (t/d-1)*100 where:
    t is the allowed total distance traveled between the first and last stop of the shipment.
    d is the shortest distance between the first and last stop of the shipment.
    If the allowed total distance is 1500 miles and the distance between the first and last stop is 1300 miles, Circuity Allowance Percent = (1500/1300-1)*100 = (1.15-1)*100 = 15%. The lower the percentage, the more in line the route must be.
  • circuityDistanceCost
    The per distance unit charge for each unit over the included/free amount.
  • The Container-On-Flat-Car/Trailer-On-Flat-Car code used along with the Rail Inter Modal Plan GID to determine the rate.
  • Allows you to constrain the usage of the rate during the planning based the compatibility definition provided by the assigned corporation profile.
  • costGroups
  • This code signifies what rate is used on a Leg; either "C" for the Customer's rate, or "S" for the Shipper's rate.
  • When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No and P = Payant Pour.
  • Constraint value for the number of delivery stops that this rate can be used for.
  • The GID for the dim rate factor.
  • documents
  • Database domain where this data is stored.
  • Allows you to assign a domain profile ID which defines the compatible or incompatible domains for rate.
  • effectiveDate
    Date the rate is effective from.
  • Links the rate geo record to an equipment group profile that, if provided, will constrain the rate to only use equipment groups identified as compatible based on the defined equipment group profile.
  • expirationDate
    Date the rate expires, and should no longer be considered for planning.
  • Used to indicate that the rate has been marked for expiration.
  • The GID for the flex commodity profile.
  • Qualifies how the rate should be used for shipments with hazardous materials. The Hazardous Rate Type has three options which can be used to indicate whether the rate can be used for shipments with or without hazardous materials. The options are:
    Allows Hazardous Materials
    Hazardous Materials Only
    Non-Hazardous Materials Only
  • insertDate
    Read Only: true
    insert date
  • TRUE FALSE flag indicating if the rate is active or not.
  • The From Beyond and For Beyond check boxes allow the existence of two rates with the same geography, such as SPLC to SPLC, to exist with one being allowable for use with Rule 11 and the other one not. Since you cannot have the same GID, this allows you to have the flexibility. The For Beyond check box is for a leg going into a junction as defined on Rule 11 Route Code. The From Beyond check box is for a leg going from a junction. Select both check boxes for a leg going from a junction to a junction.
  • The From Beyond and For Beyond check boxes allow the existence of two rates with the same geography, such as SPLC to SPLC, to exist with one being allowable for use with Rule 11 and the other one not. Since you cannot have the same GID, this allows you to have the flexibility. The For Beyond check box is for a leg going into a junction as defined on Rule 11 Route Code. The From Beyond check box is for a leg going from a junction. Select both check boxes for a leg going from a junction to a junction.
  • If Y, the BASE rate will not be evaluated and applied for this rate geo.
  • Most commonly applicable to spot rates; indicates if this rate is to be found by rate finding logic. During RIQ, if the attached rate offering is a spot rate, the rate geo can only be used if quote is checked.
  • This column is named as IS_SOURCING_RATE to maintain consistency with RATE_OFFERING table but used to serve the purpose of IS_READ_ONLY in the UI.
  • links
  • 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)
  • The GID for the location.
    This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
  • Specifies the logic configuration group ID used to look up any logic parameters specified as charge multipliers on costs. If not null, overrides value specified on the owning rate offering.
  • maxCircuityDistance
    The rate constraint that defines the maximum circuity distance for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
  • The rate constraint that defines the maximum circuity percent for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
  • minCost
    The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies, so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
  • Value for the minimum number of stops required for this rate to apply.
  • The multi base group rule determines how the results from multiple rate cost groups are evaluated. Values A/M/X. Options are:
    Add the Cost,
    Select the Least Cost,
    Select the Greatest Cost.
    Rate Cost Groups allow you to group rate costs together.
    Note: To use Rate Cost Groups, you must have rate groups active within your user preferences.
  • nmfcCodeSubstitutes
  • Used for rate maintenance and is provided so you can track the different versions of your rates during the approval process.
  • Optional payment method for the rate record
  • Constraint value for the number of pickup stops that this rate can be used for.
  • The rail inter-modal plan GID. i.e. Plan 20 - door-to-door, Plan 25 - ramp-to-ramp, etc.
  • The rate geo description.
  • The GID for the rate geo.
  • System generated unique identifier for a rate geo. For internal use only.
  • The XID for the rate geo.
  • Indicates the rate offering to which this rate reo record is linked.
  • The GID for rate quality.
  • Links to the rate service record which, based on the related rate service type, determines how to calculate the timing for a shipment.
  • The GID for the rate zone profile.
  • refnums
  • remarks
  • The global ID for the rate offering time period definition which is used to define the time periods for tiered rates.
  • Determines when to apply the rounding rules. Values are A/N/C/O where A=always, N=never, C=conditionals only, and O=cost calculations only.
  • Determines which kinds of fields will be affected by the rounding settings during costing. Values are 0-7, where 0=all fields, 1=none, 2=numeric fields only, 3=unit fields (weight, etc.), 4=currency, 5=numeric and unit fields, 6=numeric and currency fields, and 7=unit and currency fields.
  • Numbers will be rounded (or truncated) to the nearest increment of this value.
  • The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
  • The GID for the route code.
  • smcDiscounts
  • specialServices
  • stopRates
  • The Stops Included Rate field indicates the number of free stops included in the rate before stop-off charges apply. The source and destination locations count as stops so, typically, the minimum number of stops included in the rate is 2. Additional charges apply for all stops not included in the rate.
  • Constraint value for the total number of stops (pickup and delivery) that this rate can be used for.
  • updateDate
    Read Only: true
    update date
  • viaDestLoc
    Read Only: true
    This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  • A VIA Locations is used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Location set up on an itinerary. This field provides the location GID for a single destination via location.
    This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
  • VIA Locations are used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Locations set up on an itinerary. This field provides the profile GID for the profile/list of destination via locations.
  • viaSrcLoc
    Read Only: true
    This property is a reference resource (a resource that is referred via a foreign key) of the property viaSrcLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  • A VIA Locations is used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Location set up on an itinerary. This field provides the location GID for a single source via location.
    This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
  • VIA Locations are used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Locations set up on an itinerary. This field provides the profile GID for the profile/list of source via locations.
  • Indicates the lane definition (the from and to geo hierarchies) that this rate geo record will cover.
Nested Schema : accessorials
Type: object
Show Source
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
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
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
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
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
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
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
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
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
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
Nested Schema : circuityDistanceCost
The per distance unit charge for each unit over the included/free amount.
Match All
The per distance unit charge for each unit over the included/free amount.
Show Source
Nested Schema : costGroups
Type: object
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : effectiveDate
Date the rate is effective from.
Match All
Date the rate is effective from.
Show Source
Nested Schema : expirationDate
Date the rate expires, and should no longer be considered for planning.
Match All
Date the rate expires, and should no longer be considered for planning.
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
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
Nested Schema : maxCircuityDistance
The rate constraint that defines the maximum circuity distance for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
Match All
The rate constraint that defines the maximum circuity distance for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
Show Source
Nested Schema : minCost
The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies, so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
Match All
The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies, so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
Show Source
Nested Schema : nmfcCodeSubstitutes
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : smcDiscounts
Type: object
Show Source
Nested Schema : specialServices
Type: object
Show Source
Nested Schema : stopRates
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : viaDestLoc
Read Only: true
This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestLocGid, 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 viaDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
Show Source
Nested Schema : viaSrcLoc
Read Only: true
This property is a reference resource (a resource that is referred via a foreign key) of the property viaSrcLocGid, 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 viaSrcLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.accessorials
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.costGroups
Type: object
Show Source
  • costs
  • Defines the way the rating logic handles unit breaks. When there is a unit break defined for a rate, deficit calculations will make sure that the least expensive rate is selected. For example, if a rate break occurs at 1000 pounds, and an order weighs 999 pounds (with a rate of $15 per pound), then the system will look at the price of shipping at the next highest weight break (1001 pounds at $13 per pound) and apply the cheapest rate. In this example, the least expensive option is to use the 1001 pound rate even though only 999 pounds are being shipped. For details on the types, see rounding and deficit calculations.
  • Database domain where this data is stored.
  • The name used to identify the rate group.
  • links
  • Determine how costs within this group will be calculated.
  • The GID for the rate cost group. Rate cost groups provide the ability to group separate costs together to produce a final rate.
  • The sequence number used in the UI to display rate groups in order.
  • The XID for the rate cost group.
  • Set to Base to create a base cost or miscellaneous for all other cost types.
  • Defines when rounding should take place. For example, you may only want rounding to be done on cost calculations.
  • Specifies which fields in the rating process should be rounded. For example, you may only want currency fields rounded.
  • Specifies what interval to round up or down to. For example, if you want to round up or down to the nearest 1, then you would enter 1 here. If you want to round up or down to the nearest tenth decimal place, then you would enter .1 here.
  • Dictates how numbers are rounded. Select Ceiling to always round up, Floor to always round down, Nearest Interval to round up if it is 5 or greater and down if it is less than 5, or No Rounding to not round at all.
Nested Schema : costs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.costGroups.costs
Type: object
Show Source
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Calculate Chargeable Weight/Volume Using provides you with options for calculating the chargeable weight. If you select this field value as "Shipment Total Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Shipment Total Dimensional Weight/Volume. If you select this field value as "Sum of Individual Ship Unit Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Sum of Individual Ship Unit Dimensional Weight/Volume.
  • Allows the user to select a calendar activity for the calendar validation test.
  • If the costs being defined is to be based on a calendar provide the Calendar ID.
  • Charge action to be applied. Values (A/M/X/D/W).
  • chargeAmount
    Amount to be charged per unit code and unit count. For example, the amount to be charge is 1 USD for every 3 pounds.
  • Comparator between charges.
  • The RBI used to lookup values in the secondary rate unit break profile.
  • Determines the attribute/qualifier of the object based on which the charge using unit breaks is to be calculated. For example, if the rate break is based on flex field attribute1, this column will hold value as attribute1, the flex field column name. If the rate break is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object based on which the charge using unit breaks is to be calculated. For example, if rate break is based on flex field attribute1, this column will hold value as attribute1, the flex field column name. If rate break is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • This is the basis option for which the cost accrues from the Basis field. Values (A/L/S/G/E/I).
  • The basis option for which the cost accrues from the Basis field.
  • Controls how charge multipliers are applied against the specified cost. Values (A/L/S/G/E/I). There are a set of options:
    Add individual multiplier values
    Greatest individual cost
    Choose lowest individual cost
    Collect costs separately
  • Enter the number of basis options that go with each amount in the Unit field.
  • Determines the attribute/qualifier of the object based on which the charge is to be calculated. For example, if the charge is based on some flex field attribute1, this column will hold value as attribute1, the flex field column name. If the charge is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object based on which the charge is to be calculated. For example, if the charge is based on some flex field attribute1, this column will hold value as attribute1, the flex field column name. If the charge is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Charge sequence controls, in the order that the costs are calculated. Charge Sequence 1 is calculated before Charge Sequence 2.
  • There are the following cost types:
    Charge
    Discount
    External
    Profile
  • The charge unit count indicates the per amount for the charge. For example, the amount to be charged is 1 USD for every 3 pounds. In this example 3 is the charge unit count - 1 USD is charged for every 3 pounds.
  • The number of basis options that go with each amount in the Unit field.
  • The charge per unit of measure. For example, the amount to be charged is 1 USD for every 3 pounds. In this example pounds is the charge unit of measure code.
  • The charge per unit of measure. For example, the amount to be charged is 1 USD for every 3 pounds. In this example pounds is the charge unit of measure code.
  • The cost category can be assigned to one or more rate costs in a rate record. The cost category can then be grouped into cost category sets which can then be used during the driver assignment process. During the rating process, only rate costs whose categories are contained in the specified set will be evaluated. The results will be sorted based on total weighted cost and the best option assigned.
  • Tags a cost with an accessorial code. This does not indicate that the cost is an accessorial. It is a way of identifying groups of costs.
  • Designates the type of the cost. C = Charge, D = Discount, P = Profile, E = External.
  • When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No, and P = Payant Pour
  • Records additional information about the rate cost. This description will appear as the shipment cost type on the Financial tab of the Shipment Manager when this rate cost is applied to a shipment. If this field is left blank, a default shipment cost type appears such as Base or Discount.
  • The Dimensional (Dim) Rate Factor ID links to the definition of the dim rate factor. The dim rate factor calculates the dimensional weight of a shipment, typically for goods shipped via air or sea. The weight is calculated as: Volume of the shipment/Dimensional rate factor. The system uses the greater of dimensional weight and actual weight which is called the chargeable weight. This chargeable weight is used while rating the shipment.
  • Identifies the distance unit for the tariff. Informational. Values ( A/B/D/F/K/L/M/T/X).
  • Database domain where this data is stored.
  • effectiveDate
    Date the rate is effective from.
  • Stores information related to the authority/government agency that relates to this rate.
  • expirationDate
    Date the rate expires, and should no longer be considered for planning.
  • For a cost type of E, specifies the external rating engine GID.
  • For external rating engine GIDs of type GENERIC, this specifies the fieldset used to call out to the external engine.
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Indicates if this rate cost has been filed as tariff. This is set to 'N' for new spot rates. Users may wish to set up a saved query to notify users if this rate is used.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • links
  • For a cost type of L, specifies the logic parameter qualifier (of type Currency) which contains the cost value used as the charge multiplier.
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • maxCost
    The maximum cost is the absolute maximum rate that can be charged. The calculated rate cost is comparted to the maximum cost and the lower of the two values is what is charged.
  • minCost
    The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies; so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
  • The GID for the operator.
  • The GID for the operator.
  • The GID for the operator.
  • The GID for the operator.
  • Determines the attribute/qualifier of the object on which the condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the second condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the third condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If the condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If the condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • The minimum charge in the base currency.
  • The mileage factor published for rating purposes. This number is qualified by the rate basis qualifier. An informational field.
  • Provides context for the rate basis number. Informational. For example, if the rate basis number is "83" as defined by the household goods miles definition which would explain the geography for the rate basis number. Values (A/B/C/D/E/F/H/M/T/X/Y).
  • Internal sequencing number for costs operand.
  • An internal sequencing number for costs defined on a rate.
  • The secondary rate unit break profile. It cannot have a value if the main profile GID is NULL.
  • The main rate unit break profile.
  • Determines when to apply the rounding rules. Values are A/N/C/O where A=always, N=never, C=conditionals only, and O=cost calculations only.
  • Determines which kinds of fields will be affected by the rounding settings during costing. Values are 0-7, where 0=all fields, 1=none, 2=numeric fields only, 3=unit fields (weight, etc.), 4=currency, 5=numeric and unit fields, 6=numeric and currency fields, and 7=unit and currency fields.
  • Numbers will be rounded (or truncated) to the nearest increment of this value.
  • The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
  • A commodity classification that is used, as a means of control, for grouping of commodities in tariff applications.
  • tariffDistance
    The distance on which the rate is based.
  • The tariff freight class code specifies the freight classification associated with this tariff. Tariff freight class code references a system where the motor carrier industry has classified "goods" by their shipping density instead of their composition or use. An informational field.
  • The Tariff fields are a set of informational field that let the service provider know the rate being used. The tariff item number can be used for all types of prices. If the service provider assigns an item number or a numeric extension for the authority number in the reference number to the price, then this field can be used to capture that information. The tariff item number is the next step below the tariff section.
  • The tariff item number suffix, if you have a suffix with your tariff item number. The tariff item number suffix works with the tariff item number. An informational field.
  • The item part is a subdivision of an item. The item part is like the house number on a street (tariff item number) in a city (tariff section) in a state (tariff reference number).
  • The tariff section is the first division of granularity of a tariff and describes where the rate can be found. An informational field.
  • If using tiered rating, assigning a number to this field allows RIQ to query tiered rates by simply specifying a tier number.
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
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
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
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
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
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
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
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
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
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
Nested Schema : chargeAmount
Amount to be charged per unit code and unit count. For example, the amount to be charge is 1 USD for every 3 pounds.
Match All
Amount to be charged per unit code and unit count. For example, the amount to be charge is 1 USD for every 3 pounds.
Show Source
Nested Schema : effectiveDate
Date the rate is effective from.
Match All
Date the rate is effective from.
Show Source
Nested Schema : expirationDate
Date the rate expires, and should no longer be considered for planning.
Match All
Date the rate expires, and should no longer be considered for planning.
Show Source
Nested Schema : maxCost
The maximum cost is the absolute maximum rate that can be charged. The calculated rate cost is comparted to the maximum cost and the lower of the two values is what is charged.
Match All
The maximum cost is the absolute maximum rate that can be charged. The calculated rate cost is comparted to the maximum cost and the lower of the two values is what is charged.
Show Source
Nested Schema : minCost
The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies; so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
Match All
The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies; so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
Show Source
Nested Schema : tariffDistance
The distance on which the rate is based.
Match All
The distance on which the rate is based.
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
represents effective date for a document
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Represents expiration date for a document.
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
If preparation, date/time content was last generated
Show Source
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
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
If attachment, date/time content was last updated
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : cmsParams
Type: object
Show Source
Nested Schema : contents
Type: object
Show Source
Nested Schema : contexts
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
represents effective date for a document
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Represents expiration date for a document.
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
If preparation, date/time content was last generated
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
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
Nested Schema : statuses
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
If attachment, date/time content was last updated
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : documents.cmsParams
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : documents.contents
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : documents.contexts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : documents.statuses
Type: object
Show Source
Nested Schema : locations
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
Nested Schema : addresses
Type: object
Show Source
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
Nested Schema : appointDisplay
The duration of appointment display time period.
Match All
The duration of appointment display time period.
Show Source
Nested Schema : apptAfterCutoff
Service provider appointment duration after cutoff.
Match All
Service provider appointment duration after cutoff.
Show Source
Nested Schema : apptBeforeCutoff
Service provider appointment duration before cutoff.
Match All
Service provider appointment duration before cutoff.
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : capacityGroups
Type: object
Show Source
Nested Schema : contacts
Type: object
Show Source
Nested Schema : corporations
Type: object
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
Nested Schema : loadUnloadPoints
Type: object
Show Source
Nested Schema : operationalLocations
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : resourceGroups
Type: object
Show Source
Nested Schema : resourceTypes
Type: object
Show Source
Nested Schema : roleProfiles
Type: object
Show Source
Nested Schema : servprovPrefs
Type: object
Show Source
Nested Schema : slotTimeInterval
The smallest appointment slot interval for the location.
Match All
The smallest appointment slot interval for the location.
Show Source
Nested Schema : specialServices
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : substitutes
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.addresses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.capacityGroups
Type: object
Show Source
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
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts
Type: object
Show Source
  • 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.
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate11
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate12
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate13
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate14
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate15
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate16
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate17
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate18
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate19
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate20
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
  • comMethods
  • Company name for this party.
  • 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.
  • 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.
  • The GID for the contact for the location.
  • contactPreferences
  • Defines whether a contact is a person or group.
  • The XID for the contact for the location.
  • Enter any additional descriptive information for this party/contact.
  • Database domain where this data is stored.
  • If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
  • The email address of the contact person for the location.
  • The external system GID.
  • The facsimile number for the contact person for the location.
  • The given name of the contact person for the location.
  • 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)
  • 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)
  • The GL user GID.
  • Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
  • 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.
  • Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
  • 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.
  • If Y, document attachments may be sent to the contact without virus checking.
  • Indicates if a contact is a 'From-Address' contact.
  • No notification will be sent to the contact if this field is set to false ('N').
  • 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.
  • The title for the contact person at the location.
  • The language the contact person at the location speaks.
  • The surname of the contact person for the location.
  • links
  • 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)
  • The GID for the location.
    This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
  • 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.
  • The middle name of the contact.
  • 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.
  • Text describing something regarding the contact person for the location or the location itself.
  • The primary telephone number for the location's contact person.
  • The secondary telephone number for the location's contact person.
  • The domain of a message recipient.
  • Indicates if the notification should use location.
  • Indicates that messages should be sent to message center.
  • The telephone number for telex communications for the location's contact person.
  • Time zone for the contact.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : comMethods
Type: object
Show Source
Nested Schema : contactPreferences
Type: object
Show Source
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
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
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts.comMethods
Type: object
Show Source
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts.contactPreferences
Type: object
Show Source
  • Database domain where this data is stored.
  • links
  • The preference GID.
  • 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.
Nested Schema : schema
Type: object
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : comMethods
Type: object
Show Source
Nested Schema : corporations
Type: object
Show Source
Nested Schema : documents
Type: object
Show Source
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
Nested Schema : groups
Type: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
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
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
Nested Schema : partyCodes
Type: object
Show Source
Nested Schema : partyScreenings
Type: object
Show Source
Nested Schema : preferences
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : sanctionedScreenings
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
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
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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)
  • 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)
  • Database domain where this data is stored.
  • links
    Read Only: 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
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : corporations
Type: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
Nested Schema : involvedParties
Type: object
Show Source
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
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : vatProvincialRegistrations
Type: object
Show Source
Nested Schema : vatRegistrations
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : corporations.involvedParties
Type: object
Show Source
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
Nested Schema : items
Type: array
Show Source
Nested Schema : corporations.vatProvincialRegistrations
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : corporations.vatRegistrations
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : tradeParties.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
represents effective date for a document
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Represents expiration date for a document.
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
If preparation, date/time content was last generated
Show Source
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
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
If attachment, date/time content was last updated
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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)
  • 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)
  • Database domain where this data is stored.
  • links
    Read Only: 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
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : partyScreeningComments
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
  • Database domain where this data is stored.
  • links
    Read Only: true
  • The preference GID.
  • 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.
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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.
  • 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.
  • The control type and control code are linked to the compliance rule.
  • The GID for the GTM control type. The control type is linked to the compliance rule.
  • Database domain where this data is stored.
  • 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.
  • 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
    Read Only: true
  • The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.corporations
Type: object
Show Source
  • 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)
  • 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)
  • No description.
  • links
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
represents effective date for a document
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Represents expiration date for a document.
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
If preparation, date/time content was last generated
Show Source
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
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
If attachment, date/time content was last updated
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.loadUnloadPoints
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.operationalLocations
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.operationalLocations.details
Type: object
Show Source
  • Database domain where this data is stored.
  • If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.
  • 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).
  • If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.
  • links
  • The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.
  • 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)
  • 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)
  • Sequence to allow multiple data records for the same operational location.
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
Nested Schema : schema
Type: object
Show Source
  • aliases
  • The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
  • Ship group allow tender determines whether the system can automatically tender ship group to this service provider.By default it is set to 'N'
  • Flag to indicate that service provider is valid for Spot Rating actions
  • 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.
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • The GID for the auto approve rule profile.
  • 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
    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)
  • 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)
  • Determines if the service provider can participate in conditional booking.
  • documents
  • Database domain where this data is stored.
  • If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.
  • The Equipment Mark List for this Service Provider.
  • Select the Incumbent check box to indicate that this service provider has been used previously.
  • insertDate
    Read Only: true
    insert date
  • 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.
  • Is set to Y(es) if the service provider will participate in broadcast tendering.
  • 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.
  • Is set to Y(es) if the service provider will participate in spot bid tendering.
  • This flag will define whether service provider is active or not.By default this flag will be Y.
  • 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.
  • A flag to turn on/off the Tender by Locale feature.
  • Only shipments created for fleet service providers can perform fleet related actions.
  • 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.
  • 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.
  • Select the Minority check box if the business is minority-owned.
  • Indicates the line approval tolerance rule profile to apply.
  • links
    Read Only: true
  • 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.
  • 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.
  • A GID to define the mode profiles(group) that the service provider uses.
  • The NVOCC Domain field determines the domain in which the buy shipments and new job are created.
  • 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.
  • Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.
  • 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
  • The Standard Carrier Alpha Code for this Service Provider.
  • If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.
  • The service provider GID.
  • servprovLocation
    The primary location for the service provider.
  • The service provider XID.
  • 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
    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)
  • 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)
  • 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
    The expected response time by this service provider for shipment tenders.
  • 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
    Read Only: true
    update date
Nested Schema : aliases
Type: object
Show Source
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : documents
Type: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
insert date
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : servprovLocation
The primary location for the service provider.
Match All
The primary location for the service provider.
Show Source
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
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
Nested Schema : updateDate
Read Only: true
update date
Match All
update date
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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.
  • Database domain where this data is stored.
  • links
    Read Only: true
  • The GID for the service provider alias qualifier.
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : serviceProviders.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
represents effective date for a document
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Represents expiration date for a document.
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
If preparation, date/time content was last generated
Show Source
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
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
If attachment, date/time content was last updated
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceGroups
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes
Type: object
Show Source
Nested Schema : resources
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources
Type: object
Show Source
Nested Schema : apptRuleSets
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets
Type: object
Show Source
Nested Schema : flexFields
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums
Type: object
Show Source
  • The appointment reference number qualifier. The qualifier related to shipment is used.
  • The appointment reference number value.
  • Database domain where this data is stored.
  • 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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles
Type: object
Show Source
Nested Schema : activityTimeDefs
Type: object
Show Source
Nested Schema : calendars
Type: object
Show Source
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
Nested Schema : handlings
Type: object
Show Source
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
Nested Schema : thuCapacities
Type: object
Show Source
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
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
Nested Schema : varHndcstVol
The planning handling cost volume at this location.
Match All
The planning handling cost volume at this location.
Show Source
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
Nested Schema : varHndcstWgt
The planning handling cost weight at this location.
Match All
The planning handling cost weight at this location.
Show Source
Nested Schema : varHndcstWgtCost
Variable Handling Cost Per Weight at this location.
Match All
Variable Handling Cost Per Weight at this location.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.activityTimeDefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.calendars
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.handlings
Type: object
Show Source
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.thuCapacities
Type: object
Show Source
  • Database domain where this data is stored.
  • 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
  • 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
    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
    Value for the maximum volume of the transportation handling unit.
  • maxWeight
    Value for the maximum weight of the transportation handling unit.
  • 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
  • The GID for the transport handling unit.
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
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
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
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
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
Nested Schema : pruCapacities
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities
Type: object
Show Source
  • Database domain where this data is stored.
  • 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
  • The GID for the package unit reference unit.
  • 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.
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.servprovPrefs
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
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
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
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.servprovPrefs.details
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.specialServices
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.substitutes
Type: object
Show Source
  • Database domain where this data is stored.
  • links
  • 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.
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.nmfcCodeSubstitutes
Type: object
Show Source
  • Database domain where this data is stored.
  • links
  • Records additional information about the rate cost. This description will appear as the shipment cost type on the Financial tab of the Shipment Manager when this rate cost is applied to a shipment. If this field is left blank, a default shipment cost type appears such as Base or Discount.
  • Low National Motor Freight Classification value used for defining a rate as classification record.
  • The National Motor Freight Classification (NMFC) fields allow you to apply a specific NMFC based rate using a range of NMFC classes. For example, if you want anything between the NMFC class of 45 and 65 to use the 55 NMFC class rate, then you would enter 45 in the NMFC Low field, 65 in the NMFC High field, and 55 in the Rate As NMFC Class field. Note: The NMFC Low and High fields are inclusive, meaning they follow a "greater than or equal to" and a "less than or equal to" pattern respectively. Using the above example, 45 and 65 are included in the ranges.
  • The GID for the related rate offering for the rate as table of values.
  • Internal sequence number for different row entries.
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.smcDiscounts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.specialServices
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.specialServices.accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.stopRates
Type: object
Show Source
  • Database domain where this data is stored.
  • Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
    The high stop field defines the high end of the range for stop off charges.
  • links
  • Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
    The low stop fields defines the low end of the range for stop off charges.
  • perStopCost
    The per stop charge for the low high range being defined.
Nested Schema : perStopCost
The per stop charge for the low high range being defined.
Match All
The per stop charge for the low high range being defined.
Show Source
Back to Top