1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. SCM Common
  4. Transit Times

Get one transit time

get

/fscmRestApi/resources/11.13.18.05/transitTimes/{TransitTimeId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : transitTimes-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    The user supplied name of the selected destination location.
  • Read Only: true
    The comma delimited concatenation of the primary attributes of the destination location such as street address, city, state, and postal code.
  • The name of the selected customer when the destination type is a ship-to address. The default value is null.
  • The value that uniquely identifies the selected address from the trading community architecture when Destination Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
  • The selected address from the trading community architecture when Destination Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the destination is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site identifier. When Destination is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site name. When Destination is a ship-to address, the value represents a party site name for the customer address. The default value is null.
  • Maximum Length: 2
    The value that uniquely identifies the selected kind of trading community architecture location. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
  • The value that uniquely identifies the selected supplier when the Destination Type is a supplier address.
  • The name of the selected supplier when Destination Type is a supplier address.
  • The comma delimited concatenation of the geography hierarchy when Destination Type is Geography. The default value is null.
  • The value that uniquely identifies the selected geography when Destination Type is Geography. The default value is null.
  • The name of the selected geography when Destination Type is Geography. The default value is null.
  • The short name that identifies the selected warehouse location when Destination Type is Internal Location. Location Codes are only unique within a Location Set. The default value is null.
  • The value that uniquely identifies the selected warehouse location when Destination Type is Internal Location. The default value is null.
  • The name of the set that the selected warehouse location was chosen from when Destination Type is Internal Location. The default value is null.
  • Title: Destination Type
    Maximum Length: 2
    The abbreviation that identifies the type of location for the destination of the shipping lane. This attribute is required. Valid values include LI for Internal Location, G for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • The value that uniquely identifies the selected zone when Destination Type is Zone. The default value is null.
  • The name of the selected zone when Destination Type is Zone. The default value is null.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Read Only: true
    The user supplied name of the selected origin location.
  • Read Only: true
    The comma delimited concatenation of the primary attributes of the origin location such as street address, city, state and postal code.
  • The name of the selected customer when the origin type is a ship-to address. The default value is null.
  • The value that uniquely identifies the selected address from the trading community architecture when Origin Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
  • The selected address from the trading community architecture when Origin Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site identifier. When the origin is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
  • The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site name. When the origin is a ship-to address, the value represents a party site name for the customer address. The default value is null.
  • Maximum Length: 2
    The value that uniquely identifies the specific kind of trading community architecture location has is selected. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
  • The value that uniquely identifies the selected supplier when the origin type is a supplier address.
  • The name of the selected supplier when the origin type is a supplier address.
  • The comma delimited concatenation of the geography hierarchy when Origin Type is Geography. The default value is null.
  • The value that uniquely identifies the selected geography when Origin Type is Geography. The default value is null.
  • The name of the selected geography when Origin Type is Geography. The default value is null.
  • The abbreviation that identifies the selected warehouse location when Origin Type is Internal Location. Location codes are only unique within a location set. The default value is null.
  • The value that uniquely identifies the selected warehouse location when Origin Type is Internal Location. The default value is null.
  • The name of the set that the selected warehouse location was chosen from when Origin Type is Internal Location. The default value is null.
  • Title: Origin Type
    Maximum Length: 2
    The abbreviation that identifies the type of location for the origin of the shipping lane. This attribute is required. Valid values include LI for Internal Location, R for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • The value that uniquely identifies the selected zone when Origin Type is Zone. The default value is null.
  • The name of the selected zone when Origin Type is Zone. The default value is null.
  • Shipping Methods
    Title: Shipping Methods
    The Shipping Methods resource gets the shipping method associated between the origin and destination locations.
  • Read Only: true
    The value that uniquely identifies the transit time. It is a value that the application generates when it creates a transit time.
Nested Schema : Shipping Methods
Type: array
Title: Shipping Methods
The Shipping Methods resource gets the shipping method associated between the origin and destination locations.
Show Source
Nested Schema : transitTimes-shippingMethods-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipping Methods
Type: array
Title: Flexfields for Shipping Methods
The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.
Show Source
Nested Schema : transitTimes-shippingMethods-DFF-item-response
Type: object
Show Source
Links
shippingMethods
Parameters:
  • TransitTimeId: $request.path.TransitTimeId
The Shipping Methods resource gets the shipping method associated between the origin and destination locations.
Back to Top

Examples

This example describes how to get one transit time.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/transitTimes/TransitTimeId"

For example, the following command gets one transit time:

curl -u username:password "https://servername/fscmRestApi/resources/version/transitTimes/100000016389709"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "TransitTimeId": 100000016389709, 
    "Origin": "V1- New York City", 
    "OriginDescription": "V1- New York City", 
    "OriginTypeCode": "LI", 
    "OriginGeographyId": null, 
    "OriginGeographyName": null, 
    "OriginGeographyDescription": null, 
    "OriginZoneId": null, 
    "OriginZoneName": null, 
    "OriginInternalLocationId": 204, 
    "OriginInternalLocationCode": "V1-_NEW_YORK_CITY_0_2450399170046", 
    "OriginInternalLocationSetName": "Common Set", 
    "OriginExternalLocationId": null, 
    "OriginExternalLocationName": null, 
    "OriginExternalLocationSourceType": null, 
    "OriginExternalLocationSourceId": null, 
    "OriginExternalLocationSourceName": null, 
    "OriginExternalLocationSupplierId": null, 
    "OriginExternalLocationSupplierName": null, 
    "DestinationTypeCode": "R", 
    "Destination": "TN", 
    "DestinationDescription": "United States,TN", 
    "DestinationGeographyId": 52, 
    "DestinationGeographyName": "TN", 
    "DestinationGeographyDescription": "United States,TN", 
    "DestinationZoneId": null, 
    "DestinationZoneName": null, 
    "DestinationInternalLocationId": null, 
    "DestinationInternalLocationCode": null, 
    "DestinationInternalLocationSetName": null, 
    "DestinationExternalLocationId": null, 
    "DestinationExternalLocationName": null, 
    "DestinationExternalLocationSourceType": null, 
    "DestinationExternalLocationSourceId": null, 
    "DestinationExternalLocationSourceName": null, 
    "DestinationExternalLocationSupplierId": null, 
    "DestinationExternalLocationSupplierName": null, 
...
  }, {
...
  } ],
...
}
Back to Top