REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources

Root Schema : rateOfferings

Type: object

Show Source

absoluteCostDf: absoluteCostDf

Absolute cost for digital freight rates.
accessorials: accessorials
allowUncostedLineItems: boolean

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.
Marked: 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.
attribute1: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute10: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute11: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute12: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute13: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute14: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute15: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute16: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute17: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute18: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute19: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute2: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute20: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute3: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute4: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute5: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute6: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute7: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute8: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute9: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attributeDate1: attributeDate1

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

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

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

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

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

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

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

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

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

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

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber10: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber2: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber3: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber4: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber5: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber6: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber7: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber8: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber9: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
calcChargeableWtVolWith: string

This field provides different options for calculating the shipments total weight and volume. "Shipment Total Dimensional Weight/Volume", the chargeable weight/volume will be calculated based on the Shipment Total Dimensional Weight/Volume. "Sum of Individual Ship Unit Dimensional Weight/Volume", the chargeable weight/volume will be calculated based on the Sum of Individual Ship Unit Dimensional Weight/Volume.
capacityGroupGid: string

The GID for the capacity group.
circuityAllowancePercent: number (double)

Circuity Allowance Percent indicates 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: circuityDistanceCost

Circuity Distance Cost is the per distance unit charge for each unit over the included/free amount.
cmIsPercentOfDistance: boolean

Indicates whether the percent of the total loaded distance is used to allocate the empty leg cost.
cmIsSameEquip: boolean

Indicates whether the shipments in the continuous move tour are restricted to utilize the same equipment type.
cmMaxNumShipments: number (int32)

The maximum shipments in a continuous move tour.
cmPrevShipmentPercent: number (double)

The percentage of the empty leg cost allocated to previous shipment.
cofcTofc: string

Container-On-Flat-Car Trailer-On-Flat-Car code used along with the Rail Inter Modal Plan to determine the rate.
comments: comments
commodityUsage: string

Indicates if the rate offering is or is not a commodity based rate offering i.e., are rates based on the classification of the freight. Values (F/C).
continuousMoveEndingExclusionRegions: continuousMoveEndingExclusionRegions
continuousMoveRules: continuousMoveRules
corporationProfileGid: string

The GID for the corporation profile.
currencyGid: string

The GID for the currency.
customerRateCode: string

This code signifies what rate is used on a leg; either 'C' for the Customer's rate, or 'S' for the Shipper's rate.
deficitCalculationsType: string

When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No and P = Payant Pour
deliveryStopsConstraint: number (int32)

For rate offerings where the service provider will provide multi-stop coverage, the total delivery stops constraints sets a constraint on the total number of delivery stops that the rate can be used for.
dimRateFactorGid: string

The GID for the DIM rate factor.
distanceUomCode: string

The unit of measure for distance.
documents: documents
domainName: string

Database domain where this data is stored.
domainProfileGid: string

Providing a domain profile allows for the rate offering to be constrained to the domains in the domain profile and serves as a constraint on the rate offering.
If none of the rate offerings have a customer domain profile constraint, then all rate offerings are returned.
If some of the rate offerings have customer domain profiles, the rate offerings are grouped by service provider. For each service provider, only the offerings whose domain profile constraint is satisfied are returned. So, given two rate offerings, one with a constraint, and one without a constraint: if the order release domain list is compatible with the constraint, only the rate offering with the constraint is returned, otherwise, only the offering without the constraint is returned.
equipmentGroupProfileGid: string

The GID for the equipment group profile.
exchangeRateGid: string

The GID for the exchange rate.
expireMarkId: string

Indicates that the rate has been marked for expiration.
externalRatingEngineGid: string

The GID for the external rating engine.
extReFieldsetGid: string

Specifies the external rating engine fieldset to be used when invoking an external rating engine using our generic interface.
fakFlexCommodityValue: string

Freight all kinds rate as commodity value.
fakRateAs: string

Freight all kinds rate as commodity. Values (Y/N).
fallbackRateServiceGid: string

The fall back rate service will be used for driving the shipment if the regular rate service is unable to drive the shipment. For example, you may typically have voyage information for two months into the future. However, sometimes a possible order will come in for three months into the future. This works for all rate inquiry types. For example, this will enable you to run rate inquiry Network Rate and Route for this order information, using the same itineraries and rates, and get answers for rate and route even though you do not have voyage information that far in the future. The parameter FALLBACK RS NUM OF DAYS determines how many days into the future to allow use of the fallback rate offering.
flexCommodityProfileGid: string

The GID for the flex commodity profile.
hazardousRateType: string

N - Applies to shipments with no hazardous items, H - Applies only to shipments with hazardous items, A - Applies to hazardous and non-hazardous shipments.
insertDate: insertDate

Read Only: true

insert date
involvedParties: involvedParties
isActive: boolean

Indicates if the rate offering is active (Y) or inactive (N). If inactive (N) the rate offering will not be used in planning. Values (Y/N).
isContractRate: boolean

Informational indicator to identify rate offerings that are managed for a client in a 3rd party logistics provider setup. Values (Y/N).
isDepotApplicable: boolean

If the Depot Applicable option is selected, then the depot stops (source and/or destination locations) will be saved to the shipment. If it is not selected, the depot stops will not be saved to the shipment, but they will be charged and saved to the shipment financials if it is defined in the itinerary. Values (Y/N).
isDigitalFreight: boolean

If set to Y, then fetch rates from digital freight and use them only for tender.
isDirectOnlyRate: boolean

If Y, this rate will only be applicable to direct shipments.
isMarketRate: boolean

If Y then this rate will be used to fetch market rates for the shipment.
isRouteExecutionRate: boolean

If 'Y', this rate offering is used for Route Execution only. For migration: old existing rate offerings migrated to the default value ('N').
isSourcingRate: boolean

Indicates is the rate offering is a sourcing rate offering. Sourcing rates are view only within the system. Values (Y/N).
isTemplate: boolean

Used to identify rate offerings that will be used as a rate record template for Sourcing. Values (Y/N).
links: array links

Read Only: true
logicConfigGid: string

Specifies the logic config group ID used to look up any logic parameters specified as charge multipliers.
maxAveragePkgWeight: maxAveragePkgWeight

Constraint. If the total shipment weight/number of packages > this constraint, the rate will not be considered.
maxCircuityDistance: maxCircuityDistance

The rate offering constraint that defines the maximum circuity distance for the rate offering. If this value is exceeded, the rate offering 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.
maxCircuityPercent: number (double)

The rate offering constraint that defines the maximum circuity percent for the rate offering. If this value is exceeded, the rate offering 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.
maxCost: maxCost

The absolute maximum cost that applies, regardless of actual rated cost to ship.
maxDigiFrtPct: number (double)

Define a percentage around how much higher the carrier rates are compared to the planned cost of the shipment when using rates from digital freight.
maxDistanceConstraint: maxDistanceConstraint

The maximum distance field is intended to be used to match the rate offering with shipments. The system calculates the distance between the source and destination address of the shipment being considered, then compares that calculated distance to the maximum Distance field value to see if the rate offering matches or is below the maximum distance constraint.
maxGirthConstraint: maxGirthConstraint

The maximum girth constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum girth constraint the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).
maxHeightConstraint: maxHeightConstraint

The maximum height constraint is used when matching the rate offering to a shipment. If a ship units' length requirements is greater than the maximum height constraint the rate offering does not qualify.
maxLengthConstraint: maxLengthConstraint

The maximum length constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum length constraint, the rate offering does not qualify.
maxNumOfShipmentSegments: number (int64)

The Max Num of Shipment Segments field determines the maximum number of segments on a shipment. A segment is defined as starting when product is loaded on the equipment and ending when the equipment is completely emptied.
maxShipunitLinePkgWeight: maxShipunitLinePkgWeight

The ship unit line weight maximum is used to match with ship unit lines. This field represents the maximum value allowed by this contract for the weight of a single package.
maxShipUnitWeight: maxShipUnitWeight

The maximum ship unit weight constraint is used when matching rate offerings with shipments. If any ship unit on the shipment exceeds the maximum ship unit weight, this rate offering does not qualify for the shipment in question.
maxTenderLeadTime: maxTenderLeadTime

The upper bound of tender lead time. That is, if tender lead time of a shipment is bigger than this upper bound, rate would be invalid.
maxVolumeConstraint: maxVolumeConstraint

The maximum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is greater than the maximum value, then this rate offering does not qualify for the shipment in question.
maxWeightConstraint: maxWeightConstraint

The maximum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is greater than the maximum value, then this rate offering does not qualify for the shipment in question.
maxWidthConstraint: maxWidthConstraint

The maximum width constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum width constraint, the rate offering does not qualify.
minCost: minCost

The Minimum Cost field stores the absolute minimum charge that applies for the rate offering.
minDistanceConstraint: minDistanceConstraint

The minimum distance required for this rate offering to be valid.
minGirthConstraint: minGirthConstraint

The minimum girth constraint is used when matching the rate offering to a shipment. If a ship unit's girth is less than the minimum, the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).
minHeightConstraint: minHeightConstraint

The minimum height constraint is used when matching the rate offering to a shipment. If a ship unit's height is less than the minimum, the rate offering does not qualify.
minLengthConstraint: minLengthConstraint

The minimum length constraint is used when matching the rate offering to a shipment. If a ship unit's length is less than the minimum, the rate offering does not qualify.
minStops: number (int32)

The absolute minimum number of stops allowed for shipments using this rate.
minTenderLeadTime: minTenderLeadTime

The lower bound of a tender lead time. That is, if tender lead time of a shipment is less than this lower bound, rate would be invalid.
minVolumeConstraint: minVolumeConstraint

The minimum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is less than the minimum value, then this rate offering does not qualify for the shipment in question.
minWeightConstraint: minWeightConstraint

The minimum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is less than the minimum value, then this rate offering does not qualify for the shipment in question.
minWidthConstraint: minWidthConstraint

The minimum width constraint is used when matching the rate offering to a shipment. If a ship unit's width is less than the minimum, the rate offering does not qualify.
modeProfileGid: string

A unique identifier to define the group profile for multiple modes.
nmfcCodeSubstitutes: nmfcCodeSubstitutes
packageCountMethod: string

Determines how packages are counted when testing the Maximum Average Package Weight constraint. L - Use line item package count. U - Ship unit count.
packageWeightMin: packageWeightMin

Not a constraint. Weight value used when calculating total shipment minimum package weight. During rating, it will be multiplied by the number of packages on the shipment, and accessed by the Minimum Package Weight RBI.
parentRateOfferingGid: string

The Parent Rate Offering field is used with rate maintenance. The Parent Rate Offering ID provides a way to track different versions of the rates during the approval process. To compare rate versions, you must specify either a parent rate offering ID or parent rate record ID on any template rate offerings or rate records.
perspective: string

Indicates if the rate offering can be used for Buy shipment rating (B) or Sell shipment rating (S) or if the rate offering supports Both Buy and Sell shipment rating (A). Values (B/S/A).
pickupStopsConstraint: number (int32)

For rate offerings where the service provider will provide multi-stop coverage, the total pickup stops constraints sets a constraint on the total number of pickup stops that the rate can be used for.
railInterModalPlanGid: string

The GID for the rail inter-modal plan. I.e., Plan 20: door-to-door, Plan 25: ramp-to-ramp, etc.
rateClassificationGid: string

The GID for rate classification.
rateDistanceGid: string

The GID for rate distance.
rateGroupGid: string

The GID for the rate group.
rateOfferingDesc: string

Stores descriptive information about the rate offering.
rateOfferingGid: string

The GID for the rate offering.
rateOfferingSeq: number (int64)

System generated unique identifier for a rate offering. Internal use only.
rateOfferingTypeGid: string

The GID for the rate offering type.
rateOfferingXid: string

The XID for the rate offering.
rateQualityGid: string

The GID for rate quantity.
rateRulesAndTerms: rateRulesAndTerms
rateServiceGid: string

The GID for the rate service.
rateServiceProfileGid: string

A unique identifier to define the group profile for multiple rate services.
rateVersionGid: string

The GID for the rate version.
recalculateCost: boolean

For some time-based rates, the shipment cost calculated during bulk plan and build shipment process may need to be recalculated since it is time dependent. The Recalculate Cost option is used to force the recalculating of cost after a shipment is built. This option works in conjunction with the Rerate All Shipments After Bulk Plan parameter as follows. If the Recalculate Cost is set, planning logic will make sure to account for service time-based rating costs when making planning decisions, and that this has the potential for increasing run-time.
If Rerate All Shipments After Bulk Plan is TRUE, shipments will be re-rated regardless of the Recalculate Cost check box.
If Rerate All Shipments After Bulk Plan is FALSE and the Recalculate Cost check box is selected, then the system recalculates the shipment cost keeping the same service provider and equipment.
If Rerate All Shipments After Bulk Plan is FALSE and the Recalculate Cost option check box is cleared, then the shipment cost is not recalculated.
regionGroupGid: string

The Region Group field is an informational region group that allows you to define a set of regions that represent the regions covered by the rate offering.
remarks: remarks
rmAbsoluteMinCost: rmAbsoluteMinCost

The Absolute Minimum Base Charge field determines the minimum charge that applies regardless of discounted savings.
roTimePeriodDefGid: string

The time period definition (if any) assigned to the rate offering for the purposes of tiered rating.
roundingApplication: string

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.
roundingFieldsLevel: number (int32)

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.
roundingInterval: number (double)

Numbers will be rounded (or truncated) to the nearest increment of this value.
roundingType: string

The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
servprov: servprov

Read Only: true

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

The GID for the service provider.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
servprovProfileGid: string

A unique identifier to define the group profile for multiple service providers.
smcDiscounts: smcDiscounts
specialServices: specialServices
stopRates: stopRates
stopsIncludedInRate: number (int32)

