Jump to

• Request
• Response
• Examples

Get all available supply sources

get

/fscmRestApi/resources/11.13.18.05/availableSupplySources

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds supply sources according to the primary key.
    Finder Variables:
    • OptionId; integer; Value that uniquely identifies the supply source rank.
  • findAllAvailableSupplySources: Finds all the availale supply sources to fulfill an internal material transfer request.
    Finder Variables:
    • ApplicationCode; string; Code that identifies the application that sent the request for supply source. If no value is provided, will default to EXT.
    • DestinationOrganizationCode; string; Code that identifies the inventory organization in which the requested item needs to be delivered.
    • DestinationOrganizationId; integer; Value that uniquely identifies the inventory organization in which the requested item needs to be delivered.
    • DestinationType; string; Code that identifies the destination type to which the transfer order is to be received. Values include INVENTORY and EXPENSE.
    • ItemId; integer; Value that uniquely identifies the item requested in the supply source request.
    • ItemNumber; string; Number that identifies the item requested in the supply source request.
    • NeedByDate; string; Date when the requested item needs to be delivered at the destination organization.
    • Quantity; number; Quantity of the item requested in the supply source request.
    • RetrieveAvailableOnhandQuantityFlag; boolean; Flag to indicate if all the available on hand quantity of the requested item in the supply source organization needs to be retrieved.
    • UOMCode; string; Code that identifies the unit of measure for the item requested in the supply source request.
  • findBestAvailableSupplySource: Finds the best available supply source to fulfill an internal material transfer request.
    Finder Variables:
    • ApplicationCode; string; Code that identifies the application that sent the request for supply source. If no value is provided, will default to EXT.
    • DestinationOrganizationCode; string; Code that identifies the inventory organization in which the requested item needs to be delivered.
    • DestinationOrganizationId; integer; Value that uniquely identifies the inventory organization in which the requested item needs to be delivered.
    • DestinationType; string; Code that identifies the destination type to which the transfer order is to be received. Values include INVENTORY and EXPENSE.
    • ItemId; integer; Value that uniquely identifies the item requested in the supply source request.
    • ItemNumber; string; Number that identifies the item requested in the supply source request.
    • NeedByDate; string; Date when the requested item needs to be delivered at the destination organization.
    • Quantity; number; Quantity of the item requested in the supply source request.
    • RetrieveAvailableOnhandQuantityFlag; boolean; Flag to indicate if all the available on hand quantity of the requested item in the supply source organization needs to be retrieved.
    • UOMCode; string; Code that identifies the unit of measure for the item requested in the supply source request.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApplicationCode; string; Code that identifies the application that sent the request for supply source. If no value is provided, will default to EXT.
  • CarrierCode; string; Code that identifies the carrier in the shipping method.
  • CarrierId; integer; Value that uniquely identifies the carrier in shipping method.
  • DestinationOrganizationCode; string; 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.
  • DestinationOrganizationId; integer; 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.
  • DestinationOrganizationName; string; 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.
  • DestinationType; string; Code that identifies the destination type to which the transfer order is to be received. Values include INVENTORY and EXPENSE.
  • ExpectedDeliveryDate; string; Date when the requested item is expected to to be delivered at the destination organization.
  • ItemId; integer; Value that uniquely identifies the item requested in the supply source request.
  • ItemNumber; string; Number that identifies the item requested in the supply source request.
  • MessageCode; string; Code that uniquely identifies the error message registered while procesing supply source request.
  • MessageText; string; Text of the error message for an error that occurred while processing the supply source request.
  • NeedByDate; string; Date when the requested item needs to be delivered at the destination organization.
  • OptionId; integer; Value that uniquely identifies the supply source rank.
  • OptionRank; integer; Number that identifies the supply source rank.
  • Quantity; number; Quantity of the item requested in the supply source request.
  • ResponseId; integer; Value that uniquely identifies the response for a supply source request.
  • RetrieveAllSupplySourcesFlag; boolean; 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.
  • RetrieveAvailableOnhandQuantityFlag; boolean; 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.
  • ShipClassOfService; string; Class of service in the shipping method. This indicates the priority of transportation.
  • ShipModeOfTransport; string; Mode of transport in the shipping method. This indicates the mode of transportation used for movement of goods.
  • ShippingMethod; string; 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.
  • SourceOrganizationCode; string; 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.
  • SourceOrganizationId; integer; 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.
  • SourceOrganizationName; string; 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.
  • TotalAvailableQuantity; number; Total on hand quantity available in the source organization.
  • TotalAvailableQuantityUOMCode; string; Code that identifies the unit of measure for the total available quantity of requested item in the source organization.
  • TotalAvailableQuantityUOMName; string; Name that identifies the unit of measure for the total available quantity of requested item in the source organization.
  • UOMCode; string; Code that identifies the unit of measure for the item requested in the supply source request.
  • UOMName; string; Name of the unit of measure for the item requested in the supply source request.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/availableSupplySources-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object availableSupplySources-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/availableSupplySources-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : availableSupplySources-item-response

