Get all suppliers

get

/fscmRestApi/resources/11.13.18.05/suppliersLOV

Request

Query Parameters
  • 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
  • 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

    • FindByBillToBU Finds suppliers according to the business unit enabled for billing.
      Finder Variables
      • BillToBuId; integer; ; integer; Value that uniquely identifies the bill-to business unit.
      • bindSysDate; string; ; string; Value that uniquely identifies the system date.
    • FindByReqBUAndPurchasingFlag Finds suppliers according to the business unit enabled for requisitioning and the purchasing purpose.
      Finder Variables
      • ClientBuId; integer; ; integer; Value that uniquely identifies the client business unit.
      • bindSysDate; string; ; string; Value that uniquely identifies the system date.
    • PrimaryKey Finds suppliers according to the primary key.
      Finder Variables
      • SupplierId; integer; ; integer; Value that uniquely identifies the supplier.
    • PrimaryKeyFinder Finds suppliers according to the primary key.
      Finder Variables
      • SupplierId; integer; ; integer; Value that uniquely identifies the supplier.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AlternateName; string; Alternate name of the supplier.
    • BusinessRelationshipCode; string; Abbreviation that identifies the business relationship between the enterprise and the supplier. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
    • DUNSNumber; string; Data Universal Numbering System (DUNS) that identifies the supplier business.
    • RegistryId; string; Value that uniquely identifies the party in the supplier relationship.
    • Status; string; Status of the supplier. Values include ACTIVE or INACTIVE.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierName; string; Name of the supplier.
    • SupplierNumber; string; Number that identifies the supplier.
    • SupplierPartyId; integer; Value that uniquely identifies the supplier party.
    • TaxRegistrationNumber; string; Number that identifies the value added tax that some countries use, such as, countries in the European Union.
  • 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
  • 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 : suppliersLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : suppliersLOV-item-response
Type: object
Show Source
  • Title: Alternate Name
    Read Only: true
    Maximum Length: 360
    Alternate name of the supplier.
  • Title: Business Relationship
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the business relationship between the enterprise and the supplier. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: D-U-N-S Number
    Read Only: true
    Maximum Length: 30
    Data Universal Numbering System (DUNS) that identifies the supplier business.
  • Links
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the party in the supplier relationship.
  • Supplier Sites List of Values
    Title: Supplier Sites List of Values
    The Supplier Sites List of Values resource searches for supplier sites.
  • Read Only: true
    Status of the supplier. Values include ACTIVE or INACTIVE.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier.
  • Title: Supplier Number
    Read Only: true
    Maximum Length: 30
    Number that identifies the supplier.
  • Read Only: true
    Value that uniquely identifies the supplier party.
  • Title: Registration Number
    Read Only: true
    Maximum Length: 50
    Number that identifies the value added tax that some countries use, such as, countries in the European Union.
Nested Schema : Supplier Sites List of Values
Type: array
Title: Supplier Sites List of Values
The Supplier Sites List of Values resource searches for supplier sites.
Show Source
Nested Schema : suppliersLOV-sitesLOV-item-response
Type: object
Show Source
  • Links
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    Name of the procurement business unit where the supplier site resides.
  • Title: Procurement BU
    Read Only: true
    Value that uniquely identifies the procurement business unit where the supplier site resides.
  • Title: Pay
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a pay purpose exists for the supplier site. If false, then a pay purpose doesn't exist. The default value is false.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a primary pay purpose exists for the supplier site. If false, then a primary pay purpose doesn't exist. The default value is false.
  • Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a procurement card exists for the supplier site. If false, then a procurement card doesn't exist. The default value is false.
  • Title: Purchasing
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a purchasing purpose exists for the supplier site. If false, then a purpose doesn't exist. The default value is false.
  • Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the supplier site has a sourcing only purpose. If false, then the supplier site doesn't have a sourcing only purpose. The default value is false.
  • Read Only: true
    Status of the supplier site.
  • Read Only: true
    Value that uniquely identifies the supplier address.
  • Title: Site Name
    Read Only: true
    Maximum Length: 240
    Name of the supplier address.
  • Title: Site
    Read Only: true
    Maximum Length: 240
    Name of the supplier site.
  • Read Only: true
    Value that uniquely identifies the supplier site.
Back to Top