1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Procurement Approved Supplier List Entries

Create one approved supplier list entry

post

/fscmRestApi/resources/11.13.18.05/procurementApprovedSupplierListEntries

Request

Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Unique identifier of the approved supplier list entry.
  • Status identifier of the approved supplier list entry.
  • Maximum Length: 240
    Comments entered for the approved supplier list entry.
  • Title: Country of Origin
    Maximum Length: 80
    Country from which goods are exported.
  • Maximum Length: 2
    Code that indicates the country from which goods are exported.
  • DFF
  • Title: Disabled
    Maximum Length: 1
    Mark indicating that the approved supplier list entry is no longer in use.
  • Title: Fixed Lot Multiple
    Incremental quantity that must be used on purchase orders sourced from the approved supplier list entry.
  • Title: Item
    Maximum Length: 300
    Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies.
  • Value that uniquely identifies the item on the approved supplier list entry.
  • Title: Minimum Order Quantity
    Identifies the minimum quantity that can be purchased from the supplier on purchase orders sourced from the approved supplier list entry.
  • Title: Supplier Item
    Maximum Length: 300
    Identifies the supplier item number.
  • Title: Procurement BU
    Maximum Length: 240
    Business unit that manages and owns the purchasing document.
  • Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
  • Title: Purchasing UOM
    Maximum Length: 25
    Unit of measure used on purchase orders sourced from the approved supplier list entry.
  • Maximum Length: 3
    Code that indicates the unit of measure used on purchase orders sourced from the approved supplier list entry.
  • Date when the approved supplier list entry needs to be evaluated. This is generally used as a reminder for approving or recertifying the supplier for the specific item or category.
  • Title: Ship-to Organization
    Maximum Length: 240
    Name of the inventory organization to which the supplier should ship the goods.
  • Default Value: -1
    Value that uniquely identifies the inventory organization that receives the item.
  • Title: Status
    Maximum Length: 25
    Approval status of the approved supplier list entry, representing whether the supplier is certified to supply the item or group of items.
  • Title: Supplier
    Maximum Length: 360
    Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.
  • Value that uniquely identifies the supplier who fulfills the order.
  • Title: Supplier Site
    Maximum Length: 240
    Entity that models how the buying organization conducts business with the supplier.
  • Value that uniquely identifies the location that the supplier uses to fulfill the order.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : procurementApprovedSupplierListEntries-DFF-item-post-request
Type: object
Show Source
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 : procurementApprovedSupplierListEntries-item-response
Type: object
Show Source
  • Read Only: true
    Date on which the approved supplier list entry was created.
  • Unique identifier of the approved supplier list entry.
  • Read Only: true
    Code that identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit.
  • Status identifier of the approved supplier list entry.
  • Maximum Length: 240
    Comments entered for the approved supplier list entry.
  • Title: Country of Origin
    Maximum Length: 80
    Country from which goods are exported.
  • Maximum Length: 2
    Code that indicates the country from which goods are exported.
  • DFF
  • Title: Disabled
    Maximum Length: 1
    Mark indicating that the approved supplier list entry is no longer in use.
  • Title: Fixed Lot Multiple
    Incremental quantity that must be used on purchase orders sourced from the approved supplier list entry.
  • Title: Item
    Maximum Length: 300
    Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies.
  • Value that uniquely identifies the item on the approved supplier list entry.
  • Links
  • Title: Minimum Order Quantity
    Identifies the minimum quantity that can be purchased from the supplier on purchase orders sourced from the approved supplier list entry.
  • Title: Supplier Item
    Maximum Length: 300
    Identifies the supplier item number.
  • Title: Procurement BU
    Maximum Length: 240
    Business unit that manages and owns the purchasing document.
  • Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
  • Title: Purchasing UOM
    Maximum Length: 25
    Unit of measure used on purchase orders sourced from the approved supplier list entry.
  • Maximum Length: 3
    Code that indicates the unit of measure used on purchase orders sourced from the approved supplier list entry.
  • Date when the approved supplier list entry needs to be evaluated. This is generally used as a reminder for approving or recertifying the supplier for the specific item or category.
  • Title: Scope
    Read Only: true
    Maximum Length: 255
    Identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit.
  • Title: Ship-to Organization
    Maximum Length: 240
    Name of the inventory organization to which the supplier should ship the goods.
  • Default Value: -1
    Value that uniquely identifies the inventory organization that receives the item.
  • Title: Status
    Maximum Length: 25
    Approval status of the approved supplier list entry, representing whether the supplier is certified to supply the item or group of items.
  • Title: Supplier
    Maximum Length: 360
    Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.
  • Value that uniquely identifies the supplier who fulfills the order.
  • Title: Supplier Site
    Maximum Length: 240
    Entity that models how the buying organization conducts business with the supplier.
  • Value that uniquely identifies the location that the supplier uses to fulfill the order.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : procurementApprovedSupplierListEntries-DFF-item-response
