Inventory Manager Web Service

This chapter provides an overview of the Inventory Manager web service, lists a prerequisite, and discusses these web service operations:

Click to jump to parent topicUnderstanding the Inventory Manager Web Service

The InventoryManager web service (JP410000) manages the processing of inventory-related web service operations. This table includes a description of the inventory web service operations:

Operation

Description

processSupplierCatalogPrice (J4100002)

Use this operation to add and change supplier catalog prices within the JD Edwards EnterpriseOne Inventory Management system.

processInventoryItem (J4100003)

Use this operation to add and change inventory item master records within the JD Edwards EnterpriseOne Inventory Management system.

getBranchPlantItem (J4100004)

Use this operation to query the JD Edwards EnterpriseOne database for existing item branch/plant records.

getSupplierCatalogPrice (J4100005)

Use this operation to query the JD Edwards EnterpriseOne database for existing supplier catalog prices.

getItemAvailability (J4100001)

Use this operation to query the JD Edwards EnterpriseOne database for existing item availability.

insertInventoryItemStaging (J4100006)

Use this operation to insert inventory item staging records within the JD Edwards EnterpriseOne database.

Accessing Javadoc for the Inventory Manager Web Service Operations

To access Javadoc for the Inventory Manager web service and its related operations, review these Javadoc packages:

See Accessing Javadoc for Business Services.

Reviewing Input and Response Interfaces

To review information about the classes and fields that are used by these web service operations, you can review the input and response interface tables. Input and response interface tables list the classes and fields used by each operation, the key fields, the data types of each fields, and which fields or classes are required for each action.

See Accessing Additional Information about Business Services, Appendix A: Input and Response Interfaces.

Click to jump to parent topicPrerequisite

Before using the Inventory Manager web service, or any of the related web service operations, you must install and configure the JD Edwards EnterpriseOne Inventory Management system.

See Getting Started with JD Edwards EnterpriseOne Inventory Management.

Click to jump to parent topicprocessSupplierCatalogPrice

This section provides an overview of the processSupplierCatalogPrice web service operation.

Click to jump to top of pageClick to jump to parent topicUnderstanding the processSupplierCatalogPrice Web Service Operation

The processSupplierCatalogPrice web service operation is an inbound transaction operation that enables consumers to process supplier catalog price information within the JD Edwards EnterpriseOne system. The consumer can add and change supplier catalog price records in the JD Edwards EnterpriseOne Inventory Management system. The system updates the Supplier Price/Catalog File table (F41061).

If the operation is successful, the system returns a confirmation message to the consumer which includes supplier catalog data.

If the operation fails, the system returns an error message to the consumer. When an error is encountered during processing of the processSupplierCatalogPrice web service operation, any changes to the F41061 that occurred as a result of the web service operation being run are rolled back.

The processSupplierCatalogPrice web service operation verifies that values are provided for both the start and end effective dates. If no value is provided for the start date then today’s date is assigned to the start date. If no value is provided for the end date then December 31st of the current year is assigned to the end date. The processSupplierCatalogPrice web service operation retrieves the currency code from the specified supplier or, if the supplier does not exist, the specified business unit’s company. If a currency code is specified, the currency code lookup is bypassed. The processSupplierCatalogPrice web service operation retrieves the cost level for a specified item and the appropriate unit of measure (purchasing or primary) from the Item Master table (F4101) as specified in the distribution constants. If a unit of measure is specified, the unit of measure lookup is bypassed.

The table illustrates the supported action codes for the processSupplierCatalogPrice web service operation:

Action Type

Action Code

Add

1, A, I

Update

2, U, C

Supported Functionality

This section discusses the functionality that the processSupplierCatalogPrice operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The operation supports adding new supplier catalog prices and updating existing supplier catalog prices.

This web service operation does not support deleting supplier catalog prices. The operation also does not support adding or modifying supplier catalog prices for items with a cost level of 3.

Implementation Details

The following table includes information that can help determine whether the processSupplierCatalogPrice operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, the system returns non-zero values for these fields:

  • supplier

  • item

  • currencyCode

  • unitOfMeasureCode

  • dateEffectiveStart

  • dateEffectiveEnd

The web service operation always returns an exception in the response if the operation fails to complete successfully.

If I encounter errors while processing a transaction, do I need to reverse the transaction?

This operation uses standard transaction processing. Therefore, if you encounter errors during processing, the system does not update any information in the JD Edwards EnterpriseOne system. If the supplier catalog price action encounters errors, the transaction stops processing and the system rolls back the information in the tables. No manual update is necessary.

Does this operation use record reservation?

No. This operation does not reserve records.

Click to jump to parent topicprocessInventoryItem

This section provides an overview of the processInventoryItem web service operation and lists prerequisites.

Click to jump to top of pageClick to jump to parent topicUnderstanding the processInventoryItem Web Service Operation

The processInventoryItem web service operation is an inbound transaction operation that enables consumers to process inventory item information within the JD Edwards EnterpriseOne system. The consumer can add and change inventory item master records in the JD Edwards EnterpriseOne Inventory Management system.

