BackorderPartRequest(BackorderPartRequestSetup) Method

Setup object for API invocation.

Allows for the backordering of inventory parts for a part request. This overload takes a setup object.

Syntax

'Declaration

Public Overloads Function BackorderPartRequest( _
   ByVal _setupParam_ BackorderPartRequestSetup _
) As ToolkitResult

public ToolkitResult BackorderPartRequest(
   BackorderPartRequestSetup _setupParam_
)

Parameters

setupParam

Setup object for API invocation.

Return Value

A ToolkitResult instance with no properties set. The properties (Objid, IDNum, etc.) are not relevant to this API.

Remarks

As in base Clarify, if a partial backorder is performed, the part request is broken up into two new part requests. The first is for the backorder (and the quantities are changed). The new part request will be created to hold the rest of the units that did not get backordered.

This API will validate that the part request can be transitioned (for the specified user) to the proper new condition.

This API will work with either quantity or serialized parts, based on the part number/site_part of the part request. If a serial number is specified, it will be used. Otherwise, the serial number will be taken from the part request.

To use primary bin suggestions/recommendations, please see the remarks on the ToLocation and/or FromLocation properties on the BackorderPartRequestSetup object.

To allow for multiple calls to this API to be performed without extra complex transitions being added to the system, set the UseTransitions property of the BackorderPartRequestSetup object, or the useTransitions parameter of the respective overloads to false. Note that the last call to BackorderPartRequest in the chain of calls should have this value set to true to ensure the transitions are checked and the condition/status is updated properly.

NOTE: This API requires two other APIs (PartTransfer and CreatePartRequestDetail) to work correctly.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server family

Reference

LogisticsToolkit Class LogisticsToolkit Members Overload List FChoice.Toolkits.Clarify~FChoice.Toolkits.Clarify.Logistics.BackorderPartRequestSetup