Warehouses

This component runs the Warehouses (WHS) function and allows you to set up and maintain warehouse details.

You can also set up Warehouse Groups to link specific warehouses together. For example, if they are located in the same geographical area.

Note: You can maintain details of the linked warehouses using the SunSystems Warehouse Group (WHG) function or via payloads using the WarehouseGroups component.

Methods

Closed
Driver Type: SASI
Use this method to change the status of one or more warehouses to Closed.
Create
Driver Type: SASI
Use this method to create one or more warehouses. This method only creates a warehouse. If the warehouse already exists, an error message is produced and the payload is rejected.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft warehouses.
CreateOrAmend
Driver Type: SASI
This method creates a warehouse if it does not exist already and amends it if it does. Whereas the Create method depends on you to know whether the data exists in advance, this method can be used if you are unsure.
Delete
Driver Type: SASI
Use this method to delete a warehouse.
DeleteChildData
Driver Type: SASI
Use this method to delete child data (Assign to Warehouse Groups, Document Formats, Storage Characteristics) but retain the parent record (Warehouse).
It is also possible to delete 'grandchild' data. The deletion of child and grandchild data is controlled by a <DeletionFlag> node at child level. If the flag is set to Y, both child and grandchild is deleted. Otherwise, the child data is retained.
For example, the <Characteristics> node contains child data, and the <NumericValues> node contains grandchild data. The <DeletionFlag> node is set to Y, so the <DiscreteValueNumeric> data is deleted first, followed by the <CharacteristicCode> data:
<Warehouses>
		<WarehouseCode>TEST</WarehouseCode>
		<Characteristics>
				<DeletionFlag>
						<DeleteCharacteristicAfterDiscreteValue>Y</DeleteCharacteristicAfterDiscreteValue>
				</DeletionFlag>
				<CharacteristicCode>CHILLED</CharacteristicCode>
				<NumericValues>
						<DiscreteValueNumeric>2</DiscreteValueNumeric>
				</NumericValues>
		</Characteristics>
</Warehouses>
Hidden
Driver Type: SASI
Use this method to change the status of one or more warehouses to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more warehouses to Open.
Query
Driver Type: Export
Use this method to obtain warehouse details or to extract warehouse data from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to change the status of one or more warehouses to Suspended/Held.

Mandatory fields

General
  • When creating, amending or deleting a warehouse, a value must be supplied for Warehouse Code - payload element <WarehouseCode>
  • When assigning a warehouse to a warehouse group, a value must be supplied for Warehouse Group Code - payload element <WarehouseGroupCode>.
Warehouse Analysis
When creating or amending warehouse analysis entries, a value must be supplied for Analysis Code - payload element <VWhseCatAnalysis_AnlCode>.
Warehouse Accounts
When creating or amending warehouse accounts, a value must be supplied for:
  • Account Recognition Code - payload element <AccountRecognitionCode>
  • Account Code - payload element <AccountCode>.
Warehouse Storage Characteristics
When creating or amending warehouse storage characteristics, a value must be supplied for Characteristics Code - payload element <CharacteristicsCode>.
Warehouse Document Formats
When creating or amending warehouse document formats, values for one or more of the following must be supplied:
  • Document Format Code - payload element <DocumentFormatCode>
  • Movement Order Stage - payload element <MovementOrderStage>
  • Movement Order Definition - payload element <MovementOrderDefinition>.
Deleting Child Data
  • When deleting child data, a value must be supplied for Warehouse Code - payload element <WarehouseCode>
  • When deleting Assign to Warehouse Group child data, a value must be supplied for Warehouse Group Code - payload element <WarehouseAssignToWhseGroups.WarehouseGroupCode>
  • To delete Storage Characteristic data, or establish the key of the Discrete Value data to be deleted, a value must be supplied for Characteristics Code - payload element <StorageCharacteristics.CharacteristicsCode>
  • If Discrete Value is to be deleted, then depending on whether Storage Characteristics has Numeric or Alphanumeric Discrete Values, a value must also be supplied from one of:
    • Discrete Value Alphanumeric - payload element <StorageCharacteristics.DiscreteValuesAlpha.DiscreteValueAlphanumeric>
    • Discrete Value Numeric - payload element <StorageCharacteristics.DiscreteValuesNum.DiscreteValueNumeric>
  • When deleting Document Format child data, a value must be supplied for:
    • Movement Order Stage - payload element <DocumentFormats.MovementOrderStage>
    • Movement Order Definition - payload element <DocumentFormats.MovementOrderDefinition>
  • Note: 
    • At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.
    • Locations data is maintained via Inventory Locations (ILC) within SunSystems, or via the InventoryLocations SSC component.

Related data

  • Warehouse Groups
  • Storage Characteristics
  • Document Formats
  • Warehouse Locations including Storage Locations Assign Storage Characteristics (export only)
  • Warehouse Analysis 1-10
  • Account Recognition Code.