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

Get an Itinerary

get

/itineraries/{itineraryGid}

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
  • 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
  • Contains the GID for the calendar.
  • Contains the GID for the corporation profile used for the itinerary.
  • The total number of pickup stops for a multistop shipment. It is usually set to be the maximum of the Delivery Stops Constraints of all valid rate offering. This help multistop performance.
  • The GID for the depot profile. The depot profile defines the lane and Source and/or Destination Depot Location that are considered during planning for service providers that start and end at depot locations.
  • Contains text describing the itinerary.
  • Database domain where this data is stored.
  • The GID for the hazardous transport mode. It can be used to differentiate between goods from different orders that can be consolidated into one shipment for one or more legs of the trip.
  • The GID for the INCO Term profile. The Incoterm Profile can be used to constrain the itinerary as a valid choice for shipment planning for any order that has the same Incoterm attributes as the profile. Note: If you use this field, you can also specify a Payment Method code on each leg of the itinerary which is then copied to the shipment that is built for that leg (overriding any Payment Method code defined on the order base).
  • insertDate
    Read Only: true
    insert date
  • If this is selected, when going through the deconsolidation pool process, if there is a cross dock on this itinerary, two or more order bundles have the same destination will not route to the deconsolidation pool. It will route to cross dock later for consolidation at the cross dock and directly go to the destination.
  • The Match Deconsol Pool to Src check box sets the pool logic so that it matches orders to deconsolidation pools based on order's source location. If it is selected pool logic matches orders to consolidation pools based on order's source locations. If the check box is cleared, Oracle Transportation Management matches orders to consolidation pools according to the order's destination locations.
  • The Match Deconsol Pool to Dest check box sets the pool logic so that it matches orders to deconsolidation pools based on order's destination locations. If this is not selected, Oracle Transportation Management matches orders to deconsolidation pools according to the order's source location.
  • Describes whether the itinerary contains more than one stop. If so, this column contains a Y for yes; if not it contains an N for no.
  • N/A
  • Contains the GID for the itinerary.
  • Contains the name for the itinerary.
  • By default, the Itinerary Type field displays Active which means that the itinerary can be used in shipment planning. Choose Inactive if you do not want this itinerary to be considered when building shipments. You can also choose Manual which means the itinerary should not be considered when running the Create Shipment - Bulk Plan, Direct, or Calculate Best Direct Cost actions. However, the itinerary is considered when running the Direct - Show Routing Options action.
  • Contains the XID for the itinerary.
  • legs
  • links
    Read Only: true
  • maxDistBtwDelvs
    The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.
  • maxDistBtwPickups
    In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.
  • maxPoolVolume
    The maximum volume to go through a pool.
  • maxPoolWeight
    The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.
  • maxSmallDirectVolume
    After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.
  • maxSmallDirectWeight
    After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.
  • maxVolume
    Contains the maximum volume for the shipment on the itinerary.
  • maxWeight
    Contains the maximum weight for the shipment on the itinerary.
  • maxXdockVolume
    The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.
  • maxXdockWeight
    The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.
  • minStopoffVolume
    Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.
  • minStopoffWeight
    Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.
  • The percentage of usage to be used to determine whether a TL is full in bulk plan. This will guide whether direct shipment be kept without routing to pool. It also determines whether pool shipments be kept without routing to xdock.
  • minTlVolume
    This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool
  • minTlWeight
    This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.
  • minVolume
    Contains the minimum volume for the shipment on the itinerary.
  • minWeight
    Contains the minimum weight for the shipment on the itinerary.
  • The list of compatible payment methods for the itinerary.
  • The perspective determines whether the itinerary is used for buy or sell shipment services. Perspective options include All (used for Buy and Sell), Buy, Sell.
  • The total number of pickup stops for a multistop shipment. It is usually set to be the max of Pickup Stops Constraints of all valid rate offering. This helps multistop performance.
  • radiusForDelvs
    The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.
  • radiusForPickups
    The distance from any pickup stop to the root bundle's source location can not exceed this distance.
  • The maximum radial percentage distance from the source to each delivery stop location that can not be exceeded.
  • The distance from any pickup stop to the source location divided by the distance cannot exceed this percentage.
  • N/A
  • totalCost
    N/A
  • Specifies the maximum number of stops on a multi-stop shipment derived from this itinerary.
  • totalTransitTime
    N/A
  • updateDate
    Read Only: true
    update date
  • Orders matched to this itinerary may use a consolidation pool on the source.
  • Orders matched to this itinerary may use a deconsolidation pool on the destination.
  • Contains the GID for the entity. It is created by concatenating the Domain Name,"." and the XID.
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 : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : legs
Type: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : maxDistBtwDelvs
The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.
Match All
Show Source
Nested Schema : maxDistBtwPickups
In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.
Match All
Show Source
Nested Schema : maxPoolVolume
The maximum volume to go through a pool.
Match All
Show Source
Nested Schema : maxPoolWeight
The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.
Match All
Show Source
Nested Schema : maxSmallDirectVolume
After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.
Match All
Show Source
Nested Schema : maxSmallDirectWeight
After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.
Match All
Show Source
Nested Schema : maxVolume
Contains the maximum volume for the shipment on the itinerary.
Match All
Show Source
Nested Schema : maxWeight
Contains the maximum weight for the shipment on the itinerary.
Match All
Show Source
Nested Schema : maxXdockVolume
The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.
Match All
Show Source
Nested Schema : maxXdockWeight
The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.
Match All
Show Source
Nested Schema : minStopoffVolume
Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.
Match All
Show Source
Nested Schema : minStopoffWeight
Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.
Match All
Show Source
Nested Schema : minTlVolume
This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool
Match All
Show Source
Nested Schema : minTlWeight
This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.
Match All
Show Source
Nested Schema : minVolume
Contains the minimum volume for the shipment on the itinerary.
Match All
Show Source
Nested Schema : minWeight
Contains the minimum weight for the shipment on the itinerary.
Match All
Show Source
Nested Schema : radiusForDelvs
The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.
Match All
Show Source
Nested Schema : radiusForPickups
The distance from any pickup stop to the root bundle's source location can not exceed this distance.
Match All
Show Source
Nested Schema : totalCost
N/A
Match All
Show Source
Nested Schema : totalTransitTime
N/A
Match All
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : itineraries.legs
Type: object
Show Source
Nested Schema : capacityOverrides
Type: object
Show Source
Nested Schema : flexCommodityProfilelists
Type: object
Show Source
Nested Schema : interimPoints
Type: object
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : schedules
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : itineraries.legs.capacityOverrides
Type: object
Show Source
  • The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.
  • Database domain where this data is stored.
  • links
Nested Schema : items
Type: array
Show Source
Nested Schema : itineraries.legs.flexCommodityProfilelists
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : itineraries.legs.interimPoints
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : itineraries.legs.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : itineraries.legs.schedules
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Back to Top