Jump to

• Request
• Response
• Examples

Get all items

get

/fscmRestApi/resources/11.13.18.05/vmiItems

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 Find vendor-managed inventory items according to vendor-managed inventory item identifier.
    Finder Variables
    • VmiItemId; integer; Value that uniquely identifies the vendor-managed inventory item.
• 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:
  

  • Buyer; string; Name of the person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.
  • BuyerId; integer; Value that uniquely identifies the buyer.
  • CreatedBy; string; User who created the vendor-managed inventory item.
  • CreationDate; string; Date and time when the user created the vendor-managed inventory item.
  • DeliverToLocationName; string; Name of the deliver-to location. This attribute isn't available to suppliers.
  • DelivertoLocationId; integer; Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.
  • InTransitQuantity; integer; Aggregated quantity of the shipments for the inventory item.
  • InventoryItemId; integer; Value that uniquely identifies the part, item, product, or service.
  • InventoryPlanningOwner; string; Value that indicates the owner who creates replenishment requests for vendor-managed inventory. Value can be supplier or enterprise.
  • InventoryPlanningOwnerCode; string; Abbreviation that identifies the inventory planning owner for the item.
  • ItemCategory; string; Category that the application assigns to the item from the default planning catalog.
  • ItemDescription; string; Description of the item.
  • ItemNumber; string; Number that identifies the part, item, product, or service.
  • ItemPlanner; string; Name of the person responsible for demand and supply planning. This attribute isn't available to suppliers.
  • LastRefreshDate; string; Date and time when the replenishment data was updated.
  • LastUpdateDate; string; User who most recently updated the vendor-managed inventory item.
  • LastUpdatedBy; string; Date and time when the user most recently updated the vendor-managed inventory item.
  • MaximumQuantity; number; Value that indicates the maximum quantity of the item that can't be exceeded in inventory.
  • MinMaxQuantitySource; string; Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.
  • MinMaxQuantitySourceCode; string; Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.
  • MinimumQuantity; number; Value that indicates the minimum quantity of the item that must be maintained in inventory.
  • OnHandQuantity; number; Quantity of the on-hand inventory for the inventory item.
  • OnOrderQuantity; number; Aggregated quantity of the on-order inventory for the inventory item. On order is the summation of quantities for replenishment requests, purchase order, shipment, and receipt.
  • OrganizationCode; string; Abbreviation that identifies the organization that receives the item.
  • OrganizationId; integer; Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
  • OrganizationName; string; Name of the organization that receives the item.
  • PendingAcknowledgmentQuantity; number; Aggregated quantity of the purchase orders pending acknowledgment for the inventory item.
  • ProcurementBU; string; Name of the business unit. The application assigns the supplier to this business unit.
  • ProcurementBUId; integer; Value that uniquely identifies the business unit that manages and owns the purchasing document.
  • PurchaseOrderQuantity; number; Aggregated quantity of the purchase orders for the inventory item.
  • ReceivedQuantity; integer; Aggregated quantity of the shipments received for the inventory item.
  • ReplenishmentQuantity; number; Aggregated quantity of the replenishment requests for the inventory item.
  • RequiringReplenishment; string; Value that identifies if replenishment is needed. Values include Yes, No, and Missing min-max quantities.
  • RequiringReplenishmentCode; string; Value that uniquely identifies if replenishment is needed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REQ_REPL.
  • Scope; string; Value that identifies the level at which the replenishment process is managed. Values include Organization and Subinventory.
  • ScopeCode; string; Value that uniquely identifies the level at which the replenishment process is managed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_SCOPE.
  • ShipToLocationId; integer; Value that uniquely identifies the location where the item is shipped.
  • ShipToLocationName; string; Name of the ship-to location.
  • Status; string; Status of the item. This value is calculated as the sum of on-hand and on-order quantities compared to the minimum and maximum quantities. Value can be Out of Stock, Stock Below Minimum, Stock Above Maximum, or In Stock.
  • StatusCode; string; Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.
  • SubinventoryDescription; string; Description of the subinventory.
  • SubinventoryId; integer; Value that uniquely identifies the subinventory of the organization.
  • SubinventoryName; string; Name of the subinventory.
  • SupplierId; integer; Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
  • SupplierItemId; integer; Value that uniquely identifies the supplier number or code for the goods ordered on the order line.
  • SupplierItemName; string; Name of the supplier item.
  • SupplierName; string; Name of the supplier that ships the item.
  • UOMCode; string; Abbreviation that identifies the unit of measure for the item.
  • UnitOfMeasure; string; Unit of measure for the item.
  • VmiItemId; integer; Value that uniquely identifies the vendor-managed inventory item.
