Create a Service Provider
post
/serviceProviders
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Root Schema : schema
Type:
Show Source
object
-
aliases:
aliases
-
allocationRuleProfileGid: string
The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
-
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.
-
broadcastSpotContactGid: string
Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
-
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.
-
sourcingContactGid: string
The GID for the contact at the service provider who is responsible for sourcing activities.
-
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
Nested Schema : aliases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : servprovLocation
The primary location for the service provider.
Match All
Show Source
Nested Schema : tenderResponseTime
The expected response time by this service provider for shipment tenders.
Match All
Show Source
Nested Schema : serviceProviders.aliases
Type:
Show Source
object
-
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.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : serviceProviders.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
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.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : locations
Type:
Show Source
object
-
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
-
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
-
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.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : addresses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
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
Show Source
Nested Schema : appointDisplay
The duration of appointment display time period.
Match All
Show Source
Nested Schema : apptAfterCutoff
Service provider appointment duration after cutoff.
Match All
Show Source
Nested Schema : apptBeforeCutoff
Service provider appointment duration before cutoff.
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : capacityGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contacts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : corporations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : loadUnloadPoints
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : operationalLocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : resourceGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : resourceTypes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : roleProfiles
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : servprovPrefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : slotTimeInterval
The smallest appointment slot interval for the location.
Match All
Show Source
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : substitutes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.accessorials
Type:
Show Source
object
-
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
Nested Schema : locations.addresses
Type:
Show Source
object
-
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
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : locations.capacityGroups
Type:
Show Source
object
-
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.
Nested Schema : effectiveDate
Effective date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : expirationDate
Expiration date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : locations.contacts
Type:
Show Source
object
-
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.
-
fromAddrContactGid: string
The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
-
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
-
locationGid: string
The GID for the location.
-
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.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : comMethods
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contactPreferences
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
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
Show Source
Nested Schema : locations.contacts.comMethods
Type:
Show Source
object
-
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
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
Show Source
Nested Schema : locations.contacts.contactPreferences
Type:
Show Source
object
-
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.
Nested Schema : locations.corporations
Type:
Show Source
object
-
corporationGid: string
CORPORATION_GID contains the unique identifier for the location's corporation.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : locations.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
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.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : locations.loadUnloadPoints
Type:
Show Source
object
-
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.
Nested Schema : locations.operationalLocations
Type:
Show Source
object
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
operationalLocationGid: string
Sub location belonging to a main location. Sub location may only belong to one location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.operationalLocations.details
Type:
Show Source
object
-
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.
-
primaryLegServprovGid: string
The service provider of the main leg which will help indicate which operational location applies.
-
seqNo: number
(int64)
Sequence to allow multiple data records for the same operational location.
Nested Schema : locations.refnums
Type:
Show Source
object
-
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.
Nested Schema : locations.remarks
Type:
Show Source
object
-
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.
Nested Schema : locations.resourceGroups
Type:
Show Source
object
-
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
Nested Schema : locations.resourceTypes
Type:
Show Source
object
-
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.
Nested Schema : resources
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources
Type:
Show Source
object
-
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.
Nested Schema : apptRuleSets
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets
Type:
Show Source
object
-
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
Nested Schema : flexFields
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields
Type:
Show Source
object
-
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
Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums
Type:
Show Source
object
-
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
Nested Schema : locations.roleProfiles
Type:
Show Source
object
-
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.
Nested Schema : activityTimeDefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : calendars
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : fixedHandlingTime
Fixed amount of time. No matter the size of the shipment required for handling.
Match All
Show Source
Nested Schema : handlings
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : maxFreightIdleTime
Maximum time freight can sit idle at the cross-dock.
Match All
Show Source
Nested Schema : thuCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : varHandlingTime
Amount of time required to handle the amount of weight defined by the variable handling weight value.
Match All
Show Source
Nested Schema : varHandlingWeight
Variable handling time weight defines rate of handling defined by weight.
Match All
Show Source
Nested Schema : varHndcstVol
The planning handling cost volume at this location.
Match All
Show Source
Nested Schema : varHndcstVolCost
The variable handling cost per volume at this location.
Match All
Show Source
Nested Schema : varHndcstWgt
The planning handling cost weight at this location.
Match All
Show Source
Nested Schema : varHndcstWgtCost
Variable Handling Cost Per Weight at this location.
Match All
Show Source
Nested Schema : locations.roleProfiles.activityTimeDefs
Type:
Show Source
object
-
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
Nested Schema : locations.roleProfiles.calendars
Type:
Show Source
object
-
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.
Nested Schema : locations.roleProfiles.handlings
Type:
Show Source
object
-
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.
Nested Schema : fixedHandlingTime
Amount fixed handling time to add. Days, hours, and minutes.
Match All
Show Source
Nested Schema : locations.roleProfiles.thuCapacities
Type:
Show Source
object
-
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.
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
Show Source
Nested Schema : maxLength
Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : maxVolume
Value for the maximum volume of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWeight
Value for the maximum weight of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWidth
Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : pruCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities
Type:
Show Source
object
-
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.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : locations.servprovPrefs
Type:
Show Source
object
-
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.
-
serviceLocationGid: string
Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
-
servprovGid: string
The Service Provider GID.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.servprovPrefs.details
Type:
Show Source
object
-
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.
Nested Schema : locations.specialServices
Type:
Show Source
object
-
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.
Nested Schema : locations.statuses
Type:
Show Source
object
-
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.
Nested Schema : locations.substitutes
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
aliases:
aliases
-
allocationRuleProfileGid: string
The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
-
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.
-
broadcastSpotContactGid: string
Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
-
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.
-
sourcingContactGid: string
The GID for the contact at the service provider who is responsible for sourcing activities.
-
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
Nested Schema : aliases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : servprovLocation
The primary location for the service provider.
Match All
Show Source
Nested Schema : tenderResponseTime
The expected response time by this service provider for shipment tenders.
Match All
Show Source
Nested Schema : serviceProviders.aliases
Type:
Show Source
object
-
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.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : serviceProviders.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
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.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : locations
Type:
Show Source
object
-
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
-
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
-
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.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : addresses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
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
Show Source
Nested Schema : appointDisplay
The duration of appointment display time period.
Match All
Show Source
Nested Schema : apptAfterCutoff
Service provider appointment duration after cutoff.
Match All
Show Source
Nested Schema : apptBeforeCutoff
Service provider appointment duration before cutoff.
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : capacityGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contacts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : corporations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : loadUnloadPoints
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : operationalLocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : resourceGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : resourceTypes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : roleProfiles
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : servprovPrefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : slotTimeInterval
The smallest appointment slot interval for the location.
Match All
Show Source
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : substitutes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.accessorials
Type:
Show Source
object
-
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
Nested Schema : locations.addresses
Type:
Show Source
object
-
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
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : locations.capacityGroups
Type:
Show Source
object
-
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.
Nested Schema : effectiveDate
Effective date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : expirationDate
Expiration date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : locations.contacts
Type:
Show Source
object
-
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.
-
fromAddrContactGid: string
The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
-
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
-
locationGid: string
The GID for the location.
-
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.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : comMethods
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contactPreferences
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
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
Show Source
Nested Schema : locations.contacts.comMethods
Type:
Show Source
object
-
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
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
Show Source
Nested Schema : locations.contacts.contactPreferences
Type:
Show Source
object
-
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.
Nested Schema : locations.corporations
Type:
Show Source
object
-
corporationGid: string
CORPORATION_GID contains the unique identifier for the location's corporation.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : locations.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
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.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : locations.loadUnloadPoints
Type:
Show Source
object
-
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.
Nested Schema : locations.operationalLocations
Type:
Show Source
object
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
operationalLocationGid: string
Sub location belonging to a main location. Sub location may only belong to one location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.operationalLocations.details
Type:
Show Source
object
-
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.
-
primaryLegServprovGid: string
The service provider of the main leg which will help indicate which operational location applies.
-
seqNo: number
(int64)
Sequence to allow multiple data records for the same operational location.
Nested Schema : locations.refnums
Type:
Show Source
object
-
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.
Nested Schema : locations.remarks
Type:
Show Source
object
-
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.
Nested Schema : locations.resourceGroups
Type:
Show Source
object
-
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
Nested Schema : locations.resourceTypes
Type:
Show Source
object
-
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.
Nested Schema : resources
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources
Type:
Show Source
object
-
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.
Nested Schema : apptRuleSets
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets
Type:
Show Source
object
-
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
Nested Schema : flexFields
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields
Type:
Show Source
object
-
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
Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums
Type:
Show Source
object
-
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
Nested Schema : locations.roleProfiles
Type:
Show Source
object
-
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.
Nested Schema : activityTimeDefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : calendars
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : fixedHandlingTime
Fixed amount of time. No matter the size of the shipment required for handling.
Match All
Show Source
Nested Schema : handlings
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : maxFreightIdleTime
Maximum time freight can sit idle at the cross-dock.
Match All
Show Source
Nested Schema : thuCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : varHandlingTime
Amount of time required to handle the amount of weight defined by the variable handling weight value.
Match All
Show Source
Nested Schema : varHandlingWeight
Variable handling time weight defines rate of handling defined by weight.
Match All
Show Source
Nested Schema : varHndcstVol
The planning handling cost volume at this location.
Match All
Show Source
Nested Schema : varHndcstVolCost
The variable handling cost per volume at this location.
Match All
Show Source
Nested Schema : varHndcstWgt
The planning handling cost weight at this location.
Match All
Show Source
Nested Schema : varHndcstWgtCost
Variable Handling Cost Per Weight at this location.
Match All
Show Source
Nested Schema : locations.roleProfiles.activityTimeDefs
Type:
Show Source
object
-
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
Nested Schema : locations.roleProfiles.calendars
Type:
Show Source
object
-
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.
Nested Schema : locations.roleProfiles.handlings
Type:
Show Source
object
-
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.
Nested Schema : fixedHandlingTime
Amount fixed handling time to add. Days, hours, and minutes.
Match All
Show Source
Nested Schema : locations.roleProfiles.thuCapacities
Type:
Show Source
object
-
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.
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
Show Source
Nested Schema : maxLength
Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : maxVolume
Value for the maximum volume of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWeight
Value for the maximum weight of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWidth
Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : pruCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities
Type:
Show Source
object
-
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.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : locations.servprovPrefs
Type:
Show Source
object
-
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.
-
serviceLocationGid: string
Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
-
servprovGid: string
The Service Provider GID.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.servprovPrefs.details
Type:
Show Source
object
-
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.
Nested Schema : locations.specialServices
Type:
Show Source
object
-
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.
Nested Schema : locations.statuses
Type:
Show Source
object
-
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.
Nested Schema : locations.substitutes
Type:
Show Source
object
-
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.