Note. The data provided for item master insertion must be in the JD Edwards EnterpriseOne format as no formatting is performed before item master insertion in JD Edwards EnterpriseOne begins. Also, codes must be values in the JD Edwards EnterpriseOne system.

If the operation is successful, the system returns a confirmation message to the consumer. The messages includes inventory item data.

If the operation fails, the system returns an error message to the consumer.

Supported Functionality

This section discusses the functionality that the processInventoryItem operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The consumer can add and change inventory item master records in the JD Edwards EnterpriseOne Inventory Management system.

The processInventoryItem web service operation does not support the cancellation of inventory items.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes inventory item information. This table includes information about the business service properties that the processInventoryItem web service operation uses:

Group

Key

Description

Default Value

J4100003

J4100003_ITEM_MBF_VERSION

Use this business service property to specify which version of the Item Master program (P4101) the operation uses.

See Setting Processing Options for Item Master (P4101).

ZJDE0001

J4100003

J4100003_ITEM_STOCKING_TYPE_CODE

Use this business service property to specify the stocking type code that the operation uses for an add request if the code is not provided.

S

Implementation Details

The following table includes information that can help determine whether the processInventoryItem operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, the system returns non-zero values in the itemId field.

If I encounter errors while processing a transaction, do I need to reverse the transaction?

This operation uses standard transaction processing. Therefore, if you encounter errors during processing, the system does not update any information in the JD Edwards EnterpriseOne system. No manual update is necessary.

Does this operation use record reservation?

This operation reserves the inventory record immediately when an update is requested by the consumer.

Click to jump to top of pageClick to jump to parent topicPrerequisites

Before using the processInventoryItem operation, you must set the processing options for the Item Master program (P4101).

See Setting Processing Options for Item Master (P4101).

Click to jump to parent topicgetBranchPlantItem

This section provides an overview of the getBranchPlantItem web service operation.

Click to jump to top of pageClick to jump to parent topicUnderstanding the getBranchPlantItem Web Service Operation

The getBranchPlantItem web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve existing branch/plant item records. The operation invokes a database operation to retrieve branch/plant item information from the F4101 and Item Branch File (F4102) tables in JD Edwards EnterpriseOne based on the selection criteria specified in the value object.

Note. The data provided for selection must be in the JD Edwards EnterpriseOne format. No formatting is performed before the query is made. Also, codes must be values in the JD Edward EnterpriseOne system.

If the operation is successful, the system returns zero to many records to the consumer. You can specify the maximum number of records to return during a query using the Max Rows business service property. If the operation fails, the system returns an error message to the consumer.

The getBranchPlantItem web service operation enables source systems to query JD Edwards EnterpriseOne branch/plant item information in a real-time fashion. The query contains fields that can be used to filter the branch/plant item information retrieved by JD Edwards EnterpriseOne. ShowBranchPlant is returned during a successful query.

Supported Functionality

This section discusses the functionality that the getBranchPlantItem operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The getBranchPlantItem web service operation enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve existing branch/plant item records.

The getBranchPlantItem operation does not support the wildcard (asterisk (*)) for search criteria.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes inventory item information. This table includes information about the business service properties that the getBranchPlantItem web service operation uses:

Group

Key

Description

Default Value

J4100004

J4100004_V4102XPI2_MAX_GRID_ROWS_RETURNED

Use this business service property to define the maximum number of rows that the operation returns when querying the JD Edwards EnterpriseOne database.

100

Note. It is strongly recommended that you set this business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database. The system returns an error if you perform a query with no selection criteria and this business service property is set to 0.

Implementation Details

The following table includes information that can help determine whether the getBranchPlantItem operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns records that match your search criteria. These records include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, if the query finds matching records, the system returns non-zero values for these fields:

  • branchPlant

  • supplier

  • buyer

  • itemId

If I encounter errors while processing a transaction, do I need to reverse the transaction?

This is a database query operation that does not perform transactions.

If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database.

Does this operation use record reservation?

No. This operation does not reserve records that are returned in a query.

Click to jump to parent topicgetSupplierCatalogPrice

This section provides an overview of the getSupplierCatalogPrice web service operation.

Click to jump to top of pageClick to jump to parent topicUnderstanding the getSupplierCatalogPrice Web Service Operation

The getSupplierCatalogPrice web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve existing supplier catalog price information. The operation retrieves supplier catalog price information from fields in the Supplier Price/Catalog File table (F41061).

If the operation is successful, the system returns zero to many records to the consumer. You can specify the maximum number of records to return during a query using the Max Grid Rows Returned business service property. If the operation fails, the system returns an error message to the consumer.

Note. The data provided for selection must be in the JD Edwards EnterpriseOne format. No formatting is performed before the query is made.

Supported Functionality

This section discusses the functionality that the getSupplierCatalogPrice operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The getSupplierCatalogPrice web service operation enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve existing supplier catalog price information.

The getSupplierCatalogPrice operation does not support the wildcard (asterisk (*)) for search criteria.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes supplier catalog price information. This table includes information about the business service properties that the getSupplierCatalogPrice web service operation uses:

Group

Key

Description

Default Value

J4100005

J4100005_F41061_MAX_GRID_ROWS_RETURNED