• 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 : vmiItems

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/vmiItems-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object vmiItems-item-response

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

Type: object

Show Source

• Buyer: string
  Title: Buyer

  Read Only: true

  Maximum Length: 240

  Name of the person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.
• BuyerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the buyer.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the vendor-managed inventory item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the vendor-managed inventory item.
• DelivertoLocationId: integer
  Read Only: true

  Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.
• DeliverToLocationName: string
  Read Only: true

  Maximum Length: 255

  Name of the deliver-to location. This attribute isn't available to suppliers.
• InTransitQuantity: integer (int64)
  Title: In-Transit Shipments

  Read Only: true

  Aggregated quantity of the shipments for the inventory item.
• InventoryItemId: integer (int64)
  Title: Item Number

  Read Only: true

  Value that uniquely identifies the part, item, product, or service.
• InventoryPlanningOwner: string
  Title: Inventory Planning Owner

  Read Only: true

  Maximum Length: 255

  Value that indicates the owner who creates replenishment requests for vendor-managed inventory. Value can be supplier or enterprise.
• InventoryPlanningOwnerCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the inventory planning owner for the item.
• ItemCategory: string
  Title: Item Category

  Read Only: true

  Maximum Length: 255

  Category that the application assigns to the item from the default planning catalog.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  Number that identifies the part, item, product, or service.
• ItemPlanner: string
  Title: Item Planner

  Read Only: true

  Maximum Length: 10

  Name of the person responsible for demand and supply planning. This attribute isn't available to suppliers.
• LastRefreshDate: string (date-time)
  Read Only: true

  Date and time when the replenishment data was updated.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  User who most recently updated the vendor-managed inventory item.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Date and time when the user most recently updated the vendor-managed inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumQuantity: number
  Title: Maximum Quantity

  Value that indicates the maximum quantity of the item that can't be exceeded in inventory.
• minimumMaximumHistory: array Minimum-Maximum History
  Title: Minimum-Maximum History

  The Minimum-Maximum History resource gets historical minimum and maximum quantities for an item.
• MinimumQuantity: number
  Title: Minimum Quantity

  Value that indicates the minimum quantity of the item that must be maintained in inventory.
• MinMaxQuantitySource: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.
• MinMaxQuantitySourceCode: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.
• OnHandQuantity: number
  Title: On Hand

  Read Only: true

  Quantity of the on-hand inventory for the inventory item.
• OnOrderQuantity: number
  Title: On-Order Quantity

  Read Only: true

  Aggregated quantity of the on-order inventory for the inventory item. On order is the summation of quantities for replenishment requests, purchase order, shipment, and receipt.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization that receives the item.
• OrganizationId: integer (int64)
  Title: Organization ID

  Read Only: true

  Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the organization that receives the item.
• PendingAcknowledgmentQuantity: number
  Read Only: true

  Aggregated quantity of the purchase orders pending acknowledgment for the inventory item.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Name of the business unit. The application assigns the supplier to this business unit.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit that manages and owns the purchasing document.
• PurchaseOrderQuantity: number
  Title: Quantity

  Read Only: true

  Aggregated quantity of the purchase orders for the inventory item.
• ReceivedQuantity: integer (int64)
  Title: Shipments in Receiving

  Read Only: true

  Aggregated quantity of the shipments received for the inventory item.
• ReplenishmentQuantity: number
  Title: Replenishment Quantity

  Read Only: true

  Aggregated quantity of the replenishment requests for the inventory item.
• RequiringReplenishment: string
  Read Only: true

  Value that identifies if replenishment is needed. Values include Yes, No, and Missing min-max quantities.
• RequiringReplenishmentCode: string
  Read Only: true

  Value that uniquely identifies if replenishment is needed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REQ_REPL.
