Get one item

get

/fscmRestApi/resources/11.13.18.05/vmiItems/{VmiItemId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : vmiItems-item-response
Type: object
Show Source
  • Title: Buyer
    Read Only: true
    Maximum Length: 240
    Name of the person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.
  • Read Only: true
    Value that uniquely identifies the buyer.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the vendor-managed inventory item.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the vendor-managed inventory item.
  • Read Only: true
    Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.
  • Read Only: true
    Maximum Length: 255
    Name of the deliver-to location. This attribute isn't available to suppliers.
  • Title: In-Transit Shipments
    Read Only: true
    Aggregated quantity of the shipments for the inventory item.
  • Title: Item Number
    Read Only: true
    Value that uniquely identifies the part, item, product, or service.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the inventory planning owner for the item.
  • Title: Item Category
    Read Only: true
    Maximum Length: 255
    Category that the application assigns to the item from the default planning catalog.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item.
  • Title: Item Number
    Read Only: true
    Maximum Length: 300
    Number that identifies the part, item, product, or service.
  • 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.
  • Read Only: true
    Date and time when the replenishment data was updated.
  • Title: Last Updated Date
    Read Only: true
    User who most recently updated the vendor-managed inventory item.
  • 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
  • Title: Maximum Quantity
    Value that indicates the maximum quantity of the item that can't be exceeded in inventory.
  • Minimum-Maximum History
    Title: Minimum-Maximum History
    The Minimum-Maximum History resource gets historical minimum and maximum quantities for an item.
  • Title: Minimum Quantity
    Value that indicates the minimum quantity of the item that must be maintained in inventory.
  • 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.
  • 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.
  • Title: On Hand
    Read Only: true
    Quantity of the on-hand inventory for the inventory item.
  • 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.
  • Title: Organization
    Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization that receives the item.
  • 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.
  • Title: Organization Name
    Read Only: true
    Maximum Length: 240
    Name of the organization that receives the item.
  • Read Only: true
    Aggregated quantity of the purchase orders pending acknowledgment for the inventory item.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Name of the business unit. The application assigns the supplier to this business unit.
  • Read Only: true
    Value that uniquely identifies the business unit that manages and owns the purchasing document.
  • Title: Quantity
    Read Only: true
    Aggregated quantity of the purchase orders for the inventory item.
  • Title: Shipments in Receiving
    Read Only: true
    Aggregated quantity of the shipments received for the inventory item.
  • Title: Replenishment Quantity
    Read Only: true
    Aggregated quantity of the replenishment requests for the inventory item.
  • Read Only: true
    Value that identifies if replenishment is needed. Values include Yes, No, and Missing min-max quantities.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Value that identifies the level at which the replenishment process is managed. Values include Organization and Subinventory.
  • 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.
  • Read Only: true
    Value that uniquely identifies the location where the item is shipped.
  • Read Only: true
    Maximum Length: 255
    Name of the ship-to location.
  • 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.
  • 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.
  • Title: Subinventory Description
    Read Only: true
    Maximum Length: 50
    Description of the subinventory.
  • Read Only: true
    Value that uniquely identifies the subinventory of the organization.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 10
    Name of the subinventory.
  • 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.
  • Read Only: true
    Value that uniquely identifies the supplier number or code for the goods ordered on the order line.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 255
    Name of the supplier item.
  • Title: Supplier Name
    Read Only: true
    Maximum Length: 360
    Name of the supplier that ships the item.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure for the item.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure for the item.
  • Read Only: true
    Value that uniquely identifies the vendor-managed inventory item.
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
Nested Schema : vmiItems-minimumMaximumHistory-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the minimum and maximum quantity.
  • Title: Creation Date
    Read Only: true
    Date and time when the user create the minimum and maximum quantity.
  • Links
  • Title: Maximum Quantity
    Read Only: true
    Value that indicates the maximum quantity of the item that can't be exceeded in inventory.
  • Title: Minimum Quantity
    Read Only: true
    Value that indicates the minimum quantity of the item that must be maintained in inventory.
Back to Top

Examples

This example describes how to get one item.

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

For example, the following command gets one item:

curl -u username:password "https://servername/fscmRestApi/resources/version/vmiItems/3011"

Example Response Body

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

{
    "VmiItemId": 3011,
    "InventoryItemId": 300100106157944,
    "ItemNumber": "SCC-CPU7500U-1",
    "ItemDescription": "CPU 7500",
    "StatusCode": "ORA_VCS_VMI_OOS",
    "Status": "Out of stock",
    "SupplierItemId": null,
    "SupplierItemName": null,
    "ItemCategory": "Miscellaneous_1",
    "UnitOfMeasure": "Each",
    "UOMCode": "Ea",
    "SupplierId": 100000012050091,
    "SupplierName": "Discount CPUs",
    "OrganizationId": 209,
    "OrganizationCode": "M2",
    "OrganizationName": "Manufacturing 2",
    "ShipToLocationId": 209,
    "ShipToLocationName": "M2- Boston",
    "SubinventoryId": 300100036649120,
    "SubinventoryName": "ABCSUB01",
    "SubinventoryDescription": "Subinventory with no locator control",
    "Scope": "Subinventory",
    "ScopeCode": "ORA_VCS_SCOPE_SHIP_TO_SUB",
    "DelivertoLocationId": 209,
    "DeliverToLocationName": "M2- Boston",
    "ProcurementBUId": 204,
    "ProcurementBU": "Business Operations",
    "MinMaxQuantitySource": "Supplier",
    "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_SUP",
    "OnHandQuantity": 0,
    "OnOrderQuantity": 0,
    "PurchaseOrderQuantity": 0,
    "InTransitQuantity": 0,
    "ReceivedQuantity": 0,
    "ReplenishmentQuantity": 0,
    "PendingAcknowledgmentQuantity": 0,
    "ItemPlanner": null,
    "BuyerId": 100010026863784,
    "Buyer": "Johnson, Mark",
    "InventoryPlanningOwnerCode": "ORA_VCS_INV_OWNER_SUP",
    "InventoryPlanningOwner": "Supplier",
    "MinimumQuantity": null,
    "MaximumQuantity": null,
    "RequiringReplenishment": "Missing min-max quantities",
    "RequiringReplenishmentCode": "ORA_VCS_VMI_REQ_REPL_MQ",
    "CreatedBy": "MJones",
    "CreationDate": "2018-09-28T18:47:00.446+00:00",
    "LastUpdateDate": "2018-09-28T18:47:48.239+00:00",
    "LastUpdatedBy": "MJones",
    "LastRefreshDate": "2018-10-04T19:43:28+00:00"
}
Back to Top