Ship(ShipSetup) Method

Setup object for API invocation.

Causes the specified part request to be shipped.

This overload takes a setup object.

Syntax

'Declaration

Public Overloads Function Ship( _
   ByVal _setupParam_ ShipSetup _
) As ToolkitResult

public ToolkitResult Ship(
   ShipSetup _setupParam_
)

Parameters

setupParam

Setup object for API invocation.

Return Value

The following values are populated in the ToolkitResult object returned by the API method:

• Objid - Objid of the ship_parts record.

Remarks

By default, all the shipping information parameters will default to the Part Request Header's shipping site and contact information. 

If no status is provided, the default status will be used (for condition 'Shipped').

If no carrier name is provided, the dummy site will be used (objid of -2).

NOTE: This API will validate that the user has authority to make the status transition.

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.ShipSetup