The Stops Included in Rate field indicates the number of free stops included in the rate offering 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.
tariffAgencyCode: string

Tariff Agency Code is an informational field that can be used to store the service provider SCAC or initials of the entity who owns the tariff such as the Railroad Publication Service.
tariffEffectiveDate: tariffEffectiveDate

The Tariff Effective Date is an informational field that stores the date when the tariff goes into effect or can be used. This is not the rate offering effective date.
tariffIssuingCarrierId: string

The Tariff Issuing Carrier field is an informational field that is meant to store information from the service provider related to the tariff. Examples are C, JQ, SCQ, QTAMR, UPLQ, BNQ, X, BC, NSPQ.
tariffName: string

The Tariff Name fields allows you to put the name of the tariff that the rate offering is related to. For example, if this is a base rate offering you can put the name of the tariff that the rate offering is based on/is using.
tariffPubAuthority: string

Tariff Pub Authority is an informational field that can be used to store the rate offerings related tariff publication authority.
tariffRefnum: string

Tariff Refnum is an informational field that can be used to store the rate offerings related tariff number. The Tariff Refnum should be qualified by the Tariff Refnum Qualifier.
tariffRefnumQualifier: string

Tariff Refnum Qualifier is an informational field that allows you to qualify the Tariff Ref Num field. For example you can qualify the Tariff Ref Num fields with the Tariff Refnum Qualifier fields using standard qualifier that describe the relationship of the shipper and service provider regarding the prices related to the rate offering. The property glog.shipment.tarifffields.active determines if tariff fields are automatically copied from a rate offering to a shipment.
tariffRefnumSuffix: string

Tariff Refnum Suffix is a suffix field for the tariff reference number.
tariffRegAgencyCode: string

The Tariff Reg Agency Code is an informational field that is meant to store information about the regulatory agency that the rates are fled with. For example the STB (Surface Transportation Board) or ICC) Interstate Commerce Commission.
tariffSupplementId: string

The Tariff Supplement ID field is an informational field that is meant to provide information related to tariff amendments, revisions, or supplements of the rate authority.
totalStopsConstraint: number (int32)

For rate offerings where the service provider will provide multi-stop coverage, the total stops constraints sets a constraint on the total number of stops (pickup and delivery) that the rate can be used for.
trackCapacityUsage: boolean

The Track Capacity Usage field when set to Y, and the Capacity Group field if provided, causes the system to track capacity usage during the planning process.
If the Track Capacity Usage is N or the Capacity Group field is blank, the system will not track capacity usage during the planning process. Values (Y/N).
transportModeGid: string

The GID for the transport mode.
updateDate: updateDate

Read Only: true

update date
userClassification1: string

The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30)
userClassification2: string

The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30)
userClassification3: string

The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30)
userClassification4: string

The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30)
useTactAsDisplayRate1: boolean

If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result to the shipment as a display rate.
useTactAsDisplayRate2: boolean

If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result.
useTactAsDisplayRate3: boolean

If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result.
volumeUomCode: string

The unit of measure for volume.
weightBreakProfileGid: string

The GID for the weight break profile.
weightUomCode: string

The unit of measure for weight.