Type: object

Show Source

• ApplicationCode: string
  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.
• CarrierCode: string
  Read Only: true

  Code that identifies the carrier in the shipping method.
• CarrierId: integer
  Read Only: true

  Value that uniquely identifies the carrier in shipping method.
• DestinationOrganizationCode: string
  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.
• DestinationOrganizationId: integer
  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.
• DestinationOrganizationName: string
  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.
• DestinationType: string
  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.
• ExpectedDeliveryDate: string (date-time)
  Read Only: true

  Date when the requested item is expected to to be delivered at the destination organization.
• ItemId: integer
  Read Only: true

  Value that uniquely identifies the item requested in the supply source request.
• ItemNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the item requested in the supply source request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageCode: string
  Read Only: true

  Maximum Length: 255

  Code that uniquely identifies the error message registered while procesing supply source request.
• MessageText: string
  Read Only: true

  Maximum Length: 255

  Text of the error message for an error that occurred while processing the supply source request.
• NeedByDate: string (date)
  Read Only: true

  Date when the requested item needs to be delivered at the destination organization.
• OptionId: integer
  Read Only: true

  Value that uniquely identifies the supply source rank.
• OptionRank: integer
  Read Only: true

  Number that identifies the supply source rank.
• Quantity: number
  Read Only: true

  Quantity of the item requested in the supply source request.
• ResponseId: integer
  Read Only: true

  Value that uniquely identifies the response for a supply source request.
• RetrieveAllSupplySourcesFlag: boolean
  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.
• RetrieveAvailableOnhandQuantityFlag: boolean
  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.
• ShipClassOfService: string
  Read Only: true

  Class of service in the shipping method. This indicates the priority of transportation.
• ShipModeOfTransport: string
  Read Only: true

  Mode of transport in the shipping method. This indicates the mode of transportation used for movement of goods.
• ShippingMethod: string
  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.
• SourceOrganizationCode: string
  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.
• SourceOrganizationId: integer
  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.
• SourceOrganizationName: string
  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.
• TotalAvailableQuantity: number
  Read Only: true

  Total on hand quantity available in the source organization.
• TotalAvailableQuantityUOMCode: string
  Read Only: true

  Code that identifies the unit of measure for the total available quantity of requested item in the source organization.
• TotalAvailableQuantityUOMName: string
  Read Only: true

  Name that identifies the unit of measure for the total available quantity of requested item in the source organization.
• UOMCode: string
  Read Only: true

  Code that identifies the unit of measure for the item requested in the supply source request.
• UOMName: string
  Read Only: true

  Name of the unit of measure for the item requested in the supply source request.