Use this business service property to define the maximum number of rows that the operation returns when querying the JD Edward EnterpriseOne database.

100

Note. It is strongly recommended that you set this business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database.

Implementation Details

The following table includes information that can help determine whether the getSupplierCatalogPrice operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns records that match your search criteria. These records include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, if the query finds matching records, the system returns non-zero values for these fields:

  • entityIdSupplier

  • itemId

  • itemProduct

  • itemCatalog

  • currencyCode

  • unitOfMeasureCode

The operation may complete successfully without returning rows because the selection criteria did not match any records in the database or an open query was performed and there were no records. This is considered successful and provides valid information.

If I encounter errors while processing a transaction, do I need to reverse the transaction?

This is a database query operation that does not perform transactions.

If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database.

Does this operation use record reservation?

No. This operation does not reserve records that are returned in a query.

Click to jump to parent topicgetItemAvailability

This section provides an overview of the getItemAvailability web service operation.

Click to jump to top of pageClick to jump to parent topicUnderstanding the getItemAvailability Web Service Operation

The getItemAvailability web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve item availability information.

The getItemAvailability web service operation calls the InvRealTimeItemAvailability business function (B4101640) to fetch item availability. You must specify itemId, businessUnit, and unitOfMeasure as inputs to the query. If the operation is successful, the system returns item availability data. If the operation fails, the system returns an error message to the consumer.

Supported Functionality

This section discusses the functionality that the getItemAvailability operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The getItemAvailability web service operation enables consumers to query the JD Edwards EnterpriseOne Inventory Management system to retrieve item availability information.

The getItemAvailability operation does not support the wildcard (asterisk (*)) for search criteria.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes item availability information. This table includes information about the business service properties that the getItemAvailability web service operation uses:

Group

Key

Description

Default Value

J4100001

J4100001_ERROR_PREFIX_1

Use this business service property to specify the prefix value the operation uses for error messages.

Get Item Availability Sent In:

Implementation Details

The following table includes information that can help determine whether the getItemAvailability operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns records that match your search criteria. These records include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, if the query finds matching records, the system returns non-zero values for these fields:

  • businessUnit

  • transactionUnitOfMeasure

  • quantityAvailable

  • itemId

If I encounter errors while processing a transaction, do I need to reverse the transaction?

This is a database query operation that does not perform transactions.

If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database.

Does this operation use record reservation?

No. This operation does not reserve records that are returned in a query.

Click to jump to parent topicinsertInventoryItemStaging

This section provides an overview of the insertInventoryItemStaging web service operation.

Click to jump to top of pageClick to jump to parent topicUnderstanding the insertInventoryItemStaging Web Service Operation

The insertInventoryItemStaging web service operation is a database insert operation that enables consumers to insert one to many inventory item records into the staging table in the JD Edwards EnterpriseOne database.

The insertInventoryItemStaging web service operation uses auto commit transaction processing. Since inventory item records are autonomous, each inventory item staging record is immediately added to the F4101 Item Master Unedited Transaction Table (F4101Z1) and the entire group is not rolled back if an error occurs. If the operation is successful, the system inserts one to many records. You can specify the maximum number of records to insert using the Max Rows business service property.

If the operation fails, the system returns an error message to the consumer. The records that return an error will not be inserted into the database. However, records that do not error are committed to the database even if other records in the same transaction fail.

If all rows passed in were not inserted into the staging table, then the system returns an error message. The Max Rows business service property limits the number of inserted records. The consumer then sends the data in groups less than the Max Rows business service property or changes the Max Rows business service property to 0 (zero) so that all records are inserted.

Note. The data provided for insertion must be in the JD Edwards EnterpriseOne format. No formatting is performed before the insert is made.

Supported Functionality

This section discusses the functionality that the insertInventoryItemStaging operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

The operation supports the insert of one to many inventory item records into the staging table in the JD Edwards EnterpriseOne database.

This web service operation does not support changing or deleting inventory item staging records.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes inventory item staging records. This table includes information about the business service properties that the insertInventoryItemStaging web service operation uses:

Group

Key

Description

Default Value

J4100006

J4100006_MAX_ROWS

Use this business service property to define the maximum number of rows that the operation inserts in the JD Edward EnterpriseOne database.

999

J4100006

J4100006_ITEM_STOCKING_TYPE_CODE

Use this business service property to specify the stocking type code that the operation uses for the insert if the code is not provided.

S

Note. The Max Rows business service property limits the number of inserted records. Either send the data in groups less than the Max Rows business service property or change the Max Rows service constant to 0 (zero). If you set this value to 0, the system inserts all records.

Implementation Details

The following table includes information that can help determine whether the insertInventoryItemStaging operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns a confirmation message to the consumer that includes the number of rows that were inserted into the F4101Z1 table.

If I encounter errors while processing a transaction, do I need to reverse the transaction?

No, records that return an error are not inserted into the database. Records that do not return an error are committed to the database even if other records in the same transaction fail.

If you encounter errors during processing, review your insertion criteria and business service property settings and try your insert again.

Does this operation use record reservation?

No. This operation does not reserve records.