Jump to

• Request
• Response

Get all suppliers

get

/fscmRestApi/resources/11.13.18.05/suppliersLOV

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
  
  

  • 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.
• 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:
  

  • 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.
• 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 : suppliersLOV

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/suppliersLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object suppliersLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/suppliersLOV-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 : suppliersLOV-item-response

Type: object

Show Source

• AlternateName: string
  Title: Alternate Name

  Read Only: true

  Maximum Length: 360

  Alternate name of the supplier.
• BusinessRelationshipCode: string
  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.
• DUNSNumber: string
  Title: D-U-N-S Number

  Read Only: true

  Maximum Length: 30

  Data Universal Numbering System (DUNS) that identifies the supplier business.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegistryId: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the party in the supplier relationship.
• sitesLOV: array Supplier Sites List of Values
  Title: Supplier Sites List of Values

  The Supplier Sites List of Values resource searches for supplier sites.
• Status: string
  Read Only: true

  Status of the supplier. Values include ACTIVE or INACTIVE.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier.
• SupplierNumber: string
  Title: Supplier Number

  Read Only: true

  Maximum Length: 30

  Number that identifies the supplier.
• SupplierPartyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier party.
• TaxRegistrationNumber: string
  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.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status of the supplier. Values include ACTIVE or INACTIVE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxRegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the value added tax that some countries use, such as, countries in the European Union.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"Data Universal Numbering System (DUNS) that identifies the supplier business.",
            "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"
            }
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the party in the supplier relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateName":{
            "title":"Alternate Name",
            "maxLength":"360",
            "type":"string",
            "description":"Alternate name of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "BusinessRelationshipCode":{
            "title":"Business Relationship",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sitesLOV":{
            "title":"Supplier Sites List of Values",
            "type":"array",
            "description":"The Supplier Sites List of Values resource searches for supplier sites.",
            "items":{
                "$ref":"#/components/schemas/suppliersLOV-sitesLOV-item-response"
            }
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":false,
            "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 : 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

• Array of: object suppliersLOV-sitesLOV-item-response

{
    "title":"Supplier Sites List of Values",
    "type":"array",
    "description":"The Supplier Sites List of Values resource searches for supplier sites.",
    "items":{
        "$ref":"#/components/schemas/suppliersLOV-sitesLOV-item-response"
    }
}

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."
        }
    }
}

Nested Schema : suppliersLOV-sitesLOV-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit where the supplier site resides.
• ProcurementBUId: integer (int64)
  Title: Procurement BU

  Read Only: true

  Value that uniquely identifies the procurement business unit where the supplier site resides.
• SitePurposePayFlag: boolean
  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.
• SitePurposePrimaryPayFlag: boolean
  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.
• SitePurposeProcurementCardFlag: boolean
  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.
• SitePurposePurchasingFlag: boolean
  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.
• SitePurposeSourcingOnlyFlag: boolean
  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.
• Status: string
  Read Only: true

  Status of the supplier site.
• SupplierAddressId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier address.
• SupplierAddressName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  Name of the supplier address.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit where the supplier site resides.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit where the supplier site resides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAddressName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SitePurposePrimaryPayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SitePurposePayFlag":{
            "title":"Pay",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SitePurposePurchasingFlag":{
            "title":"Purchasing",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SitePurposeSourcingOnlyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SitePurposeProcurementCardFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "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"
    }
}

Back to Top