1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Available Supply Sources

Get one best available supply source

get

/fscmRestApi/resources/11.13.18.05/availableSupplySources/{OptionId}

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 : availableSupplySources-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Code that identifies the application that sent the request for supply source. If no value is provided, will default to EXT.
  • Read Only: true
    Code that identifies the carrier in the shipping method.
  • Read Only: true
    Value that uniquely identifies the carrier in shipping method.
  • Read Only: true
    Maximum Length: 255
    Code that identifies the inventory organization in which the requested item needs to be delivered. This code has to be an organization code defined in Oracle Cloud applications.
  • Read Only: true
    Value that uniquely identifies the inventory organization in which the requested item needs to be delivered. This identifier has to be associated with the organization code defined in Oracle Cloud applications.
  • Read Only: true
    Maximum Length: 255
    Name that identifies the inventory organization in which the requested item needs to be delivered. This name has to be associated with the organization code defined in Oracle Cloud applications.
  • Read Only: true
    Maximum Length: 255
    Code that identifies the destination type to which the transfer order is to be received. Values include INVENTORY and EXPENSE.
  • Read Only: true
    Date when the requested item is expected to to be delivered at the destination organization.
  • Read Only: true
    Value that uniquely identifies the item requested in the supply source request.
  • Read Only: true
    Maximum Length: 255
    Number that identifies the item requested in the supply source request.
  • Links
  • Read Only: true
    Maximum Length: 255
    Code that uniquely identifies the error message registered while procesing supply source request.
  • Read Only: true
    Maximum Length: 255
    Text of the error message for an error that occurred while processing the supply source request.
  • Read Only: true
    Date when the requested item needs to be delivered at the destination organization.
  • Read Only: true
    Value that uniquely identifies the supply source rank.
  • Read Only: true
    Number that identifies the supply source rank.
  • Read Only: true
    Quantity of the item requested in the supply source request.
  • Read Only: true
    Value that uniquely identifies the response for a supply source request.
  • Read Only: true
    Contains one of the following values: True or False. If True, then all the available supply sources are retrieved. If False, then only the best available supply source is retrieved. The default value is False.
  • Read Only: true
    Contains one of the following values: True or False. If True, then the available on hand quanity in the source organication is retrieved. If False, then the available on hand quantity in the source organization is not retrieved. The default value is False.
  • Read Only: true
    Class of service in the shipping method. This indicates the priority of transportation.
  • Read Only: true
    Mode of transport in the shipping method. This indicates the mode of transportation used for movement of goods.
  • Read Only: true
    Maximum Length: 255
    Shipping Method is a combination of Carrier, Ship Mode of Transport, and Ship Class of Service. The Shipping Method name is constructed based on the Carrier, Ship Mode of Transport, and Ship Class of Service.
  • Read Only: true
    Maximum Length: 255
    Code that identifies the organization from where the requested item needs to be transferred to the destination organization for a supply source request. This code has to be an organization code defined in Oracle Cloud applications.
  • Read Only: true
    Value that uniquely identifies the organization from where the requested item needs to be transferred to the destination organization for a supply source request. This identifier has to be an organization identifier generated in Oracle Cloud applications.
  • Read Only: true
    Maximum Length: 255
    Name that identifies the organization from where the requested item needs to be transferred to the destination organization for a supply source request. This identifier has to be associated to the organization code defined in Oracle Cloud applications.
  • Read Only: true
    Total on hand quantity available in the source organization.
  • Read Only: true
    Code that identifies the unit of measure for the total available quantity of requested item in the source organization.
  • Read Only: true
    Name that identifies the unit of measure for the total available quantity of requested item in the source organization.
  • Read Only: true
    Code that identifies the unit of measure for the item requested in the supply source request.
  • Read Only: true
    Name of the unit of measure for the item requested in the supply source request.
Back to Top

Examples

This example describes how to get the best available supply source and get the total on-hand quantities in each of the supply sources.

Note:

To get the total on-hand quantities, the user needs to have the View Total On Hand Quantity in Supply Source (DOS_VIEW_AVAILABLE_ONHAND_QTY_PRIV) privilege.

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/availableSupplySources/OptionId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/availableSupplySources?finder=findBestAvailableSupplySource;ItemNumber="dos-gop-buytrfr",UOMCode="Ea",ApplicationCode="POR",Quantity=23,NeedByDate=2023-04-26,RetrieveAvailableOnhandQuantityFlag=true,DestinationOrganizationCode="M1",DestinationType="INVENTORY"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
   "items":[
      {
         "ResponseId":300100592946801,
         "OptionId":300100592946802,
         "OptionRank":0,
         "ItemId":300100174851317,
         "ItemNumber":"dos-gop-buytrfr",
         "DestinationOrganizationId":207,
         "DestinationOrganizationCode":"M1",
         "DestinationOrganizationName":"Seattle Manufacturing",
         "Quantity":23,
         "UOMCode":"Ea",
         "UOMName":"Each",
         "NeedByDate":"2023-04-26",
         "SourceOrganizationId":606,
         "SourceOrganizationCode":"M3",
         "SourceOrganizationName":"Dallas Manufacturing",
         "ExpectedDeliveryDate":"2023-04-26T23:59:59+00:00",
         "TotalAvailableQuantity":1000,
         "TotalAvailableQuantityUOMCode":"Ea",
         "TotalAvailableQuantityUOMName":"Each",
         "ShipModeOfTransport":"AIR",
         "ShipClassOfService":"2DA",
         "CarrierId":12521,
         "CarrierCode":"DHL",
         "RetrieveAvailableOnhandQuantityFlag":"true",
         "RetrieveAllSupplySourcesFlag":"false",
         "ApplicationCode":"POR",
         "DestinationType":"INVENTORY",
         "MessageCode":null,
         "MessageText":null,
         "links":[
            {
               "rel":"self",
               "href":"https://servername/fscmRestApi/resources/version/availableSupplySources/300100592946802",
               "name":"availableSupplySources",
               "kind":"item"
            },
            {
               "rel":"canonical",
               "href":"https://servername/fscmRestApi/resources/version/availableSupplySources/300100592946802",
               "name":"availableSupplySources",
               "kind":"item"
            }
         ]
      }
   ],
   "count":1,
   "hasMore":false,
   "limit":25,
   "offset":0,
   "links":[
      {
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/availableSupplySources",
         "name":"availableSupplySources",
         "kind":"collection"
      }
   ]
}
Back to Top