{
    "type":"object",
    "properties":{
        "ShippingMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the response for a supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipModeOfTransport":{
            "type":"string",
            "description":"Mode of transport in the shipping method. This indicates the mode of transportation used for movement of goods.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAvailableQuantity":{
            "type":"number",
            "description":"Total on hand quantity available in the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":"255",
            "type":"string",
            "description":"Code that identifies the destination type to which the transfer order is to be received. Values include INVENTORY and EXPENSE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item requested in the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipClassOfService":{
            "type":"string",
            "description":"Class of service in the shipping method. This indicates the priority of transportation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionRank":{
            "type":"integer",
            "description":"Number that identifies the supply source rank.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetrieveAvailableOnhandQuantityFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code that identifies the application that sent the request for supply source. If no value is provided, will default to EXT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier in shipping method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item requested in the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalAvailableQuantityUOMName":{
            "type":"string",
            "description":"Name that identifies the unit of measure for the total available quantity of requested item in the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "type":"string",
            "description":"Code that identifies the unit of measure for the item requested in the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code that uniquely identifies the error message registered while procesing supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item requested in the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message for an error that occurred while processing the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply source rank.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date when the requested item needs to be delivered at the destination organization.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetrieveAllSupplySourcesFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierCode":{
            "type":"string",
            "description":"Code that identifies the carrier in the shipping method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedDeliveryDate":{
            "type":"string",
            "description":"Date when the requested item is expected to to be delivered at the destination organization.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMName":{
            "type":"string",
            "description":"Name of the unit of measure for the item requested in the supply source request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAvailableQuantityUOMCode":{
            "type":"string",
            "description":"Code that identifies the unit of measure for the total available quantity of requested item in the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

These example describe how to get all available supply sources.

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"

Example 1

This example describes how to get all available supply sources 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 1 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?finder=findAllAvailableSupplySources;ItemNumber="dos-gop-buytrfr",UOMCode="Ea",ApplicationCode="POR",Quantity=23,NeedByDate=2023-04-26,RetrieveAvailableOnhandQuantityFlag=true,DestinationOrganizationCode="M1",DestinationType="INVENTORY"

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
  "items": [
    {
      "ResponseId": 300100593437382,
      "OptionId": 300100593437383,
      "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": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437383",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437383",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    },
    {
      "ResponseId": 300100593437382,
      "OptionId": 300100593437384,
      "OptionRank": 1,
      "ItemId": 300100174851317,
      "ItemNumber": "dos-gop-buytrfr",
      "DestinationOrganizationId": 207,
      "DestinationOrganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "Quantity": 23,
      "UOMCode": "Ea",
      "UOMName": "Each",
      "NeedByDate": "2023-04-26",
      "SourceOrganizationId": 209,
      "SourceOrganizationCode": "M2",
      "SourceOrganizationName": "Boston Manufacturing",
      "ExpectedDeliveryDate": "2023-04-26T23:59:59+00:00",
      "TotalAvailableQuantity": 50,
      "TotalAvailableQuantityUOMCode": "Ea",
      "TotalAvailableQuantityUOMName": "Each",
      "ShipModeOfTransport": "AIR",
      "ShipClassOfService": "2DA",
      "CarrierId": 12521,
      "CarrierCode": "DHL",
      "RetrieveAvailableOnhandQuantityFlag": "true",
      "RetrieveAllSupplySourcesFlag": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437384",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437384",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    },
    {
      "ResponseId": 300100593437382,
      "OptionId": 300100593437385,
      "OptionRank": 2,
      "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": "EXP",
      "CarrierId": 33089,
      "CarrierCode": "Correios",
      "RetrieveAvailableOnhandQuantityFlag": "true",
      "RetrieveAllSupplySourcesFlag": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437385",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593437385",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/availableSupplySources",
      "name": "availableSupplySources",
      "kind": "collection"
    }
  ]
}

Example 2

This example describes how to get all available supply sources without total on-hand quantities in the supply sources. In this example, the user doesn't have the View Total On Hand Quantity in Supply Source (DOS_VIEW_AVAILABLE_ONHAND_QTY_PRIV) privilege.

Example 2 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?finder=findAllAvailableSupplySources;ItemNumber="DOS-GOP-BUYTRFR",UOMCode="Ea",ApplicationCode="POR",Quantity=23,NeedByDate=2023-01-26,RetrieveAvailableOnhandQuantityFlag=true,DestinationOrganizationCode="M1",DestinationType="INVENTORY"

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
  "items": [
    {
      "ResponseId": 300100593443466,
      "OptionId": 300100593443467,
      "OptionRank": 0,
      "ItemId": 300100174851317,
      "ItemNumber": "DOS-GOP-BUYTRFR",
      "DestinationOrganizationId": 207,
      "DestinationOrganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "Quantity": 50,
      "UOMCode": "Ea",
      "UOMName": "Each",
      "NeedByDate": "2023-01-26",
      "SourceOrganizationId": 606,
      "SourceOrganizationCode": "M3",
      "SourceOrganizationName": "Dallas Manufacturing",
      "ExpectedDeliveryDate": "2023-03-22T23:59:59+00:00",
      "TotalAvailableQuantity": null,
      "TotalAvailableQuantityUOMCode": null,
      "TotalAvailableQuantityUOMName": null,
      "ShipModeOfTransport": "AIR",
      "ShipClassOfService": "EXP",
      "CarrierId": 33089,
      "CarrierCode": "Correios",
      "RetrieveAvailableOnhandQuantityFlag": "true",
      "RetrieveAllSupplySourcesFlag": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443467",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443467",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    },
    {
      "ResponseId": 300100593443466,
      "OptionId": 300100593443468,
      "OptionRank": 1,
      "ItemId": 300100174851317,
      "ItemNumber": "DOS-GOP-BUYTRFR",
      "DestinationOrganizationId": 207,
      "DestinationOrganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "Quantity": 50,
      "UOMCode": "Ea",
      "UOMName": "Each",
      "NeedByDate": "2023-01-26",
      "SourceOrganizationId": 209,
      "SourceOrganizationCode": "M2",
      "SourceOrganizationName": "Boston Manufacturing",
      "ExpectedDeliveryDate": "2023-03-23T23:59:59+00:00",
      "TotalAvailableQuantity": null,
      "TotalAvailableQuantityUOMCode": null,
      "TotalAvailableQuantityUOMName": null,
      "ShipModeOfTransport": "AIR",
      "ShipClassOfService": "2DA",
      "CarrierId": 12521,
      "CarrierCode": "DHL",
      "RetrieveAvailableOnhandQuantityFlag": "true",
      "RetrieveAllSupplySourcesFlag": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443468",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443468",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    },
    {
      "ResponseId": 300100593443466,
      "OptionId": 300100593443470,
      "OptionRank": 2,
      "ItemId": 300100174851317,
      "ItemNumber": "DOS-GOP-BUYTRFR",
      "DestinationOrganizationId": 207,
      "DestinationOrganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "Quantity": 50,
      "UOMCode": "Ea",
      "UOMName": "Each",
      "NeedByDate": "2023-01-26",
      "SourceOrganizationId": 606,
      "SourceOrganizationCode": "M3",
      "SourceOrganizationName": "Dallas Manufacturing",
      "ExpectedDeliveryDate": "2023-03-23T23:59:59+00:00",
      "TotalAvailableQuantity": null,
      "TotalAvailableQuantityUOMCode": null,
      "TotalAvailableQuantityUOMName": null,
      "ShipModeOfTransport": "AIR",
      "ShipClassOfService": "2DA",
      "CarrierId": 12521,
      "CarrierCode": "DHL",
      "RetrieveAvailableOnhandQuantityFlag": "true",
      "RetrieveAllSupplySourcesFlag": "true",
      "ApplicationCode": "POR",
      "DestinationType": "INVENTORY",
      "MessageCode": null,
      "MessageText": null,
      "ShippingMethod": "Correios-Air-Express",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443470",
          "name": "availableSupplySources",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/availableSupplySources/300100593443470",
          "name": "availableSupplySources",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/availableSupplySources",
      "name": "availableSupplySources",
      "kind": "collection"
    }
  ]
}

Back to Top