• Scope: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the level at which the replenishment process is managed. Values include Organization and Subinventory.
• ScopeCode: string
  Read Only: true

  Value that uniquely identifies the level at which the replenishment process is managed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_SCOPE.
• ShipToLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location where the item is shipped.
• ShipToLocationName: string
  Read Only: true

  Maximum Length: 255

  Name of the ship-to location.
• Status: string
  Title: Status

  Read Only: true

  Status of the item. This value is calculated as the sum of on-hand and on-order quantities compared to the minimum and maximum quantities. Value can be Out of Stock, Stock Below Minimum, Stock Above Maximum, or In Stock.
• StatusCode: string
  Read Only: true

  Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.
• SubinventoryDescription: string
  Title: Subinventory Description

  Read Only: true

  Maximum Length: 50

  Description of the subinventory.
• SubinventoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the subinventory of the organization.
• SubinventoryName: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 10

  Name of the subinventory.
• SupplierId: integer (int64)
  Title: Supplier ID

  Read Only: true

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
• SupplierItemId: integer
  Read Only: true

  Value that uniquely identifies the supplier number or code for the goods ordered on the order line.
• SupplierItemName: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 255

  Name of the supplier item.
• SupplierName: string
  Title: Supplier Name

  Read Only: true

  Maximum Length: 360

  Name of the supplier that ships the item.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the item.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.
• VmiItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the vendor-managed inventory item.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the vendor-managed inventory item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InTransitQuantity":{
            "title":"In-Transit Shipments",
            "type":"integer",
            "description":"Aggregated quantity of the shipments for the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier number or code for the goods ordered on the order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "VendorId1"
                ]
            },
            "x-queryable":true
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Value that indicates the maximum quantity of the item that can't be exceeded in inventory.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "OrgMaxQuantity",
                    "OrgMinQuantity",
                    "SubInvMaxQuantity",
                    "SubInvMinQuantity"
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "type":"string",
            "description":"Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InTransitQuantity",
                    "InventoryItemId",
                    "OnHandQuantity",
                    "OnOrderQuantity",
                    "PurchaseOrderQuantity",
                    "ReceivedQuantity",
                    "ReplenishmentQuantity"
                ]
            },
            "x-queryable":true
        },
        "ItemCategory":{
            "title":"Item Category",
            "maxLength":"255",
            "type":"string",
            "description":"Category that the application assigns to the item from the default planning catalog.",
            "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"
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the item. This value is calculated as the sum of on-hand and on-order quantities compared to the minimum and maximum quantities. Value can be Out of Stock, Stock Below Minimum, Stock Above Maximum, or In Stock.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchasing document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Date and time when the user most recently updated the vendor-managed inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OnOrderQuantity":{
            "title":"On-Order Quantity",
            "type":"number",
            "description":"Aggregated quantity of the on-order inventory for the inventory item. On order is the summation of quantities for replenishment requests, purchase order, shipment, and receipt.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InTransitQuantity",
                    "InventoryItemId",
                    "OnHandQuantity",
                    "PurchaseOrderQuantity",
                    "ReplenishmentQuantity",
                    "ReceivedQuantity"
                ]
            },
            "x-queryable":true
        },
        "RequiringReplenishment":{
            "type":"string",
            "description":"Value that identifies if replenishment is needed. Values include Yes, No, and Missing min-max quantities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishmentQuantity":{
            "title":"Replenishment Quantity",
            "type":"number",
            "description":"Aggregated quantity of the replenishment requests for the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the vendor-managed inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "PurchaseOrderQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Aggregated quantity of the purchase orders for the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "PendingAcknowledgmentQuantity":{
            "type":"number",
            "description":"Aggregated quantity of the purchase orders pending acknowledgment for the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ScopeCode":{
            "type":"string",
            "description":"Value that uniquely identifies the level at which the replenishment process is managed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_SCOPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastRefreshDate":{
            "type":"string",
            "description":"Date and time when the replenishment data was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinMaxQuantitySourceCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequiringReplenishmentCode":{
            "type":"string",
            "description":"Value that uniquely identifies if replenishment is needed. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REQ_REPL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinMaxQuantitySource":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemPlanner":{
            "title":"Item Planner",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the person responsible for demand and supply planning. This attribute isn't available to suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelivertoLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId1"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToLocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the deliver-to location. This attribute isn't available to suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId1"
                ]
            },
            "x-queryable":true
        },
        "InventoryPlanningOwner":{
            "title":"Inventory Planning Owner",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the owner who creates replenishment requests for vendor-managed inventory. Value can be supplier or enterprise.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "minimumMaximumHistory":{
            "title":"Minimum-Maximum History",
            "type":"array",
            "description":"The Minimum-Maximum History resource gets historical minimum and maximum quantities for an item.",
            "items":{
                "$ref":"#/components/schemas/vmiItems-minimumMaximumHistory-item-response"
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory of the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryPlanningOwnerCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the inventory planning owner for the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "VmiItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the vendor-managed inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OnHandQuantity":{
            "title":"On Hand",
            "type":"number",
            "description":"Quantity of the on-hand inventory for the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the part, item, product, or service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedQuantity":{
            "title":"Shipments in Receiving",
            "type":"integer",
            "description":"Aggregated quantity of the shipments received for the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the item is shipped.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId1",
                    "SubinventoryId"
                ]
            },
            "x-queryable":true
        },
        "SupplierItemName":{
            "title":"Supplier Item",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "VendorId1"
                ]
            },
            "x-queryable":true
        },
        "SubinventoryName":{
            "title":"Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryDescription":{
            "title":"Subinventory Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Value that indicates the minimum quantity of the item that must be maintained in inventory.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "OrgMaxQuantity",
                    "OrgMinQuantity",
                    "SubInvMaxQuantity",
                    "SubInvMinQuantity"
                ]
            },
            "x-queryable":true
        },
        "ShipToLocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId1",
                    "SubinventoryId"
                ]
            },
            "x-queryable":true
        },
        "Scope":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the level at which the replenishment process is managed. Values include Organization and Subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"User who most recently updated the vendor-managed inventory item.",
            "format":"date-time",
            "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 : Minimum-Maximum History