Type: object
Show Source
Links
DFF
Parameters:
  • procurementApprovedSupplierListEntriesUniqID: $request.path.procurementApprovedSupplierListEntriesUniqID
Back to Top

Examples

These examples describe how to create one approved supplier list entry.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries"

Example 1

This example describes how to create a global approved supplier list entry with supplier item attribute values.

Example 1 Request Body

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

{
  "ProcurementBU": "Vision Operations",
  "Supplier": "Big Computers",
  "SupplierSite": "Austin",
  "Item": "CM13139",
  "Status": "Approved",
  "PrimaryVendorItem": null,
  "ReviewDueDate": null,
  "DisableFlag": null,
  "Comments": null,
  "PurchasingUOM": "Each",
  "CountryOfOrigin": "United States",
  "MinimumOrderQuantity": 2,
  "FixedLotMultiple": 4
}

Example 1 Response Body

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

{
  "AslId": 300100564855279,
  "ProcurementBUId": 204,
  "ProcurementBU": "Vision Operations",
  "AslScopeCode": "GLOBAL",
  "Scope": "Global",
  "ShipToOrganizationId": -1,
  "ShipToOrganization": null,
  "Item": "CM13139",
  "ItemId": 249,
  "Supplier": "Big Computers",
  "SupplierId": 1225,
  "SupplierSite": "Austin",
  "SupplierSiteId": 1225,
  "PrimaryVendorItem": null,
  "Status": "Approved",
  "AslStatusId": 2,
  "ReviewDueDate": null,
  "DisableFlag": null,
  "Comments": null,
  "AslCreationDate": "2022-10-28T16:44:02.002-05:00",
  "PurchasingUOMCode": "Ea",
  "PurchasingUOM": "Each",
  "CountryOfOriginCode": "US",
  "CountryOfOrigin": "United States",
  "MinimumOrderQuantity": 2,
  "FixedLotMultiple": 4,
  "@context": {
    "links": [
      {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855279",
        "name": "procurementApprovedSupplierListEntries",
        "kind": "item"
      },
      {
        "rel": "canonical",
        "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855279",
        "name": "procurementApprovedSupplierListEntries",
        "kind": "item"
      }
    ]
  }
}

Example 2

This example describes how to create an organization-specific approved supplier list entry without supplier item attribute values.

Example 2 Request Body

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

{
  "ProcurementBU": "Vision Operations",
  "ShipToOrganization": "Vision Operations",
  "Supplier": "Big Computers",
  "SupplierSite": "Austin",
  "Item": "CM13139",
  "Status": "Approved",
  "PrimaryVendorItem": null,
  "ReviewDueDate": null,
  "DisableFlag": null,
  "Comments": null
}

Example 2 Response Body

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

{
  "AslId": 300100564855299,
  "ProcurementBUId": 204,
  "ProcurementBU": "Vision Operations",
  "AslScopeCode": "SHIP_TO_ORG",
  "Scope": "Ship-to Organization",
  "ShipToOrganizationId": 204,
  "ShipToOrganization": "Vision Operations",
  "Item": "CM13139",
  "ItemId": 249,
  "Supplier": "Big Computers",
  "SupplierId": 1225,
  "SupplierSite": "Austin",
  "SupplierSiteId": 2939,
  "PrimaryVendorItem": null,
  "Status": "Approved",
  "AslStatusId": 2,
  "ReviewDueDate": null,
  "DisableFlag": null,
  "Comments": null,
  "AslCreationDate": "2022-10-28T16:46:45.001-05:00",
  "PurchasingUOMCode": null,
  "PurchasingUOM": null,
  "CountryOfOriginCode": null,
  "CountryOfOrigin": null,
  "MinimumOrderQuantity": null,
  "FixedLotMultiple": null,
  "@context": {
    "links": [
      {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855299",
        "name": "procurementApprovedSupplierListEntries",
        "kind": "item"
      },
      {
        "rel": "canonical",
        "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855299",
        "name": "procurementApprovedSupplierListEntries",
        "kind": "item"
      }
    ]
  }
}
Back to Top