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

Get a Service Provider

get

/serviceProviders/{servprovGid}

Request

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
  • aliases
  • The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
  • Flag to indicate that service provider is valid for Spot Rating actions
  • Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.
    Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • The GID for the auto approve rule profile.
  • Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.
  • Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
  • Determines if the service provider can participate in conditional booking.
  • documents
  • Database domain where this data is stored.
  • If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.
  • The Equipment Mark List for this Service Provider.
  • Select the Incumbent check box to indicate that this service provider has been used previously.
  • insertDate
    Read Only: true
    insert date
  • The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.
  • Is set to Y(es) if the service provider will participate in broadcast tendering.
  • Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.
  • Is set to Y(es) if the service provider will participate in spot bid tendering.
  • This flag will define whether service provider is active or not.By default this flag will be Y.
  • The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.
  • A flag to turn on/off the Tender by Locale feature.
  • Only shipments created for fleet service providers can perform fleet related actions.
  • The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job.
  • If "Y", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.
  • Select the Minority check box if the business is minority-owned.
  • Indicates the line approval tolerance rule profile to apply.
  • links
    Read Only: true
  • The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.
  • A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.
  • A GID to define the mode profiles(group) that the service provider uses.
  • The NVOCC Domain field determines the domain in which the buy shipments and new job are created.
  • Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.
  • Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.
  • Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment
  • The Standard Carrier Alpha Code for this Service Provider.
  • If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.
  • The service provider GID.
  • servprovLocation
    The primary location for the service provider.
  • The service provider XID.
  • The GID for the contact at the service provider who is responsible for sourcing activities.
  • Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.
  • tenderResponseTime
    The expected response time by this service provider for shipment tenders.
  • Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.
  • updateDate
    Read Only: true
    update date
Nested Schema : aliases
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
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: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
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 : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : serviceProviders.aliases
Type: object
Show Source
  • Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider. Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.
  • Database domain where this data is stored.
  • links
  • The GID for the service provider alias qualifier.
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : serviceProviders.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : locations
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
Nested Schema : addresses
Type: object
Show Source
Nested Schema : addressUpdateDate
Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.
Match All
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: object
Show Source
Nested Schema : contacts
Type: object
Show Source
Nested Schema : corporations
Type: object
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : loadUnloadPoints
Type: object
Show Source
Nested Schema : operationalLocations
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : resourceGroups
Type: object
Show Source
Nested Schema : resourceTypes
Type: object
Show Source
Nested Schema : roleProfiles
Type: object
Show Source
Nested Schema : servprovPrefs
Type: object
Show Source
Nested Schema : slotTimeInterval
The smallest appointment slot interval for the location.
Match All
Show Source
Nested Schema : specialServices
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : substitutes
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.addresses
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.capacityGroups
Type: object
Show Source
Nested Schema : effectiveDate
Effective date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : expirationDate
Expiration date for the location capacity group assigned to the location.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts
Type: object
Show Source
  • If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
    Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate11
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate12
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate13
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate14
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate15
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate16
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate17
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate18
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate19
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate20
    Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
  • comMethods
  • Company name for this party.
  • Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
  • The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
  • The GID for the contact for the location.
  • contactPreferences
  • Defines whether a contact is a person or group.
  • The XID for the contact for the location.
  • Enter any additional descriptive information for this party/contact.
  • Database domain where this data is stored.
  • If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
  • The email address of the contact person for the location.
  • The external system GID.
  • The facsimile number for the contact person for the location.
  • The given name of the contact person for the location.
  • The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
  • The GL user GID.
  • Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
  • Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
  • Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
  • Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
  • If Y, document attachments may be sent to the contact without virus checking.
  • Indicates if a contact is a 'From-Address' contact.
  • No notification will be sent to the contact if this field is set to false ('N').
  • Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.
  • The title for the contact person at the location.
  • The language the contact person at the location speaks.
  • The surname of the contact person for the location.
  • links
  • The GID for the location.
  • The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
  • The middle name of the contact.
  • nameAddressUpdateDate
    Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
  • Text describing something regarding the contact person for the location or the location itself.
  • The primary telephone number for the location's contact person.
  • The secondary telephone number for the location's contact person.
  • The domain of a message recipient.
  • Indicates if the notification should use location.
  • Indicates that messages should be sent to message center.
  • The telephone number for telex communications for the location's contact person.
  • Time zone for the contact.
  • The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
  • The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
  • The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
  • The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
  • The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
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: object
Show Source
Nested Schema : contactPreferences
Type: object
Show Source
Nested Schema : nameAddressUpdateDate
Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts.comMethods
Type: object
Show Source
Nested Schema : expectedResponseTime
This value is used when the location represents the service provider. It specifies the response time for a shipment tender.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.contacts.contactPreferences
Type: object
Show Source
  • Database domain where this data is stored.
  • links
  • The preference GID.
  • The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.corporations
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.loadUnloadPoints
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.operationalLocations
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.operationalLocations.details
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceGroups
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes
Type: object
Show Source
Nested Schema : resources
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources
Type: object
Show Source
Nested Schema : apptRuleSets
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets
Type: object
Show Source
Nested Schema : flexFields
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums
Type: object
Show Source
  • The appointment reference number qualifier. The qualifier related to shipment is used.
  • The appointment reference number value.
  • Database domain where this data is stored.
  • If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
    If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.
    For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.
    Shipment Reference Number Qualifier and Value
    Appointment Rule Set Reference Number Qualifier and Value
    Q1 V1 Q1 V1, selected
    Q2 V2 Q2 V2, selected
    Q3 V3
    Q4 V4
    In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.
    To define shipment reference numbers constraints, enter or select the following fields, which are optional:
    Reference Number Qualifier ID.
    Reference Number.
  • links
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles
Type: object
Show Source
Nested Schema : activityTimeDefs
Type: object
Show Source
Nested Schema : calendars
Type: object
Show Source
Nested Schema : fixedHandlingTime
Fixed amount of time. No matter the size of the shipment required for handling.
Match All
Show Source
Nested Schema : handlings
Type: object
Show Source
Nested Schema : maxFreightIdleTime
Maximum time freight can sit idle at the cross-dock.
Match All
Show Source
Nested Schema : thuCapacities
Type: object
Show Source
Nested Schema : varHandlingTime
Amount of time required to handle the amount of weight defined by the variable handling weight value.
Match All
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 : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.activityTimeDefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.calendars
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.handlings
Type: object
Show Source
Nested Schema : fixedHandlingTime
Amount fixed handling time to add. Days, hours, and minutes.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.thuCapacities
Type: object
Show Source
  • Database domain where this data is stored.
  • You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.
    Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.
  • links
  • maxHeight
    Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
  • maxLength
    Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
  • maxVolume
    Value for the maximum volume of the transportation handling unit.
  • maxWeight
    Value for the maximum weight of the transportation handling unit.
  • maxWidth
    Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
  • pruCapacities
  • The GID for the transport handling unit.
Nested Schema : maxHeight
Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
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: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities
Type: object
Show Source
  • Database domain where this data is stored.
  • Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.
  • links
  • The GID for the package unit reference unit.
  • Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.servprovPrefs
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.servprovPrefs.details
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.specialServices
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : locations.substitutes
Type: object
Show Source
  • Database domain where this data is stored.
  • links
  • The GID for the substitute location. Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.
Back to Top