Type: array

Title: Minimum-Maximum History

The Minimum-Maximum History resource gets historical minimum and maximum quantities for an item.

Show Source

• Array of: object vmiItems-minimumMaximumHistory-item-response

{
    "title":"Minimum-Maximum History",
    "type":"array",
    "description":"The Minimum-Maximum History resource gets historical minimum and maximum quantities for an item.",
    "items":{
        "$ref":"#/components/schemas/vmiItems-minimumMaximumHistory-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 : vmiItems-minimumMaximumHistory-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the minimum and maximum quantity.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user create the minimum and maximum quantity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumQuantity: number
  Title: Maximum Quantity

  Read Only: true

  Value that indicates the maximum quantity of the item that can't be exceeded in inventory.
• MinimumQuantity: number
  Title: Minimum Quantity

  Read Only: true

  Value that indicates the minimum quantity of the item that must be maintained in inventory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user create the minimum and maximum quantity.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the minimum and maximum quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Value that indicates the maximum quantity of the item that can't be exceeded in inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Value that indicates the minimum quantity of the item that must be maintained in inventory.",
            "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"
    }
}

Back to Top

Examples

This example describes how to get all items.

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/vmiItems"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "VmiItemId": 3011,
            "ItemNumber": "SCC-CPU7500U-1",
            "ItemDescription": "CPU 7500",
            "MinMaxQuantitySource": "Supplier",
            "InventoryPlanningOwner": "Supplier",
            "MinimumQuantity": null,
            "MaximumQuantity": null,
            "RequiringReplenishment": "Missing min-max quantities"
			...
        },
        {
            "VmiItemId": 3013,
            "ItemNumber": "SCC-CPU7500U-1",
            "ItemDescription": "CPU 7500",
            "MinMaxQuantitySource": "Supplier",
            "InventoryPlanningOwner": "Supplier",
            "MinimumQuantity": null,
            "MaximumQuantity": null,
            "RequiringReplenishment": "Missing min-max quantities"
			...
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/vmiItems",
            "name": "vmiItems",
            "kind": "collection"
        }
    ]
}

Back to Top