{
    "properties":{
        "rateOfferingGid":{
            "description":"The GID for the rate offering.",
            "type":"string"
        },
        "rateOfferingXid":{
            "description":"The XID for the rate offering.",
            "type":"string"
        },
        "rateOfferingTypeGid":{
            "description":"The GID for the rate offering type.",
            "type":"string"
        },
        "rateOfferingDesc":{
            "description":"Stores descriptive information about the rate offering.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "rateGroupGid":{
            "description":"The GID for the rate group.",
            "type":"string"
        },
        "currencyGid":{
            "description":"The GID for the currency.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode.",
            "type":"string"
        },
        "userClassification1":{
            "description":"The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30) ",
            "type":"string"
        },
        "userClassification2":{
            "description":"The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30) ",
            "type":"string"
        },
        "userClassification3":{
            "description":"The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30) ",
            "type":"string"
        },
        "userClassification4":{
            "description":"The user classification fields are provided to capture information about the rate offering's usage. VARCHAR2(30) ",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The GID for the equipment group profile.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"The GID for the rate service.",
            "type":"string"
        },
        "rateVersionGid":{
            "description":"The GID for the rate version.",
            "type":"string"
        },
        "maxDistanceConstraint":{
            "description":"The maximum distance field is intended to be used to match the rate offering with shipments. The system calculates the distance between the source and destination address of the shipment being considered, then compares that calculated distance to the maximum Distance field value to see if the rate offering matches or is below the maximum distance constraint.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minWeightConstraint":{
            "description":"The minimum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is less than the minimum value, then this rate offering does not qualify for the shipment in question.<br>",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeightConstraint":{
            "description":"The maximum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is greater than the maximum value, then this rate offering does not qualify for the shipment in question.<br>",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minVolumeConstraint":{
            "description":"The minimum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is less than the minimum value, then this rate offering does not qualify for the shipment in question.<br>",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolumeConstraint":{
            "description":"The maximum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is greater than the maximum value, then this rate offering does not qualify for the shipment in question.<br>",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxShipUnitWeight":{
            "description":"The maximum ship unit weight constraint is used when matching rate offerings with shipments. If any ship unit on the shipment exceeds the maximum ship unit weight, this rate offering does not qualify for the shipment in question.<br>",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tariffName":{
            "description":"The Tariff Name fields allows you to put the name of the tariff that the rate offering is related to. For example, if this is a base rate offering you can put the name of the tariff that the rate offering is based on/is using.",
            "type":"string"
        },
        "minCost":{
            "description":"The Minimum Cost field stores the absolute minimum charge that applies for the rate offering.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "rateDistanceGid":{
            "description":"The GID for rate distance.",
            "type":"string"
        },
        "rateQualityGid":{
            "description":"The GID for rate quantity.",
            "type":"string"
        },
        "rateClassificationGid":{
            "description":"The GID for rate classification.",
            "type":"string"
        },
        "externalRatingEngineGid":{
            "description":"The GID for the external rating engine.",
            "type":"string"
        },
        "circuityAllowancePercent":{
            "description":"Circuity Allowance Percent indicates 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. <br>Circuity Allowance Percent = (t/d-1)*100 where:<br>t is the allowed total distance traveled between the first and last stop of the shipment.<br>d is the shortest distance between the first and last stop of the shipment.<br>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.",
            "type":"number",
            "format":"double"
        },
        "totalStopsConstraint":{
            "description":"For rate offerings where the service provider will provide multi-stop coverage, the total stops constraints sets a constraint on the total number of stops (pickup and delivery) that the rate can be used for.",
            "type":"number",
            "format":"int32"
        },
        "pickupStopsConstraint":{
            "description":"For rate offerings where the service provider will provide multi-stop coverage, the total pickup stops constraints sets a constraint on the total number of pickup stops that the rate can be used for.",
            "type":"number",
            "format":"int32"
        },
        "deliveryStopsConstraint":{
            "description":"For rate offerings where the service provider will provide multi-stop coverage, the total delivery stops constraints sets a constraint on the total number of delivery stops that the rate can be used for.",
            "type":"number",
            "format":"int32"
        },
        "circuityDistanceCost":{
            "description":"Circuity Distance Cost is the per distance unit charge for each unit over the included/free amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "maxCircuityPercent":{
            "description":"The rate offering constraint that defines the maximum circuity percent for the rate offering. If this value is exceeded, the rate offering 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.",
            "type":"number",
            "format":"double"
        },
        "maxCircuityDistance":{
            "description":"The rate offering constraint that defines the maximum circuity distance for the rate offering. If this value is exceeded, the rate offering 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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "stopsIncludedInRate":{
            "description":"The Stops Included in Rate field indicates the number of free stops included in the rate offering 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.",
            "type":"number",
            "format":"int32"
        },
        "flexCommodityProfileGid":{
            "description":"The GID for the flex commodity profile.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"The GID for the exchange rate.",
            "type":"string"
        },
        "commodityUsage":{
            "description":"Indicates if the rate offering is or is not a commodity based rate offering i.e., are rates based on the classification of the freight. Values (F/C).",
            "type":"string"
        },
        "fakRateAs":{
            "description":"Freight all kinds rate as commodity. Values (Y/N).",
            "type":"string"
        },
        "fakFlexCommodityValue":{
            "description":"Freight all kinds rate as commodity value.",
            "type":"string"
        },
        "rmAbsoluteMinCost":{
            "description":"The Absolute Minimum Base Charge field determines the minimum charge that applies regardless of discounted savings.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "maxCost":{
            "description":"The absolute maximum cost that applies, regardless of actual rated cost to ship.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "minStops":{
            "description":"The absolute minimum number of stops allowed for shipments using this rate.",
            "type":"number",
            "format":"int32"
        },
        "minLengthConstraint":{
            "description":"The minimum length constraint is used when matching the rate offering to a shipment. If a ship unit's length is less than the minimum, the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxLengthConstraint":{
            "description":"The maximum length constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum length constraint, the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minWidthConstraint":{
            "description":"The minimum width constraint is used when matching the rate offering to a shipment. If a ship unit's width is less than the minimum, the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWidthConstraint":{
            "description":"The maximum width constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum width constraint, the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minHeightConstraint":{
            "description":"The minimum height constraint is used when matching the rate offering to a shipment. If a ship unit's height is less than the minimum, the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxHeightConstraint":{
            "description":"The maximum height constraint is used when matching the rate offering to a shipment. If a ship units' length requirements is greater than the maximum height constraint the rate offering does not qualify.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minGirthConstraint":{
            "description":"The minimum girth constraint is used when matching the rate offering to a shipment. If a ship unit's girth is less than the minimum, the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxGirthConstraint":{
            "description":"The maximum girth constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum girth constraint the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightBreakProfileGid":{
            "description":"The GID for the weight break profile.",
            "type":"string"
        },
        "weightUomCode":{
            "description":"The unit of measure for weight.",
            "type":"string"
        },
        "volumeUomCode":{
            "description":"The unit of measure for volume.",
            "type":"string"
        },
        "distanceUomCode":{
            "description":"The unit of measure for distance.",
            "type":"string"
        },
        "dimRateFactorGid":{
            "description":"The GID for the DIM rate factor.",
            "type":"string"
        },
        "perspective":{
            "description":"Indicates if the rate offering can be used for Buy shipment rating (B) or Sell shipment rating (S) or if the rate offering supports Both Buy and Sell shipment rating (A). Values (B/S/A).",
            "type":"string"
        },
        "corporationProfileGid":{
            "description":"The GID for the corporation profile.",
            "type":"string"
        },
        "capacityGroupGid":{
            "description":"The GID for the capacity group.",
            "type":"string"
        },
        "cmMaxNumShipments":{
            "description":"The maximum shipments in a continuous move tour.",
            "type":"number",
            "format":"int32"
        },
        "cmIsSameEquip":{
            "description":"Indicates whether the shipments in the continuous move tour are restricted to utilize the same equipment type.",
            "type":"boolean"
        },
        "cmPrevShipmentPercent":{
            "description":"The percentage of the empty leg cost allocated to previous shipment.",
            "type":"number",
            "format":"double"
        },
        "cmIsPercentOfDistance":{
            "description":"Indicates whether the percent of the total loaded distance is used to allocate the empty leg cost.",
            "type":"boolean"
        },
        "tariffRefnumQualifier":{
            "description":"Tariff Refnum Qualifier is an informational field that allows you to qualify the Tariff Ref Num field. For example you can qualify the Tariff Ref Num fields with the Tariff Refnum Qualifier fields using standard qualifier that describe the relationship of the shipper and service provider regarding the prices related to the rate offering. The property glog.shipment.tarifffields.active determines if tariff fields are automatically copied from a rate offering to a shipment.",
            "type":"string"
        },
        "tariffRefnum":{
            "description":"Tariff Refnum is an informational field that can be used to store the rate offerings related tariff number. The Tariff Refnum should be qualified by the Tariff Refnum Qualifier.",
            "type":"string"
        },
        "tariffPubAuthority":{
            "description":"Tariff Pub Authority is an informational field that can be used to store the rate offerings related tariff publication authority.",
            "type":"string"
        },
        "tariffRegAgencyCode":{
            "description":"The Tariff Reg Agency Code is an informational field that is meant to store information about the regulatory agency that the rates are fled with. For example the STB (Surface Transportation Board) or ICC) Interstate Commerce Commission.",
            "type":"string"
        },
        "tariffAgencyCode":{
            "description":"Tariff Agency Code is an informational field that can be used to store the service provider SCAC or initials of the entity who owns the tariff such as the Railroad Publication Service.<br>",
            "type":"string"
        },
        "tariffIssuingCarrierId":{
            "description":"The Tariff Issuing Carrier field is an informational field that is meant to store information from the service provider related to the tariff. Examples are C, JQ, SCQ, QTAMR, UPLQ, BNQ, X, BC, NSPQ.",
            "type":"string"
        },
        "tariffRefnumSuffix":{
            "description":"Tariff Refnum Suffix is a suffix field for the tariff reference number.",
            "type":"string"
        },
        "tariffSupplementId":{
            "description":"The Tariff Supplement ID field is an informational field that is meant to provide information related to tariff amendments, revisions, or supplements of the rate authority. ",
            "type":"string"
        },
        "tariffEffectiveDate":{
            "description":"The Tariff Effective Date is an informational field that stores the date when the tariff goes into effect or can be used. This is not the rate offering effective date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "allowUncostedLineItems":{
            "description":"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.<br>Marked: 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.",
            "type":"boolean"
        },
        "railInterModalPlanGid":{
            "description":"The GID for the rail inter-modal plan.  I.e., Plan 20: door-to-door, Plan 25: ramp-to-ramp, etc.",
            "type":"string"
        },
        "customerRateCode":{
            "description":"This code signifies what rate is used on a leg; either 'C' for the Customer's rate, or 'S' for the Shipper's rate.",
            "type":"string"
        },
        "cofcTofc":{
            "description":"Container-On-Flat-Car Trailer-On-Flat-Car code used along with the Rail Inter Modal Plan to determine the rate.",
            "type":"string"
        },
        "isActive":{
            "description":"Indicates if the rate offering is active (Y) or inactive (N). If inactive (N) the rate offering will not be used in planning. Values (Y/N).",
            "type":"boolean"
        },
        "expireMarkId":{
            "description":"Indicates that the rate has been marked for expiration.",
            "type":"string"
        },
        "minDistanceConstraint":{
            "description":"The minimum distance required for this rate offering to be valid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "regionGroupGid":{
            "description":"The Region Group field is an informational region group that allows you to define a set of regions that represent the regions covered by the rate offering. ",
            "type":"string"
        },
        "isDepotApplicable":{
            "description":"If the Depot Applicable option is selected, then the depot stops (source and/or destination locations) will be saved to the shipment. If it is not selected, the depot stops will not be saved to the shipment, but they will be charged and saved to the shipment financials if it is defined in the itinerary. Values (Y/N).",
            "type":"boolean"
        },
        "recalculateCost":{
            "description":"For some time-based rates, the shipment cost calculated during bulk plan and build shipment process may need to be recalculated since it is time dependent. The Recalculate Cost option is used to force the recalculating of cost after a shipment is built. This option works in conjunction with the Rerate All Shipments After Bulk Plan parameter as follows. If the Recalculate Cost is set, planning logic will make sure to account for service time-based rating costs when making planning decisions, and that this has the potential for increasing run-time.<br>If Rerate All Shipments After Bulk Plan is TRUE, shipments will be re-rated regardless of the Recalculate Cost check box.<br>If Rerate All Shipments After Bulk Plan is FALSE and the Recalculate Cost check box is selected, then the system recalculates the shipment cost keeping the same service provider and equipment.<br>If Rerate All Shipments After Bulk Plan is FALSE and the Recalculate Cost option check box is cleared, then the shipment cost is not recalculated.",
            "type":"boolean"
        },
        "trackCapacityUsage":{
            "description":"The Track Capacity Usage field when set to Y, and the Capacity Group field if provided, causes the system to track capacity usage during the planning process.<br>If the Track Capacity Usage is N or the Capacity Group field is blank, the system will not track capacity usage during the planning process. Values (Y/N).",
            "type":"boolean"
        },
        "roundingType":{
            "description":"The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.",
            "type":"string"
        },
        "roundingInterval":{
            "description":"Numbers will be rounded (or truncated) to the nearest increment of this value.",
            "type":"number",
            "format":"double"
        },
        "roundingFieldsLevel":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "roundingApplication":{
            "description":"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.",
            "type":"string"
        },
        "deficitCalculationsType":{
            "description":"When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No and P = Payant Pour",
            "type":"string"
        },
        "isContractRate":{
            "description":"Informational indicator to identify rate offerings that are managed for a client in a 3rd party logistics provider setup. Values (Y/N).",
            "type":"boolean"
        },
        "useTactAsDisplayRate1":{
            "description":"If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result to the shipment as a display rate.",
            "type":"boolean"
        },
        "isDirectOnlyRate":{
            "description":"If Y, this rate will only be applicable to direct shipments.",
            "type":"boolean"
        },
        "hazardousRateType":{
            "description":"N - Applies to shipments with no hazardous items, H - Applies only to shipments with hazardous items, A - Applies to hazardous and non-hazardous shipments.",
            "type":"string"
        },
        "useTactAsDisplayRate2":{
            "description":"If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result.",
            "type":"boolean"
        },
        "useTactAsDisplayRate3":{
            "description":"If Y, the build shipment logic will invoke the rating engine a second time, restricting it's search to TACT rates only, and apply the result.",
            "type":"boolean"
        },
        "domainProfileGid":{
            "description":"Providing a domain profile allows for the rate offering to be constrained to the domains in the domain profile and serves as a constraint on the rate offering.<br>If none of the rate offerings have a customer domain profile constraint, then all rate offerings are returned.<br>If some of the rate offerings have customer domain profiles, the rate offerings are grouped by service provider. For each service provider, only the offerings whose domain profile constraint is satisfied are returned. So, given two rate offerings, one with a constraint, and one without a constraint: if the order release domain list is compatible with the constraint, only the rate offering with the constraint is returned, otherwise, only the offering without the constraint is returned.",
            "type":"string"
        },
        "isRouteExecutionRate":{
            "description":"If 'Y', this rate offering is used for Route Execution only. For migration: old existing rate offerings migrated to the default value ('N').",
            "type":"boolean"
        },
        "minTenderLeadTime":{
            "description":"The lower bound of a tender lead time. That is, if tender lead time of a shipment is less than this lower bound, rate would be invalid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxTenderLeadTime":{
            "description":"The upper bound of tender lead time. That is, if tender lead time of a shipment is bigger than this upper bound, rate would be invalid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageWeightMin":{
            "description":"Not a constraint. Weight value used when calculating total shipment minimum package weight. During rating, it will be multiplied by the number of packages on the shipment, and accessed by the Minimum Package Weight RBI.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxAveragePkgWeight":{
            "description":"Constraint. If the total shipment weight/number of packages > this constraint, the rate will not be considered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageCountMethod":{
            "description":"Determines how packages are counted when testing the Maximum Average Package Weight constraint. L - Use line item package count. U - Ship unit count.",
            "type":"string"
        },
        "maxShipunitLinePkgWeight":{
            "description":"The ship unit line weight maximum is used to match with ship unit lines. This field represents the maximum value allowed by this contract for the weight of a single package.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxNumOfShipmentSegments":{
            "description":"The Max Num of Shipment Segments field determines the maximum number of segments on a shipment. A segment is defined as starting when product is loaded on the equipment and ending when the equipment is completely emptied.",
            "type":"number",
            "format":"int64"
        },
        "roTimePeriodDefGid":{
            "description":"The time period definition (if any) assigned to the rate offering for the purposes of tiered rating.",
            "type":"string"
        },
        "extReFieldsetGid":{
            "description":"Specifies the external rating engine fieldset to be used when invoking an external rating engine using our generic interface.",
            "type":"string"
        },
        "rateOfferingSeq":{
            "description":"System generated unique identifier for a rate offering. Internal use only.",
            "type":"number",
            "format":"int64"
        },
        "logicConfigGid":{
            "description":"Specifies the logic config group ID used to look up any logic parameters specified as charge multipliers.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Used to identify rate offerings that will be used as a rate record template for Sourcing. Values (Y/N).",
            "type":"boolean"
        },
        "isSourcingRate":{
            "description":"Indicates is the rate offering is a sourcing rate offering. Sourcing rates are view only within the system. Values (Y/N).",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "fallbackRateServiceGid":{
            "description":"The fall back rate service will be used for driving the shipment if the regular rate service is unable to drive the shipment. For example, you may typically have voyage information for two months into the future. However, sometimes a possible order will come in for three months into the future. This works for all rate inquiry types. For example, this will enable you to run rate inquiry Network Rate and Route for this order information, using the same itineraries and rates, and get answers for rate and route even though you do not have voyage information that far in the future. The parameter FALLBACK RS NUM OF DAYS determines how many days into the future to allow use of the fallback rate offering.",
            "type":"string"
        },
        "parentRateOfferingGid":{
            "description":"The Parent Rate Offering field is used with rate maintenance. The Parent Rate Offering ID provides a way to track different versions of the rates during the approval process. To compare rate versions, you must specify either a parent rate offering ID or parent rate record ID on any template rate offerings or rate records.",
            "type":"string"
        },
        "calcChargeableWtVolWith":{
            "description":"This field provides different options for calculating the shipments total weight and volume. \"Shipment Total Dimensional Weight/Volume\", the chargeable weight/volume will be calculated based on the Shipment Total Dimensional Weight/Volume. \"Sum of Individual Ship Unit Dimensional Weight/Volume\", the chargeable weight/volume will be calculated based on the Sum of Individual Ship Unit Dimensional Weight/Volume.",
            "type":"string"
        },
        "isDigitalFreight":{
            "description":"If set to Y, then fetch rates from digital freight and use them only for tender.",
            "type":"boolean"
        },
        "maxDigiFrtPct":{
            "description":"Define a percentage around how much higher the carrier rates are compared to the planned cost of the shipment when using rates from digital freight.",
            "type":"number",
            "format":"double"
        },
        "absoluteCostDf":{
            "description":"Absolute cost for digital freight rates.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isMarketRate":{
            "description":"If Y then this rate will be used to fetch market rates for the shipment.",
            "type":"boolean"
        },
        "servprovProfileGid":{
            "description":"A unique identifier to define the group profile for multiple service providers.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"A unique identifier to define the group profile for multiple rate services.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"A unique identifier to define the group profile for multiple modes.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "rateRulesAndTerms":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.rateRulesAndTerms"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stopRates":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.stopRates"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "comments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.comments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "continuousMoveRules":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.continuousMoveRules"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "nmfcCodeSubstitutes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.nmfcCodeSubstitutes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "smcDiscounts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.smcDiscounts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "continuousMoveEndingExclusionRegions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.continuousMoveEndingExclusionRegions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : absoluteCostDf

Absolute cost for digital freight rates.

Match All

Absolute cost for digital freight rates.

Show Source

object currencyType

{
    "description":"Absolute cost for digital freight rates.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : accessorials

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : attributeDate1

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate10

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate2

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate3

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate4

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate5

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate6

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate7

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate8

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate9

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : circuityDistanceCost

Circuity Distance Cost is the per distance unit charge for each unit over the included/free amount.

Match All

Circuity Distance Cost is the per distance unit charge for each unit over the included/free amount.

Show Source

object currencyType

{
    "description":"Circuity Distance Cost is the per distance unit charge for each unit over the included/free amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : comments

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : continuousMoveEndingExclusionRegions

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : continuousMoveRules

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : documents

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : involvedParties

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : maxAveragePkgWeight

Constraint. If the total shipment weight/number of packages > this constraint, the rate will not be considered.

Match All

Constraint. If the total shipment weight/number of packages > this constraint, the rate will not be considered.

Show Source

object amountType

{
    "description":"Constraint. If the total shipment weight/number of packages > this constraint, the rate will not be considered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxCircuityDistance

The rate offering constraint that defines the maximum circuity distance for the rate offering. If this value is exceeded, the rate offering 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 offering constraint that defines the maximum circuity distance for the rate offering. If this value is exceeded, the rate offering 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

object amountType

{
    "description":"The rate offering constraint that defines the maximum circuity distance for the rate offering. If this value is exceeded, the rate offering 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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxCost

The absolute maximum cost that applies, regardless of actual rated cost to ship.

Match All

The absolute maximum cost that applies, regardless of actual rated cost to ship.

Show Source

object currencyType

{
    "description":"The absolute maximum cost that applies, regardless of actual rated cost to ship.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : maxDistanceConstraint

The maximum distance field is intended to be used to match the rate offering with shipments. The system calculates the distance between the source and destination address of the shipment being considered, then compares that calculated distance to the maximum Distance field value to see if the rate offering matches or is below the maximum distance constraint.

Match All

The maximum distance field is intended to be used to match the rate offering with shipments. The system calculates the distance between the source and destination address of the shipment being considered, then compares that calculated distance to the maximum Distance field value to see if the rate offering matches or is below the maximum distance constraint.

Show Source

object amountType

{
    "description":"The maximum distance field is intended to be used to match the rate offering with shipments. The system calculates the distance between the source and destination address of the shipment being considered, then compares that calculated distance to the maximum Distance field value to see if the rate offering matches or is below the maximum distance constraint.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxGirthConstraint

The maximum girth constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum girth constraint the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).

Match All

The maximum girth constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum girth constraint the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).

Show Source

object amountType

{
    "description":"The maximum girth constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum girth constraint the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxHeightConstraint

The maximum height constraint is used when matching the rate offering to a shipment. If a ship units' length requirements is greater than the maximum height constraint the rate offering does not qualify.

Match All

The maximum height constraint is used when matching the rate offering to a shipment. If a ship units' length requirements is greater than the maximum height constraint the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The maximum height constraint is used when matching the rate offering to a shipment. If a ship units' length requirements is greater than the maximum height constraint the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLengthConstraint

The maximum length constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum length constraint, the rate offering does not qualify.

Match All

The maximum length constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum length constraint, the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The maximum length constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum length constraint, the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxShipunitLinePkgWeight

The ship unit line weight maximum is used to match with ship unit lines. This field represents the maximum value allowed by this contract for the weight of a single package.

Match All

The ship unit line weight maximum is used to match with ship unit lines. This field represents the maximum value allowed by this contract for the weight of a single package.

Show Source

object amountType

{
    "description":"The ship unit line weight maximum is used to match with ship unit lines. This field represents the maximum value allowed by this contract for the weight of a single package.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxShipUnitWeight

The maximum ship unit weight constraint is used when matching rate offerings with shipments. If any ship unit on the shipment exceeds the maximum ship unit weight, this rate offering does not qualify for the shipment in question.

Match All

The maximum ship unit weight constraint is used when matching rate offerings with shipments. If any ship unit on the shipment exceeds the maximum ship unit weight, this rate offering does not qualify for the shipment in question.

Show Source

object amountType

{
    "description":"The maximum ship unit weight constraint is used when matching rate offerings with shipments. If any ship unit on the shipment exceeds the maximum ship unit weight, this rate offering does not qualify for the shipment in question.<br>",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxTenderLeadTime

The upper bound of tender lead time. That is, if tender lead time of a shipment is bigger than this upper bound, rate would be invalid.

Match All

The upper bound of tender lead time. That is, if tender lead time of a shipment is bigger than this upper bound, rate would be invalid.

Show Source

object amountType

{
    "description":"The upper bound of tender lead time. That is, if tender lead time of a shipment is bigger than this upper bound, rate would be invalid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxVolumeConstraint

The maximum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is greater than the maximum value, then this rate offering does not qualify for the shipment in question.

Match All

The maximum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is greater than the maximum value, then this rate offering does not qualify for the shipment in question.

Show Source

object amountType

{
    "description":"The maximum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is greater than the maximum value, then this rate offering does not qualify for the shipment in question.<br>",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeightConstraint

The maximum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is greater than the maximum value, then this rate offering does not qualify for the shipment in question.

Match All

The maximum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is greater than the maximum value, then this rate offering does not qualify for the shipment in question.

Show Source

object amountType

{
    "description":"The maximum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is greater than the maximum value, then this rate offering does not qualify for the shipment in question.<br>",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWidthConstraint

The maximum width constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum width constraint, the rate offering does not qualify.

Match All

The maximum width constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum width constraint, the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The maximum width constraint is used when matching the rate offering to a shipment. If a ship unit's length requirements is greater than the maximum width constraint, the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minCost

The Minimum Cost field stores the absolute minimum charge that applies for the rate offering.

Match All

The Minimum Cost field stores the absolute minimum charge that applies for the rate offering.

Show Source

object currencyType

{
    "description":"The Minimum Cost field stores the absolute minimum charge that applies for the rate offering.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : minDistanceConstraint

The minimum distance required for this rate offering to be valid.

Match All

The minimum distance required for this rate offering to be valid.

Show Source

object amountType

{
    "description":"The minimum distance required for this rate offering to be valid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minGirthConstraint

The minimum girth constraint is used when matching the rate offering to a shipment. If a ship unit's girth is less than the minimum, the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).

Match All

The minimum girth constraint is used when matching the rate offering to a shipment. If a ship unit's girth is less than the minimum, the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).

Show Source

object amountType

{
    "description":"The minimum girth constraint is used when matching the rate offering to a shipment. If a ship unit's girth is less than the minimum, the rate offering does not qualify. Note: Dimensional girth is calculated as length + (2xWidth + 2xHeight).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minHeightConstraint

The minimum height constraint is used when matching the rate offering to a shipment. If a ship unit's height is less than the minimum, the rate offering does not qualify.

Match All

The minimum height constraint is used when matching the rate offering to a shipment. If a ship unit's height is less than the minimum, the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The minimum height constraint is used when matching the rate offering to a shipment. If a ship unit's height is less than the minimum, the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minLengthConstraint

The minimum length constraint is used when matching the rate offering to a shipment. If a ship unit's length is less than the minimum, the rate offering does not qualify.

Match All

The minimum length constraint is used when matching the rate offering to a shipment. If a ship unit's length is less than the minimum, the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The minimum length constraint is used when matching the rate offering to a shipment. If a ship unit's length is less than the minimum, the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minTenderLeadTime

The lower bound of a tender lead time. That is, if tender lead time of a shipment is less than this lower bound, rate would be invalid.

Match All

The lower bound of a tender lead time. That is, if tender lead time of a shipment is less than this lower bound, rate would be invalid.

Show Source

object amountType

{
    "description":"The lower bound of a tender lead time. That is, if tender lead time of a shipment is less than this lower bound, rate would be invalid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minVolumeConstraint

The minimum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is less than the minimum value, then this rate offering does not qualify for the shipment in question.

Match All

The minimum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is less than the minimum value, then this rate offering does not qualify for the shipment in question.

Show Source

object amountType

{
    "description":"The minimum volume constraint is used when matching rate offerings with shipments. If a shipment's volume is less than the minimum value, then this rate offering does not qualify for the shipment in question.<br>",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minWeightConstraint

The minimum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is less than the minimum value, then this rate offering does not qualify for the shipment in question.

Match All

The minimum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is less than the minimum value, then this rate offering does not qualify for the shipment in question.

Show Source

object amountType

{
    "description":"The minimum weight constraint is used when matching rate offerings with shipments. If a shipment's weight is less than the minimum value, then this rate offering does not qualify for the shipment in question.<br>",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minWidthConstraint

The minimum width constraint is used when matching the rate offering to a shipment. If a ship unit's width is less than the minimum, the rate offering does not qualify.

Match All

The minimum width constraint is used when matching the rate offering to a shipment. If a ship unit's width is less than the minimum, the rate offering does not qualify.

Show Source

object amountType

{
    "description":"The minimum width constraint is used when matching the rate offering to a shipment. If a ship unit's width is less than the minimum, the rate offering does not qualify.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : nmfcCodeSubstitutes

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : packageWeightMin

Not a constraint. Weight value used when calculating total shipment minimum package weight. During rating, it will be multiplied by the number of packages on the shipment, and accessed by the Minimum Package Weight RBI.

Match All

Not a constraint. Weight value used when calculating total shipment minimum package weight. During rating, it will be multiplied by the number of packages on the shipment, and accessed by the Minimum Package Weight RBI.

Show Source

object amountType

{
    "description":"Not a constraint. Weight value used when calculating total shipment minimum package weight. During rating, it will be multiplied by the number of packages on the shipment, and accessed by the Minimum Package Weight RBI.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : rateRulesAndTerms

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : remarks

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : rmAbsoluteMinCost

The Absolute Minimum Base Charge field determines the minimum charge that applies regardless of discounted savings.

Match All

The Absolute Minimum Base Charge field determines the minimum charge that applies regardless of discounted savings.

Show Source

object currencyType

{
    "description":"The Absolute Minimum Base Charge field determines the minimum charge that applies regardless of discounted savings.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : servprov

Read Only: true

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

Match All

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

Show Source

object schema

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

Nested Schema : smcDiscounts

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : specialServices

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : stopRates

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : tariffEffectiveDate

The Tariff Effective Date is an informational field that stores the date when the tariff goes into effect or can be used. This is not the rate offering effective date.

Match All

The Tariff Effective Date is an informational field that stores the date when the tariff goes into effect or can be used. This is not the rate offering effective date.

Show Source

object dateType

{
    "description":"The Tariff Effective Date is an informational field that stores the date when the tariff goes into effect or can be used. This is not the rate offering effective date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : currencyType

Type: object

Show Source

currency: string

ISO 4217 currency code
value: number

Numeric value that specifies a currency

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.accessorials

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.accessorials

Type: object

Show Source

accessorialCodeGid: string

The GID for the accessorial code.
accessorialCostGid: string

The GID for the Accessorial Cost. Links to the rating setup used to determine the cost of providing the accessorial.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

{
    "properties":{
        "accessorialCostGid":{
            "description":"The GID for the Accessorial Cost. Links to the rating setup used to determine the cost of providing the accessorial.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : links

Type: object

Show Source

href: string
rel: string

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

Nested Schema : dateTimeType

Type: object

Show Source

timezone: string

Timezone in Olson database format
value: string (date-time)

Date in ISO 8601 format

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.comments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.comments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.comments

Type: object

Show Source

commentDate: commentDate

The date and time the comment was entered for the rate offering.
domainName: string

Database domain where this data is stored.
enteredBy: string

The user ID of the user entering the comment.
links: array links

Read Only: true
theComment: string

Comment text.

{
    "properties":{
        "commentDate":{
            "description":"The date and time the comment was entered for the rate offering.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "enteredBy":{
            "description":"The user ID of the user entering the comment.",
            "type":"string"
        },
        "theComment":{
            "description":"Comment text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : commentDate

The date and time the comment was entered for the rate offering.

Match All

The date and time the comment was entered for the rate offering.

Show Source

object dateTimeType

{
    "description":"The date and time the comment was entered for the rate offering.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.continuousMoveEndingExclusionRegions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.continuousMoveEndingExclusionRegions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.continuousMoveEndingExclusionRegions

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
regionGid: string

The GID for the region.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.continuousMoveRules

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.continuousMoveRules"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.continuousMoveRules

Type: object

Show Source

domainName: string

Database domain where this data is stored.
freeEmptyDistance: freeEmptyDistance

The free distance allowed between shipments in a continuous move tour.
links: array links

Read Only: true
maxConnectionTime: maxConnectionTime

The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment
maxEmptyDistance: maxEmptyDistance

The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.
maxRelEmptyDistance: number (double)

Max Empty Distance (%) is used to disqualify shipments that are too short in comparison to the distance travelled to include the shipment in the continuous move tour.
Max Empty Distance (%) = 100*E/L, where
E = Max Empty Distance
L = Line Haul Distance of the shipment
maxTimeAfterDeliv: maxTimeAfterDeliv

The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.
minLinehaulDistance: minLinehaulDistance

Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.
xLaneGid: string

The GID for the X Lane.

{
    "properties":{
        "xLaneGid":{
            "description":"The GID for the X Lane.",
            "type":"string"
        },
        "maxConnectionTime":{
            "description":"The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxEmptyDistance":{
            "description":"The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxRelEmptyDistance":{
            "description":"Max Empty Distance (%) is used to disqualify shipments that are too short in comparison to the distance travelled to include the shipment in the continuous move tour.<br>Max Empty Distance (%) = 100*E/L, where<br>E = Max Empty Distance<br>L = Line Haul Distance of the shipment",
            "type":"number",
            "format":"double"
        },
        "minLinehaulDistance":{
            "description":"Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxTimeAfterDeliv":{
            "description":"The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freeEmptyDistance":{
            "description":"The free distance allowed between shipments in a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : freeEmptyDistance

The free distance allowed between shipments in a continuous move tour.

Match All

The free distance allowed between shipments in a continuous move tour.

Show Source

object amountType

{
    "description":"The free distance allowed between shipments in a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : maxConnectionTime

The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment

Match All

The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment

Show Source

object amountType

{
    "description":"The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxEmptyDistance

The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.

Match All

The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.

Show Source

object amountType

{
    "description":"The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxTimeAfterDeliv

The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.

Match All

The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.

Show Source

object amountType

{
    "description":"The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minLinehaulDistance

Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.

Match All

Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.

Show Source

object amountType

{
    "description":"Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

unit: string

Unit of measure
value: number

Numeric value that specifies an amount

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.documents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.documents

Type: object

Show Source

contentManagementSystemGid: string

No description.
documentCmsId: string

A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
documentDefGid: string

No description.
documentFilename: string

No description.
documentGid: string

No description.
documentMimeType: string

No description.
documentTrackingNum: string

No description.
documentType: string

No description.
documentUrl: string

No description.
documentXid: string

No description.
domainName: string

No description.
effectiveDate: effectiveDate

represents effective date for a document
expirationDate: expirationDate

Represents expiration date for a document.
generatedAt: generatedAt

If preparation, date/time content was last generated
links: array links

Read Only: true
ownerDataQueryTypeGid: string

No description.
relatedDocument: relatedDocument

Read Only: true

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

Represents the related document for consolidated/linked documents.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
reportGid: string

The report associated with the document attachment, if content was generated by the report subsystem.
uploadedAt: uploadedAt

If attachment, date/time content was last updated
usedAs: string

Represents the classification of a document.(C/I/L/T)
userDefined1IconGid: string

No description.
userDefined2IconGid: string

No description.
userDefined3IconGid: string

No description.
userDefined4IconGid: string

No description.
userDefined5IconGid: string

No description.

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

object dateType

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

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

object dateType

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

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : relatedDocument

Read Only: true

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

Match All

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

Show Source

object documents

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

object dateTimeType

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

Nested Schema : dateType

Type: object

Show Source

value: string (date-time)

Date in ISO 8601 format

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

Nested Schema : documents

Type: object

Show Source

cmsParams: cmsParams
contentManagementSystemGid: string

No description.
contents: contents
contexts: contexts
documentCmsId: string

Read Only: true

A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
documentDefGid: string

No description.
documentFilename: string

No description.
documentGid: string

No description.
documentMimeType: string

No description. This attribute is marked as Create-Only.
documentTrackingNum: string

No description.
documentType: string

Read Only: true

No description.
documentUrl: string

Read Only: true

No description.
documentXid: string

No description.
domainName: string

No description.
effectiveDate: effectiveDate

represents effective date for a document
expirationDate: expirationDate

Represents expiration date for a document.
generatedAt: generatedAt

If preparation, date/time content was last generated
insertDate: insertDate

Read Only: true

insert date
links: array links

Read Only: true
ownerDataQueryTypeGid: string

No description.
ownerObjectGid: string

No description.
relatedDocument: relatedDocument

Read Only: true

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

Represents the related document for consolidated/linked documents.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
reportGid: string

The report associated with the document attachment, if content was generated by the report subsystem.
statuses: statuses
updateDate: updateDate

Read Only: true

update date
uploadedAt: uploadedAt

If attachment, date/time content was last updated
usedAs: string

Represents the classification of a document.(C/I/L/T)
userDefined1IconGid: string

No description.
userDefined2IconGid: string

No description.
userDefined3IconGid: string

No description.
userDefined4IconGid: string

No description.
userDefined5IconGid: string

No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentType":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentMimeType":{
            "description":"No description. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "ownerObjectGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string",
            "readOnly":true
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "contexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "cmsParams":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.cmsParams"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cmsParams

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : contents

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : contexts

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

object dateType

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

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

object dateType

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

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

object dateTimeType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : relatedDocument

Read Only: true

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

Match All

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

Show Source

object documents

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

Nested Schema : statuses

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

object dateTimeType

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

Nested Schema : items

Type: array

Show Source

Array of: object documents.cmsParams

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : documents.cmsParams

Type: object

Show Source

domainName: string

No description.
links: array links

Read Only: true
paramName: string

Parameter name
paramValue: string

Parameter value

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object documents.contents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : documents.contents

Type: object

Show Source

documentContentGid: string

NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
domainName: string

No description.
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object documents.contexts

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : documents.contexts

Type: object

Show Source

documentContextQualGid: string

Represents the document context qualifier.
documentContextValue: string

Represents the value of a document context qualifier.
domainName: string

No description.
links: array links

Read Only: true

{
    "properties":{
        "documentContextQualGid":{
            "description":"Represents the document context qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "documentContextValue":{
            "description":"Represents the value of a document context qualifier.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object documents.statuses

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : documents.statuses

Type: object

Show Source

domainName: string

No description.
links: array links

Read Only: true
statusTypeGid: string

No description.
statusValueGid: string

No description.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.involvedParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : rateOfferings.involvedParties

Type: object

Show Source

comMethodGid: string

The GID for the communication method for the involved party.
domainName: string

Database domain where this data is stored.
involvedPartyContact: involvedPartyContact

Read Only: true

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

The GID for the contact for the involved party.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
involvedPartyQualGid: string

The GID for the involved party qualifier.
links: array links

Read Only: true

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

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, 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 involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

object tradeParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties

Type: object

Show Source

alternateName: string

If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
attribute1: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute10: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute11: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute12: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute13: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute14: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute15: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute16: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute17: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute18: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute19: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute2: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute20: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute3: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute4: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute5: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute6: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute7: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute8: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute9: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attributeDate1: attributeDate1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber10: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber11: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber12: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber13: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber14: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber15: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber16: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber17: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber18: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber19: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber2: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber20: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber3: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber4: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber5: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber6: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber7: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber8: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber9: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
cellPhone: string

Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
comMethods: comMethods
companyName: string

Company name for this party.
consolidatedNotifyOnly: boolean

Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
consolidationProfileGid: string

The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
contactGid: string

The GID for the contact for the location.
contactType: string

Defines whether a contact is a person or group.
contactXid: string

The XID for the contact for the location.
corporations: corporations
description: string

Enter any additional descriptive information for this party/contact.
documents: documents
domainName: string

Database domain where this data is stored.
ecmUser: string

If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
emailAddress: string

The email address of the contact person for the location.
externalSystemGid: string

The external system GID.
fax: string

The facsimile number for the contact person for the location.
firstName: string

The given name of the contact person for the location.
fromAddrContact: fromAddrContact

Read Only: true

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

The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
glUserGid: string

The GL user GID.
groups: groups
groupSavedQueryGid: string

Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
indicator: string

Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
insertDate: insertDate

Read Only: true

insert date
involvedParties: involvedParties
ippPrinterGid: string

Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
isBroadcast: boolean

Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
isEmailVirusProtected: boolean

If Y, document attachments may be sent to the contact without virus checking.
isFromAddress: boolean

Indicates if a contact is a 'From-Address' contact.
isNotificationOn: boolean

No notification will be sent to the contact if this field is set to false ('N').
isPrimaryContact: boolean

Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N).
jobTitle: string

The title for the contact person at the location.
languageSpoken: string

The language the contact person at the location speaks.
lastName: string

The surname of the contact person for the location.
links: array links

Read Only: true
location: location

Read Only: true

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

The GID for the location.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
messageProfileGid: string

The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
middleName: string

The middle name of the contact.
nameAddressUpdateDate: nameAddressUpdateDate

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

Text describing something regarding the contact person for the location or the location itself.
partyCodes: partyCodes
partyScreenings: partyScreenings
phone1: string

The primary telephone number for the location's contact person.
phone2: string

The secondary telephone number for the location's contact person.
preferences: preferences
recipientDomainName: string

The domain of a message recipient.
refnums: refnums
remarks: remarks
routeThroughLocation: boolean

Indicates if the notification should use location.
sanctionedScreenings: sanctionedScreenings
sendAsMessage: boolean

Indicates that messages should be sent to message center.
statuses: statuses
telex: string

The telephone number for telex communications for the location's contact person.
timeZoneGid: string

Time zone for the contact.
updateDate: updateDate

Read Only: true

update date
userDefined1IconGid: string

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

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

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

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

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

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

Nested Schema : attributeDate1

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate10

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate2

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate3

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate4

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate5

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate6

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate7

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate8

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate9

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : comMethods

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : corporations

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : documents

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : fromAddrContact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : groups

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : involvedParties

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : location

Read Only: true

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

Match All

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

Show Source

object locations

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

Nested Schema : nameAddressUpdateDate

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : partyCodes

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : partyScreenings

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : preferences

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : refnums

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : remarks

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : sanctionedScreenings

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : statuses

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.comMethods

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.comMethods

Type: object

Show Source

calendarGid: string

The calendar GID.
comMethodGid: string

The communication method GID.
comMethodRank: number (int32)

A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
domainName: string

Database domain where this data is stored.
expectedResponseTime: expectedResponseTime

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

Read Only: true

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

Nested Schema : expectedResponseTime

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

Match All

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

Show Source

object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.corporations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.corporations

Type: object

Show Source

corporation: corporation

Read Only: true

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

The GID for the corporation related to the contact.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

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

Nested Schema : corporation

Read Only: true

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

Match All

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

Show Source

object corporations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : corporations

Type: object

Show Source

corporationGid: string

Contains the GID for the corporation.
corporationName: string

Contains the name of the corporation.
corporationXid: string

Contains the XID for the corporation.
domainName: string

Database domain where this data is stored.
dropoffRoutingSequenceGid: string

The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
insertDate: insertDate

Read Only: true

insert date
involvedParties: involvedParties
isAllowHouseCollect: boolean

The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms. Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.
isDomainMaster: boolean

Check box field to identify a corporation record as the domain master. The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.
isShippingAgentsActive: boolean

Indicates if corporation is active. Used with agents.
links: array links

Read Only: true
maxHouseCollectAmt: maxHouseCollectAmt

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

The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
updateDate: updateDate

Read Only: true

update date
vatProvincialRegistrations: vatProvincialRegistrations
vatRegistrations: vatRegistrations

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : involvedParties

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : maxHouseCollectAmt

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

Match All

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

Show Source

object currencyType

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : vatProvincialRegistrations

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : vatRegistrations

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : items

Type: array

Show Source

Array of: object corporations.involvedParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : corporations.involvedParties

Type: object

Show Source

comMethodGid: string

The GID for the communication method.
contact: contact

Read Only: true

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

The GID for the contact.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
domainName: string

Database domain where this data is stored.
involvedPartyQualGid: string

The GID for the involved party qualifier.
links: array links

Read Only: true

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

Nested Schema : contact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object corporations.vatProvincialRegistrations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : corporations.vatProvincialRegistrations

Type: object

Show Source

countryCode3Gid: string

The country code for the provincial VAT registration.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
provinceCode: string

The province code of the registration.
vatProvincialRegGid: string

The provincial VAT registration ID.
vatProvincialRegXid: string

The XID for the provincial VAT registration.

{
    "properties":{
        "vatProvincialRegGid":{
            "description":"The provincial VAT registration ID.",
            "type":"string"
        },
        "vatProvincialRegXid":{
            "description":"The XID for the provincial VAT registration.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code for the provincial VAT registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code of the registration.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object corporations.vatRegistrations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : corporations.vatRegistrations

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
vatRegNoGid: string

VAT registration linked to the corporation indicated by the corporation GID.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.documents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.documents

Type: object

Show Source

contentManagementSystemGid: string

No description.
documentCmsId: string

A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
documentDefGid: string

No description.
documentFilename: string

No description.
documentGid: string

No description.
documentMimeType: string

No description.
documentTrackingNum: string

No description.
documentType: string

No description.
documentUrl: string

No description.
documentXid: string

No description.
domainName: string

No description.
effectiveDate: effectiveDate

represents effective date for a document
expirationDate: expirationDate

Represents expiration date for a document.
generatedAt: generatedAt

If preparation, date/time content was last generated
links: array links

Read Only: true
ownerDataQueryTypeGid: string

No description.
relatedDocument: relatedDocument

Read Only: true

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

Represents the related document for consolidated/linked documents.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
reportGid: string

The report associated with the document attachment, if content was generated by the report subsystem.
uploadedAt: uploadedAt

If attachment, date/time content was last updated
usedAs: string

Represents the classification of a document.(C/I/L/T)
userDefined1IconGid: string

No description.
userDefined2IconGid: string

No description.
userDefined3IconGid: string

No description.
userDefined4IconGid: string

No description.
userDefined5IconGid: string

No description.

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

object dateType

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

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

object dateType

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

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : relatedDocument

Read Only: true

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

Match All

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

Show Source

object documents

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

object dateTimeType

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.groups

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.groups

Type: object

Show Source

contact: contact

Read Only: true

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

The contact GID references a person contact which will inherit notifications, etc. from it's contact group. A contact may belong to more than one contact group.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

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

Nested Schema : contact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.involvedParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.involvedParties

Type: object

Show Source

comMethodGid: string

The GID for the communication method.
domainName: string

Database domain where this data is stored.
gtmRegistrationGid: string

The GID for the registration being assigned to the party.
involvedPartyQualGid: string

The GID for the involved party qualifier related to the registration.
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations

Type: object

Show Source

accessorials: accessorials
addresses: addresses
addressUpdateDate: addressUpdateDate

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

Indicates which external distance engine is used to validate the location.
allowDriverRest: boolean

Indicates if a driver is allowed to take a rest period at this location if he runs out of available HOS.
appointDisplay: appointDisplay

The duration of appointment display time period.
appointDisplayStartTime: number (int32)

The start time of appointment view display.
appointmentActivityType: string

Appointment activity type refers to whether the appointment if for a drop trailer or live unload scenario.
apptAfterCutoff: apptAfterCutoff

Service provider appointment duration after cutoff.
apptBeforeCutoff: apptBeforeCutoff

Service provider appointment duration before cutoff.
apptCutoffHours: number (double)

Service provider appointment cutoff in hours.
apptEnforceActTimeSg: boolean

Enforce Activity Time for shipment group appointments.
apptObjectType: string

Indicates the types of appointment objects this location handles. Shipments, Shipment Groups or both Shipments and Shipment Groups.
apptSearchDays: number (double)

Use the Appointment Search Days field to override the value of the glog.appointment.searchDays property for this location. Set this field to control the number of days to look forward for the first feasible appointment.
apptShowNumberOfOptions: number (double)

Use the Appointment Show Number Of Options field to override the value of the glog.appointment.scheduleAppointmentShowOptions.numberOfAppointments property for this location. Set this field to control how many appointments are displayed when running the Schedule Appointment - Show Options action on the Appointment Management page.
apptStartTimeToleranceSecs: number (int32)

Stores tolerance value for appointment start time in seconds.
attribute1: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute10: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute11: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute12: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute13: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute14: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute15: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute16: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute17: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute18: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute19: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute2: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute20: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute3: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute4: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute5: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute6: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute7: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute8: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute9: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attributeDate1: attributeDate1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber10: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber11: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber12: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber13: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber14: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber15: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber16: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber17: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber18: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber19: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber2: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber20: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber3: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber4: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber5: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber6: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber7: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber8: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber9: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
bbIsNewStore: boolean

Indicates if this location should be treated as a new store by the Batch Balancer logic. New stores can only be assigned by Batch Balancer to a DOOR whose LOAD_NEW_STORE field is set to Y.
bbMaxCasesPerBatch: number (double)

Maximum number of cases allowed in each batch. If blank, the system will assume that there is no limit. If the number of cases in the order exceeds this maximum, then the batch balancer's splitting logic will distribute the cases into multiple batches uniformly while honoring certain rules.
bbOrderSplitMethod: string

Value of "CONVEYABLE" causes only conveyable cases to be counted toward max cases, value of "ALL" causes all cases (including non-con and repack) to count toward max cases.
capacityGroups: capacityGroups
city: string

The name of the city for the location.
contacts: contacts
corporations: corporations
countryCode3Gid: string

A GID to define the three digit country code.
countyQualifier: string

County Qualifier is used when calling an external distance engine and using an address type of city instead of postal code. Often, there are two cities or towns with the same name in one state. For example, in Pennsylvania there is more than one town with the name "Newtown". If you do not combine the town with a postal code or a county, you may not get the result you want.
You can manually add values; however, you probably want to import them from the external distance engine that you are using. The county qualifier needs to correspond with the distance engine that you are using.
deliveryGroupName: string

Another way of grouping the locations.
description: string

Free text to capture different location types or classifications like customer, vendor site, or stores etc.
destArbLevelOfServiceGid: string

Preferred destination arbitrary level of service when selecting the destination arbitrary for a location during bulkplan.
documents: documents
domainName: string

Database domain where this data is stored.
dropoffRoutingSequenceGid: string

Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
enforceTimeWindowAppoint: boolean

Whether or not to enforce the pick up or delivery time window during appointment schedule process."USE_APPOINTMENT_PRIORITY" takes precedence of "ENFORCE_TIME_WINDOW_APPOINT".
equipmentGroupProfileGid: string

The GID for the equipment group profile. An Equipment Group Profile is used to categorize Equipment groups by some common attribute or grouping scheme. For example, you can create a Group Profile called Dry Vans that include the 28 FT Dry Van and 24 FT Dry Van (and others if you like) Equipment Groups.
An Equipment Group Profile consists of an ID and a Profile Name and a collection of specific Equipment Groups that you associate with the profile. Oracle Transportation Management can use the Profile in planning to limit the Equipment Groups that can be used for shipment planning. When Oracle Transportation Management bundles orders and builds shipments, it checks that there is an intersection between the equipment group values identified on the order bases.
Example: Equipment Group Rule
erpcGid: string

The Eastern Region Presidents Commission Code for this Location.
eruGrouping: string

To indicate orders going to this location will be grouped together for ERU grouping.
excludeFromRouteExecution: boolean

When = Y, this location is excluded from any Route Instance Legs.
hasMultipleMatches: string

Indicates if we have multiple matches for the location after address validation.
insertDate: insertDate

Read Only: true

insert date
isActive: boolean

Used to activate or deactivate location. When the value is 'N', it can restrain user from planning order to or from the inactive location; from tendering shipment with inactive location.
isAddressValid: string

Indicates if the address is considered valid (by checking against the POSTAL_CODE_VALIDATE table).
isFixedAddress: boolean

Y/N if address is only allowed to be edited by the UI.
isLtlSplitable: boolean

The LTL Splittable check box indicates whether orders from or to this location are permitted to apply the LTL splitting logic. If the check box is not selected, the LTL splitting is disallowed for orders associated with this location.
isMakeApptBeforePlan: boolean

A true or false flag to identify if an appointment is required at the location for (example) for pickup, delivery etc.
isShipperKnown: boolean

The Known Shipper check box indicates if a shipper is known or unknown. Shippers are considered unknown if they have not filed the appropriate paperwork and gained permission to ship goods on passenger flights. Goods transported by these shippers must be placed on cargo flights. Select Known Shipper if orders coming from this location can be qualified as known, and therefore transported on passenger flights.
isTemplate: boolean

Identifies if the location record is a template or represents a physical location.
isTemporary: boolean

A flag to identify if the location is created temporarily for a certain shipment or order. This location will not be used for other shipments or processes.
isWmsFacility: boolean

Indicates if the location is a warehouse management system facility.
lat: number (double)

The latitude for the location.
links: array links

Read Only: true
loadUnloadPoints: loadUnloadPoints
locationGid: string

The GID for the location.
locationGroupGid: string

The GID for the location group for the location.
locationName: string

The name of the location.
locationXid: string

The XID for the location.
lon: number (double)

The longitude of the location.
numOfRowsInYard: number (int32)

The total number of rows in the yard of the location.
numOfSlotsPerRowInYard: number (int32)

The number of slots per row in the yard of the location.
operationalLocations: operationalLocations
overallQuality: string

Indicates the overall quality of the location.
pickupRoutingSequenceGid: string

Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
postalCode: string

The postal code for the location.
postalSplcGid: string

The Postal Standard Point Location Code for this Location.
primaryAddressLineSeq: number (int64)

The Address Line Number or primary address line sequence number designates which line of the address text box contains the actual street address so when using the External Distance Engine, the correct street address is used.
For example, if you had this address in the text box, the line number would be 2.
Care of Someone
1234 Main St.
province: string

The province (or U.S. state) for the location.
provinceCode: string

The abbreviation for the province (or U.S. state) for the location.
railJunctionCodeGid: string

The Rail Junction Code for this Location.
railSplcGid: string

The Rail Standard Point Location Code for this Location.
railStationCodeGid: string

The Rail Station Code for this Location.
rateClassificationGid: string

The GID for the rate classification. Examples include: COMMERCIAL and RESIDENTIAL.
refnums: refnums
regionGid: string

The GID for the region.
remarks: remarks
resourceGroups: resourceGroups
resourceTypes: resourceTypes
roleProfiles: roleProfiles
scheduleInfeasibleAppoint: boolean

Whether or not to schedule appointment if the appointment time available is out of pick up or delivery time window.
scheduleLowPriorityAppoint: boolean

Whether or not to schedule appointment for low priority appointment that has been bumped off.
servingServprovProfileGid: string

The Serving Service Provider Profile for this Location.
servprovPrefs: servprovPrefs
servprovProfileGid: string

The GID for the service provider for the location.
shuttleLotEqGrpProfileGid: string

This specifies the equipment group profile for the shuttle or parking lot of a location. When a shipment uses one of the equipment groups in this equipment group profile, the location cannot be directly accessed for pickup/delivery and is accessed only through the shuttle lot. In this case, additional shuttle lot activity time is computed and added to the activity time at the location.
slotTimeInterval: slotTimeInterval

The smallest appointment slot interval for the location.
sourcingGroupName: string

Another way of grouping the locations.
specialServices: specialServices
srcArbLevelOfServiceGid: string

Preferred source arbitrary level of service when selecting the source arbitrary for a location during bulkplan.
standingApptCutoffWindow: number (int32)

The cutoff window by which unbooked standing appointments to be released.
statuses: statuses
substitutes: substitutes
timeZoneGid: string

The GID for the time zone of the location. Examples of time zones include America/Curacao and Europe/Monaco.
updateDate: updateDate

Read Only: true

update date
useAppointmentPriority: boolean

Whether or not to consider appointment priority.
useSingleServprovRule: string

This specifies the use of single service provider rule at a location. The options are: null - rule is not used, P - for pickups only, D - for deliveries only, B - for both pickups and deliveries.
yardRowLabels: string

Comma separated list of labels for rows in a yard.
yardSlotLabels: string

Comma separated list of labels for slots in a yard.
zone1: string

The zone where the location fits in.
zone2: string

The zone where the location fits in.
zone3: string

The zone where the location fits in.
zone4: string

The zone where the location fits in.

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

Nested Schema : accessorials

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : addresses

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : addressUpdateDate

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : appointDisplay

The duration of appointment display time period.

Match All

The duration of appointment display time period.

Show Source

object amountType

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

Nested Schema : apptAfterCutoff

Service provider appointment duration after cutoff.

Match All

Service provider appointment duration after cutoff.

Show Source

object amountType

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

Nested Schema : apptBeforeCutoff

Service provider appointment duration before cutoff.

Match All

Service provider appointment duration before cutoff.

Show Source

object amountType

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

Nested Schema : attributeDate1

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate10

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate2

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate3

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate4

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate5

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate6

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate7

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate8

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate9

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : capacityGroups

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : contacts

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : corporations

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : documents

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : loadUnloadPoints

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : operationalLocations

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : refnums

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : remarks

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : resourceGroups

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : resourceTypes

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : roleProfiles

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : servprovPrefs

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : slotTimeInterval

The smallest appointment slot interval for the location.

Match All

The smallest appointment slot interval for the location.

Show Source

object amountType

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

Nested Schema : specialServices

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : statuses

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : substitutes

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.accessorials

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.accessorials

Type: object

Show Source

accessorialCodeGid: string

The GID for the accessorial code for the location.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.addresses

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.addresses

Type: object

Show Source

addressLine: string

Address line data.
domainName: string

Database domain where this data is stored.
lineSequence: number (int64)

The line sequence number for the address line.
links: array links

Read Only: true

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence number for the address line.",
            "type":"number",
            "format":"int64"
        },
        "addressLine":{
            "description":"Address line data.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.capacityGroups

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.capacityGroups

Type: object

Show Source

domainName: string

Database domain where this data is stored.
effectiveDate: effectiveDate

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

Expiration date for the location capacity group assigned to the location.
links: array links

Read Only: true
locCapacityGroupGid: string

The GID for the location capacity group for this location.

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

Nested Schema : effectiveDate

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : expirationDate

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.contacts

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.contacts

Type: object

Show Source

alternateName: string

If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
attribute1: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute10: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute11: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute12: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute13: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute14: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute15: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute16: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute17: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute18: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute19: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute2: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute20: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute3: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute4: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute5: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute6: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute7: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute8: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute9: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attributeDate1: attributeDate1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber10: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber11: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber12: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber13: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber14: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber15: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber16: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber17: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber18: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber19: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber2: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber20: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
attributeNumber3: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber4: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber5: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber6: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber7: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber8: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber9: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
cellPhone: string

Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
comMethods: comMethods
companyName: string

Company name for this party.
consolidatedNotifyOnly: boolean

Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
consolidationProfileGid: string

The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
contactGid: string

The GID for the contact for the location.
contactPreferences: contactPreferences
contactType: string

Defines whether a contact is a person or group.
contactXid: string

The XID for the contact for the location.
description: string

Enter any additional descriptive information for this party/contact.
domainName: string

Database domain where this data is stored.
ecmUser: string

If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
emailAddress: string

The email address of the contact person for the location.
externalSystemGid: string

The external system GID.
fax: string

The facsimile number for the contact person for the location.
firstName: string

The given name of the contact person for the location.
fromAddrContact: fromAddrContact

Read Only: true

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

The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
glUserGid: string

The GL user GID.
groupSavedQueryGid: string

Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
indicator: string

Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
ippPrinterGid: string

Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
isBroadcast: boolean

Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
isEmailVirusProtected: boolean

If Y, document attachments may be sent to the contact without virus checking.
isFromAddress: boolean

Indicates if a contact is a 'From-Address' contact.
isNotificationOn: boolean

No notification will be sent to the contact if this field is set to false ('N').
isPrimaryContact: boolean

Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.
jobTitle: string

The title for the contact person at the location.
languageSpoken: string

The language the contact person at the location speaks.
lastName: string

The surname of the contact person for the location.
links: array links

Read Only: true
location: location

Read Only: true

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

The GID for the location.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
messageProfileGid: string

The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
middleName: string

The middle name of the contact.
nameAddressUpdateDate: nameAddressUpdateDate

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

Text describing something regarding the contact person for the location or the location itself.
phone1: string

The primary telephone number for the location's contact person.
phone2: string

The secondary telephone number for the location's contact person.
recipientDomainName: string

The domain of a message recipient.
routeThroughLocation: boolean

Indicates if the notification should use location.
sendAsMessage: boolean

Indicates that messages should be sent to message center.
telex: string

The telephone number for telex communications for the location's contact person.
timeZoneGid: string

Time zone for the contact.
userDefined1IconGid: string

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

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

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

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

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

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

Nested Schema : attributeDate1

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate10

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate11

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate12

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate13

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate14

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate15

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate16

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate17

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate18

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate19

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate2

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate20

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate3

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate4

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate5

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate6

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate7

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate8

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate9

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : comMethods

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : contactPreferences

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : fromAddrContact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : location

Read Only: true

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

Match All

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

Show Source

object locations

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

Nested Schema : nameAddressUpdateDate

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.contacts.comMethods

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.contacts.comMethods

Type: object

Show Source

calendarGid: string

The calendar GID.
comMethodGid: string

The communication method GID.
comMethodRank: number (int32)

A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
domainName: string

Database domain where this data is stored.
expectedResponseTime: expectedResponseTime

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

Read Only: true

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

Nested Schema : expectedResponseTime

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

Match All

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

Show Source

object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.contacts.contactPreferences

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.contacts.contactPreferences

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
preferenceGid: string

The preference GID.
value: string

The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.corporations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.corporations

Type: object

Show Source

corporation: corporation

Read Only: true

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

CORPORATION_GID contains the unique identifier for the location's corporation.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
domainName: string

No description.
links: array links

Read Only: true

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

Nested Schema : corporation

Read Only: true

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

Match All

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

Show Source

object corporations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.documents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.documents

Type: object

Show Source

contentManagementSystemGid: string

No description.
documentCmsId: string

A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
documentDefGid: string

No description.
documentFilename: string

No description.
documentGid: string

No description.
documentMimeType: string

No description.
documentTrackingNum: string

No description.
documentType: string

No description.
documentUrl: string

No description.
documentXid: string

No description.
domainName: string

No description.
effectiveDate: effectiveDate

represents effective date for a document
expirationDate: expirationDate

Represents expiration date for a document.
generatedAt: generatedAt

If preparation, date/time content was last generated
links: array links

Read Only: true
ownerDataQueryTypeGid: string

No description.
relatedDocument: relatedDocument

Read Only: true

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

Represents the related document for consolidated/linked documents.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
reportGid: string

The report associated with the document attachment, if content was generated by the report subsystem.
uploadedAt: uploadedAt

If attachment, date/time content was last updated
usedAs: string

Represents the classification of a document.(C/I/L/T)
userDefined1IconGid: string

No description.
userDefined2IconGid: string

No description.
userDefined3IconGid: string

No description.
userDefined4IconGid: string

No description.
userDefined5IconGid: string

No description.

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

object dateType

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

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

object dateType

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

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : relatedDocument

Read Only: true

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

Match All

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

Show Source

object documents

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

object dateTimeType

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.loadUnloadPoints

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.loadUnloadPoints

Type: object

Show Source

description: string

Description for the load/unload point.
domainName: string

Database domain where this data is stored.
equipmentGroupProfileGid: string

Equipment group profile for the load/unload point; overrides any at the location.
isLoad: boolean

Indicates if this dock or point make be used for loading.
isUnload: boolean

Indicates if this dock or point make be used for loading.
links: array links

Read Only: true
loadSequence: number (int32)

Indicates where dock should be in a load sequence.
loadUnloadPoint: string

Load/unload point such as a loading dock.
unloadSequence: number (int32)

Indicates where dock should be in an unload sequence.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.operationalLocations

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.operationalLocations

Type: object

Show Source

details: details
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
operationalLocation: operationalLocation

Read Only: true

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

Sub location belonging to a main location. Sub location may only belong to one location.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

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

Nested Schema : details

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : operationalLocation

Read Only: true

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

Match All

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

Show Source

object locations

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.operationalLocations.details

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.operationalLocations.details

Type: object

Show Source

domainName: string

Database domain where this data is stored.
exclusionRegionGid: string

If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.
inboundOutboundType: string

Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).
inclusionRegionGid: string

If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.
links: array links

Read Only: true
primaryLegLocProfileGid: string

The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.
primaryLegServprov: primaryLegServprov

Read Only: true

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

The service provider of the main leg which will help indicate which operational location applies.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
seqNo: number (int64)

Sequence to allow multiple data records for the same operational location.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : primaryLegServprov

Read Only: true

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

Match All

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

Show Source

object schema

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

Nested Schema : schema

Type: object

Show Source

aliases: aliases
allocationRuleProfileGid: string

The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
allowSgTender: boolean

Ship group allow tender determines whether the system can automatically tender ship group to this service provider.By default it is set to 'N'
allowSpotRating: boolean

Flag to indicate that service provider is valid for Spot Rating actions
allowTender: boolean

Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.
Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.
attribute1: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute10: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute11: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute12: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute13: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute14: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute15: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute16: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute17: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute18: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute19: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute2: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute20: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute3: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute4: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute5: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute6: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute7: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute8: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attribute9: string

Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
attributeDate1: attributeDate1

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

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

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

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

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

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

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

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

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

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

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber10: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber2: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber3: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber4: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber5: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber6: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber7: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber8: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
attributeNumber9: number (double)

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
autoApproveRuleProfileGid: string

The GID for the auto approve rule profile.
autoPaymentFlag: boolean

Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.
broadcastSpotContact: broadcastSpotContact

Read Only: true

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

Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
doConditionalAccepts: boolean

Determines if the service provider can participate in conditional booking.
documents: documents
domainName: string

Database domain where this data is stored.
epaIndexValue: number (double)

If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.
equipmentMarkListGid: string

The Equipment Mark List for this Service Provider.
incumbent: boolean

Select the Incumbent check box to indicate that this service provider has been used previously.
insertDate: insertDate

Read Only: true

insert date
invoicingProcess: string

The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.
isAcceptBroadcastTenders: boolean

Is set to Y(es) if the service provider will participate in broadcast tendering.
isAcceptBySsuAllowed: boolean

Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.
isAcceptSpotBids: boolean

Is set to Y(es) if the service provider will participate in spot bid tendering.
isActive: boolean

This flag will define whether service provider is active or not.By default this flag will be Y.
isCopyInvDeltaBackToShip: boolean

The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.
isDispatchByRegion: boolean

A flag to turn on/off the Tender by Locale feature.
isFleet: boolean

Only shipments created for fleet service providers can perform fleet related actions.
isInternalNvocc: boolean

The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job.
isLocalizeBroadcastContact: boolean

If "Y", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.
isMinority: boolean

Select the Minority check box if the business is minority-owned.
lineApproveTolProfileGid: string

Indicates the line approval tolerance rule profile to apply.
links: array links

Read Only: true
matchRuleProfileGid: string

The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.
matchValidRuleProfileGid: string

A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.
modeProfileGid: string

A GID to define the mode profiles(group) that the service provider uses.
nvoccDomainName: string

The NVOCC Domain field determines the domain in which the buy shipments and new job are created.
obtXmlProfileGid: string

Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.
outXmlProfileGid: string

Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.
rateServiceGid: string

Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment
scacGid: string

The Standard Carrier Alpha Code for this Service Provider.
scorecardValue: number (double)

If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.
servprovGid: string

The service provider GID.
servprovLocation: servprovLocation

The primary location for the service provider.
servprovXid: string

The service provider XID.
sgTenderOutXmlProfileGid: string

Associates the service provider with an out_xml_profile, which helps define the content of outgoing ship group tender XML to this service provider.
sourcingContact: sourcingContact

Read Only: true

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

The GID for the contact at the service provider who is responsible for sourcing activities.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
spotRateAdjustmentFactor: number (double)

Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.
tenderResponseTime: tenderResponseTime

The expected response time by this service provider for shipment tenders.
tier: number (double)

Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.
updateDate: updateDate

Read Only: true

update date

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

Nested Schema : aliases

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : attributeDate1

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate10

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate2

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate3

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate4

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate5

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate6

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate7

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate8

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : attributeDate9

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

Match All

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

Show Source

object dateTimeType

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

Nested Schema : broadcastSpotContact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : documents

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : servprovLocation

The primary location for the service provider.

Match All

The primary location for the service provider.

Show Source

object locations

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

Nested Schema : sourcingContact

Read Only: true

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

Match All

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

Show Source

object tradeParties

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

Nested Schema : tenderResponseTime

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

Match All

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

Show Source

object amountType

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

object dateType

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

Nested Schema : items

Type: array

Show Source

Array of: object schema

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : schema

Type: object

Show Source

alias: string

Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider. Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
servprovAliasQualGid: string

The GID for the service provider alias qualifier.

{
    "properties":{
        "servprovAliasQualGid":{
            "description":"The GID for the service provider alias qualifier.",
            "type":"string"
        },
        "alias":{
            "description":"Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider.  Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object serviceProviders.documents

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : serviceProviders.documents

Type: object

Show Source

contentManagementSystemGid: string

No description.
documentCmsId: string

A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
documentDefGid: string

No description.
documentFilename: string

No description.
documentGid: string

No description.
documentMimeType: string

No description.
documentTrackingNum: string

No description.
documentType: string

No description.
documentUrl: string

No description.
documentXid: string

No description.
domainName: string

No description.
effectiveDate: effectiveDate

represents effective date for a document
expirationDate: expirationDate

Represents expiration date for a document.
generatedAt: generatedAt

If preparation, date/time content was last generated
links: array links

Read Only: true
ownerDataQueryTypeGid: string

No description.
relatedDocument: relatedDocument

Read Only: true

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

Represents the related document for consolidated/linked documents.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
reportGid: string

The report associated with the document attachment, if content was generated by the report subsystem.
uploadedAt: uploadedAt

If attachment, date/time content was last updated
usedAs: string

Represents the classification of a document.(C/I/L/T)
userDefined1IconGid: string

No description.
userDefined2IconGid: string

No description.
userDefined3IconGid: string

No description.
userDefined4IconGid: string

No description.
userDefined5IconGid: string

No description.

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

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

object dateType

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

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

object dateType

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

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : relatedDocument

Read Only: true

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

Match All

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

Show Source

object documents

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

object dateTimeType

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.refnums

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.refnums

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
locationRefnumQualGid: string

The GID for the location reference number qualifier.
locationRefnumValue: string

The value associated with the location reference number qualifier.

{
    "properties":{
        "locationRefnumQualGid":{
            "description":"The GID for the location reference number qualifier.",
            "type":"string"
        },
        "locationRefnumValue":{
            "description":"The value associated with the location reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.remarks

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.remarks

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
remarkQualGid: string

The GID for the remark qualifier for the location.
remarkSequence: number (int64)

The sequence number for the remark for this location.
remarkText: string

The text of the remark for the location.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.resourceGroups

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceGroups

Type: object

Show Source

calendarGid: string

The calendar GID that will be applied to the location of the location resource group.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
locationResourceGroupGid: string

The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.
preferenceLevel: number (int32)

Used to get preference level of location resource group for Appointment scheduling

{
    "properties":{
        "locationResourceGroupGid":{
            "description":"The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID that will be applied to the location of the location resource group.",
            "type":"string"
        },
        "preferenceLevel":{
            "description":"Used to get preference level of location resource group for Appointment scheduling",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.resourceTypes

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceTypes

Type: object

Show Source

autoScheduleAppointment: boolean

Indicate whether appointment should be automatically scheduled for the resource type.
calendarGid: string

The calendar GID that applies to the location resource type.
constraintAppointment: boolean

Whether the location resource type constraints scheduling appointments.
description: string

The description of the location resource type.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
resources: resources
resourceTypeGid: string

Resource Type GID for the location.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : resources

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.resourceTypes.resources

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceTypes.resources

Type: object

Show Source

appointmentActivityType: string

Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.
apptRuleSets: apptRuleSets
calendarGid: string

The calendar GID that will be applied to the resource.
contactProfileGid: string

The contact profile GID.
description: string

The description of the resource.
domainName: string

Database domain where this data is stored.
equipmentGroupProfileGid: string

The equipment group profile ID that associates to the location resource.
flexCommodityCheckOption: string

Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.
flexCommodityProfileGid: string

The flex commodity profile ID that associates to the location resource.
links: array links

Read Only: true
locationResourceGid: string

The location resource GID.
locationResourceGroupGid: string

The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.
locationResourceName: string

The name of the resource.
locationResourceXid: string

The XID of the location resource.
modeProfileGid: string

The mode profile ID that associates to the location resource.
preferenceLevel: number (int32)

Gets the preference level of resource for Appointment scheduling
servprovProfileGid: string

The service provider profile ID that associates to the location resource.

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

Nested Schema : apptRuleSets

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.resourceTypes.resources.apptRuleSets

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceTypes.resources.apptRuleSets

Type: object

Show Source

apptRuleSetGid: string

The GID for the appointment rule set.
domainName: string

Database domain where this data is stored.
flexFields: flexFields
links: array links

Read Only: true
refnums: refnums

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

Nested Schema : flexFields

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : refnums

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : items

Type: array

Show Source

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields

Type: object

Show Source

domainName: string

Database domain where this data is stored.
flexFieldName: string

Flex field name
flexFieldValue: string

Flex field value.
isCompatible: boolean

If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.
links: array links

Read Only: true

{
    "properties":{
        "flexFieldName":{
            "description":"Flex field name",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFieldValue":{
            "description":"Flex field value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.<br>If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.resourceTypes.resources.apptRuleSets.refnums

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums

Type: object

Show Source

apptRefnumQualGid: string

The appointment reference number qualifier. The qualifier related to shipment is used.
apptRefnumValue: string

The appointment reference number value.
domainName: string

Database domain where this data is stored.
isCompatible: boolean

If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.
For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.
Shipment Reference Number Qualifier and Value
Appointment Rule Set Reference Number Qualifier and Value
Q1 V1 Q1 V1, selected
Q2 V2 Q2 V2, selected
Q3 V3
Q4 V4
In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.
To define shipment reference numbers constraints, enter or select the following fields, which are optional:
Reference Number Qualifier ID.
Reference Number.
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles

Type: object

Show Source

activityTimeDefs: activityTimeDefs
calendarGid: string

The GID for the calendar used for the location role profile.
calendars: calendars
createPoolHandlingShipment: boolean

Creates pool handling shipments.
createXdockHandlingShipment: boolean

Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.
Fixed Handling Time: Same as above.
The Variable Handling Time and the Variable Handling Weight: Same as above.
Max Freight Idle Time: Same as above.
domainName: string

Database domain where this data is stored.
fixedHandlingTime: fixedHandlingTime

Fixed amount of time. No matter the size of the shipment required for handling.
handlings: handlings
isAllowMixedFreight: boolean

Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.
links: array links

Read Only: true
locationRoleGid: string

The GID for the location role.
maxFreightIdleTime: maxFreightIdleTime

Maximum time freight can sit idle at the cross-dock.
pctActivityAfterLocClose: number (double)

This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100 100. when null, treat as for location role shipping receiving< div>
pctActivityBeforeLocOpen: number (double)

This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 0 100. when it is null, treat as for location role shipping receiving< div>
thuCapacities: thuCapacities
thuProfileGid: string

The GID for the transport profile.
To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details.
varHandlingTime: varHandlingTime

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

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

The planning handling cost volume at this location.
varHndcstVolCost: varHndcstVolCost

The variable handling cost per volume at this location.
varHndcstWgt: varHndcstWgt

The planning handling cost weight at this location.
varHndcstWgtCost: varHndcstWgtCost

Variable Handling Cost Per Weight at this location.
xDockIsInboundBias: boolean

The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.

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

Nested Schema : activityTimeDefs

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : calendars

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : fixedHandlingTime

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

Match All

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

Show Source

object amountType

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

Nested Schema : handlings

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : maxFreightIdleTime

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

Match All

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

Show Source

object amountType

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

Nested Schema : thuCapacities

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : varHandlingTime

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

Match All

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

Show Source

object amountType

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

Nested Schema : varHandlingWeight

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

Match All

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

Show Source

object amountType

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

Nested Schema : varHndcstVol

The planning handling cost volume at this location.

Match All

The planning handling cost volume at this location.

Show Source

object amountType

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

Nested Schema : varHndcstVolCost

The variable handling cost per volume at this location.

Match All

The variable handling cost per volume at this location.

Show Source

object currencyType

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

Nested Schema : varHndcstWgt

The planning handling cost weight at this location.

Match All

The planning handling cost weight at this location.

Show Source

object amountType

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

Nested Schema : varHndcstWgtCost

Variable Handling Cost Per Weight at this location.

Match All

Variable Handling Cost Per Weight at this location.

Show Source

object currencyType

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles.activityTimeDefs

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles.activityTimeDefs

Type: object

Show Source

activityTimeDefGid: string

The GID for the activity time definition for this location and location role combination.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

{
    "properties":{
        "activityTimeDefGid":{
            "description":"The GID for the activity time definition for this location and location role combination.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles.calendars

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles.calendars

Type: object

Show Source

calendarGid: string

The GID for the calendar entry associated with each row of the location role profile calendar entry.
domainName: string

Database domain where this data is stored.
flexCommodityProfileGid: string

The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
inboundLocationProfileGid: string

The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
links: array links

Read Only: true
locationRoleProfCalSeq: number (int32)

The internal sequence number for the location role profile calendar combination.
modeProfileGid: string

The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
outboundLocationProfileGid: string

The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.

{
    "properties":{
        "locationRoleProfCalSeq":{
            "description":"The internal sequence number for the location role profile calendar combination.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.",
            "type":"string"
        },
        "inboundLocationProfileGid":{
            "description":"The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.",
            "type":"string"
        },
        "outboundLocationProfileGid":{
            "description":"The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar entry associated with each row of the location role profile calendar entry.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles.handlings

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles.handlings

Type: object

Show Source

destRegionGid: string

The GID for the destination region. Used to match an order to an entry.
domainName: string

Database domain where this data is stored.
fixedHandlingTime: fixedHandlingTime

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

Read Only: true
locationRoleProfHandSeq: number (int32)

Internal key for the 1 to n location role profile handling time entries.
sourceRegionGid: string

The GID for the source region. Used to match an order to an entry.

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

Nested Schema : fixedHandlingTime

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

Match All

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

Show Source

object amountType

{
    "description":"Amount fixed handling time to add. Days, hours, and minutes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles.thuCapacities

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles.thuCapacities

Type: object

Show Source

domainName: string

Database domain where this data is stored.
isFullyLayered: boolean

You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.
Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.
links: array links

Read Only: true
maxHeight: maxHeight

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

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

Value for the maximum volume of the transportation handling unit.
maxWeight: maxWeight

Value for the maximum weight of the transportation handling unit.
maxWidth: maxWidth

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

The GID for the transport handling unit.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : maxHeight

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

Match All

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

Show Source

object amountType

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

Nested Schema : maxLength

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

Match All

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

Show Source

object amountType

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

Nested Schema : maxVolume

Value for the maximum volume of the transportation handling unit.

Match All

Value for the maximum volume of the transportation handling unit.

Show Source

object amountType

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

Nested Schema : maxWeight

Value for the maximum weight of the transportation handling unit.

Match All

Value for the maximum weight of the transportation handling unit.

Show Source

object amountType

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

Nested Schema : maxWidth

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

Match All

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

Show Source

object amountType

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

Nested Schema : pruCapacities

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.roleProfiles.thuCapacities.pruCapacities

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities

Type: object

Show Source

domainName: string

Database domain where this data is stored.
limitPruCount: number (double)

Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.
links: array links

Read Only: true
packagingReferenceUnitGid: string

The GID for the package unit reference unit.
totalPruCount: number (double)

Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.servprovPrefs

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.servprovPrefs

Type: object

Show Source

details: details
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
locationServprovPrefGid: string

The unique identifier of location service provider preference.
locationServprovPrefXid: string

The XID of location service provider preference.
maxSlotsPerDay: number (int32)

The maximum number of slots per day.
serviceLocation: serviceLocation

Read Only: true

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

Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
servprov: servprov

Read Only: true

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

The Service Provider GID.
This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

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

Nested Schema : details

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : serviceLocation

Read Only: true

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

Match All

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

Show Source

object locations

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

Nested Schema : servprov

Read Only: true

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

Match All

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

Show Source

object schema

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.servprovPrefs.details

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.servprovPrefs.details

Type: object

Show Source

begin: number (int32)

The begin time.
dayOfWeek: number (int32)

The day of week.
domainName: string

Database domain where this data is stored.
duration: number (int32)

The duration of the time window.
isStanding: boolean

Indicates if the defined preference is for standing appointment.
links: array links

Read Only: true
locationResourceGid: string

Indicates the resource that preference defined on.
locationServprovPrefDSeq: number (int64)

Sequence with in a particular location service provider preference GID.
maxSlot: number (int32)

The maximum number of slots during this time.
preferenceLevel: number (int32)

The preference level.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.specialServices

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.specialServices

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
specialServiceCodeGid: string

The GID for the special service code for the location.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.statuses

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.statuses

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
statusTypeGid: string

Status type for the location status.
statusValueGid: string

Status value for the status type.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object locations.substitutes

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : locations.substitutes

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
substituteLocationGid: string

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.partyCodes

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.partyCodes

Type: object

Show Source

domainName: string

Database domain where this data is stored.
gtmCode: string

The code is related to the type which is related to the user defined party classification.
gtmTypeGid: string

The GID for the type related to the user defined party classification.
links: array links

Read Only: true

{
    "properties":{
        "gtmTypeGid":{
            "description":"The GID for the type related to the user defined party classification.",
            "type":"string"
        },
        "gtmCode":{
            "description":"The code is related to the type which is related to the user defined party classification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.partyScreenings

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.partyScreenings

Type: object

Show Source

approvedBy: string

Approver for matches requiring review.
domainName: string

Database domain where this data is stored.
gtmDeniedPartyGid: string

The GID for the denied party.
gtmServicePrefGid: string

The unique GID for the service preference used for screening.
links: array links

Read Only: true
matchFactor: number (int32)

Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.
partyScreeningComments: partyScreeningComments
partyScreeningSequence: number (int64)

Sequence number for potential matches.
screeningStatus: string

Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened. Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user. Not a Match
- No similarity exists between the restricted party list and the contact being screened. Escalated -
The potential match was referred to another person for review.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : partyScreeningComments

Type: object

Show Source

items: array items
links: array links

Read Only: true

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.partyScreenings.partyScreeningComments

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.partyScreenings.partyScreeningComments

Type: object

Show Source

commentBy: string

User entering the comment.
commentText: string

Text related to comment.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
partyCommentSequence: number (int64)

Sequence number for potential matches comment.

{
    "properties":{
        "partyCommentSequence":{
            "description":"Sequence number for potential matches comment.",
            "type":"number",
            "format":"int64"
        },
        "commentText":{
            "description":"Text related to comment.",
            "type":"string"
        },
        "commentBy":{
            "description":"User entering the comment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.preferences

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.preferences

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
preferenceGid: string

The preference GID.
value: string

The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.refnums

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.refnums

Type: object

Show Source

domainName: string

Database domain where this data is stored.
gtmPartyRefnumQualGid: string

The GID for the party reference number qualifier.
links: array links

Read Only: true
refnumValue: string

The value for the reference number.

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.remarks

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : tradeParties.remarks

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
remarkQualGid: string

The unique GID for the remark qualifier.
remarkSeqNo: number (int64)

Sequence number for remark. Not visible in the UI.
remarkText: string

Remark text.

{
    "properties":{
        "remarkSeqNo":{
            "description":"Sequence number for remark. Not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The unique GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

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

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.sanctionedScreenings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeParties.sanctionedScreenings

Type: object

Show Source

complianceRuleGid: string

The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.
complianceRuleGroupGid: string

The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.
controlCode: string

The control type and control code are linked to the compliance rule.
controlTypeGid: string

The GID for the GTM control type. The control type is linked to the compliance rule.
domainName: string

Database domain where this data is stored.
gtmContactStScreenGid: string

The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
gtmContactStScreenXid: string

The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
links: array links

Read Only: true
regulationReferenceGid: string

The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.

{
    "properties":{
        "gtmContactStScreenGid":{
            "description":"The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "controlTypeGid":{
            "description":"The GID for the GTM control type. The control type is linked to the compliance rule.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control type and control code are linked to the compliance rule.",
            "type":"string"
        },
        "regulationReferenceGid":{
            "description":"The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.",
            "type":"string"
        },
        "gtmContactStScreenXid":{
            "description":"The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "complianceRuleGroupGid":{
            "description":"The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.",
            "type":"string"
        },
        "complianceRuleGid":{
            "description":"The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object tradeParties.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeParties.statuses

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
statusTypeGid: string

Status type for the contact status.
statusValueGid: string

Value of status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the contact status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.nmfcCodeSubstitutes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.nmfcCodeSubstitutes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.nmfcCodeSubstitutes

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
nmfcHigh: number (double)

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.
nmfcLow: number (double)

Low National Motor Freight Classification value used for defining a rate as classification record.
rateAsNmfcClass: number (double)

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.
rateGeoGid: string

The GID for the related rate geo for the rate as table of values.
roNmfccsSeqNum: number (int64)

Internal sequence number for different row entries.

{
    "properties":{
        "roNmfccsSeqNum":{
            "description":"Internal sequence number for different row entries.",
            "type":"number",
            "format":"int64"
        },
        "nmfcLow":{
            "description":"Low National Motor Freight Classification value used for defining a rate as classification record.",
            "type":"number",
            "format":"double"
        },
        "nmfcHigh":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "rateAsNmfcClass":{
            "description":"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.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the related rate geo for the rate as table of values.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.rateRulesAndTerms

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.rateRulesAndTerms"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.rateRulesAndTerms

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
ruleDesc: string

Provides a place to store the description of the rule. For example, "Freight that is undeliverable due to error or omission on the part of the shipper, consignee, or owner or for which no disposition instructions have been provided shall be considered unclaimed/abandoned."
ruleNumber: string

Rules and Terms is used to store information about the rate offering. The rule number or rule/term identifies the rule being defined. For example, "Rule 921".
ruleTitle: string

Rule title provides a brief description of the rule being defined. For example, "UNCLAIMED/ABANDONED FREIGHT"

{
    "properties":{
        "ruleNumber":{
            "description":"Rules and Terms is used to store information about the rate offering. The rule number or rule/term identifies the rule being defined. For example, \"Rule 921\".",
            "type":"string"
        },
        "ruleTitle":{
            "description":"Rule title provides a brief description of the rule being defined. For example, \"UNCLAIMED/ABANDONED FREIGHT\" ",
            "type":"string"
        },
        "ruleDesc":{
            "description":"Provides a place to store the description of the rule. For example, \"Freight that is undeliverable due to error or omission on the part of the shipper, consignee, or owner or for which no disposition instructions have been provided shall be considered unclaimed/abandoned.\"",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.remarks

Type: object

Show Source

domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
remarkQualGid: string

Qualifier for rate offering remark.
remarkSequence: number (double)

Sequence to allow multiple remarks for a rate offering.
remarkText: string

Actual remark text for rate offering remark.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence to allow multiple remarks for a rate offering.",
            "type":"number",
            "format":"double"
        },
        "remarkQualGid":{
            "description":"Qualifier for rate offering remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"Actual remark text for rate offering remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.smcDiscounts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.smcDiscounts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.smcDiscounts

Type: object

Show Source

domainName: string

Database domain where this data is stored.
l5cDiscount: number (double)

Percent discount for weights <= 500 lb.< div>
links: array links

Read Only: true
m10mDiscount: number (double)

Percent discount for weight > 10,000 lb.
m1mDiscount: number (double)

Percent discount for weight > 1000 lb.
m20mDiscount: number (double)

Percent discount for weight > 20,000 lb.
m2mDiscount: number (double)

Percent discount for weight > 2000 lb.
m30mDiscount: number (double)

Percent discount for weight > 30,000 lb.
m40mDiscount: number (double)

Percent discount for weight > 40,000 lb.
m5cDiscount: number (double)

Percent discount for weight > 500 lb.
m5mDiscount: number (double)

Percent discount for weight > 5000 lb.
minDiscount: number (double)

Percent for minimum cost.
movementType: string

Qualifies the usage of the discounts defined by SMC/Carrier Connect Movement Type.
If null, then the discounts provided (by weight break) apply to all Movement Types. Otherwise - the discounts defined apply to the specified Movement Type - either Direct, Indirect, Partner or Custom.
rateGeoGid: string

The GID for the rate record related to the SMC discount as table of values.
smcDiscSeqNum: number (int64)

An internal sequence number for the different SMC discount entries provided by movement type.
stopAlternationBreak: string

Specifies the weight break where the deficit rating should stop.

{
    "properties":{
        "smcDiscSeqNum":{
            "description":"An internal sequence number for the different SMC discount entries provided by movement type.",
            "type":"number",
            "format":"int64"
        },
        "minDiscount":{
            "description":"Percent for minimum cost.",
            "type":"number",
            "format":"double"
        },
        "l5cDiscount":{
            "description":"Percent discount for weights <= 500 lb.",
            "type":"number",
            "format":"double"
        },
        "m5cDiscount":{
            "description":"Percent discount for weight > 500 lb.",
            "type":"number",
            "format":"double"
        },
        "m1mDiscount":{
            "description":"Percent discount for weight > 1000 lb.",
            "type":"number",
            "format":"double"
        },
        "m2mDiscount":{
            "description":"Percent discount for weight > 2000 lb.",
            "type":"number",
            "format":"double"
        },
        "m5mDiscount":{
            "description":"Percent discount for weight > 5000 lb.",
            "type":"number",
            "format":"double"
        },
        "m10mDiscount":{
            "description":"Percent discount for weight > 10,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m20mDiscount":{
            "description":"Percent discount for weight > 20,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m30mDiscount":{
            "description":"Percent discount for weight > 30,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m40mDiscount":{
            "description":"Percent discount for weight > 40,000 lb.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the  rate record related to the SMC discount as table of values.",
            "type":"string"
        },
        "stopAlternationBreak":{
            "description":"Specifies the weight break where the deficit rating should stop. ",
            "type":"string"
        },
        "movementType":{
            "description":"Qualifies the usage of the discounts defined by SMC/Carrier Connect Movement Type.<br>If null, then the discounts provided (by weight break) apply to all Movement Types.  Otherwise - the discounts defined apply to the specified Movement Type - either Direct, Indirect, Partner or Custom.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.specialServices

Type: object

Show Source

accessorials: accessorials
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true
specialServiceCodeGid: string

The GID for the special service code.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The GID for the special service code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateOfferings.specialServices.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

items: array items
links: array links

Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateOfferings.specialServices.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.specialServices.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.specialServices.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.specialServices.accessorials

Type: object

Show Source

accessorialCodeGid: string

The GID for the accessorial code.
accessorialCostGid: string

The GID for the accessorial cost.
domainName: string

Database domain where this data is stored.
links: array links

Read Only: true

{
    "properties":{
        "accessorialCostGid":{
            "description":"The GID for the accessorial cost.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

Array of: object rateOfferings.stopRates

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateOfferings.stopRates"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateOfferings.stopRates

Type: object

Show Source

domainName: string

Database domain where this data is stored.
highStop: number (int32)

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: array links

Read Only: true
lowStop: number (int32)

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: perStopCost

The per stop charge for the low high range being defined.

{
    "properties":{
        "lowStop":{
            "description":"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.<br>The low stop fields defines the low end of the range for stop off charges.<br>",
            "type":"number",
            "format":"int32"
        },
        "highStop":{
            "description":"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.<br>The high stop field defines the high end of the range for stop off charges.<br>",
            "type":"number",
            "format":"int32"
        },
        "perStopCost":{
            "description":"The per stop charge for the low high range being defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : 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

object currencyType

{
    "description":"The per stop charge for the low high range being defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Get a Rate Offering

Request

Response

Default Response