ProductGroups

This component runs the Product Group (PGS) function.

Methods

Closed
Driver Type: SASI
Use this method to change the status of one or more product groups to Closed.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft product groups.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more product groups. A product group is created if it does not exist and amended if it does.
Hidden
Driver Type: SASI
Use this method to change the status of one or more product groups to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more product groups to Open.
Query
Driver Type: Export
Use this method to obtain product group details or to extract product group data from SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to change the status of one or more product groups to Suspended/Held.

Mandatory fields

  • When creating or amending a product group, a value must be supplied for the Product Group Code - payload element <ProductGroupCode>
  • When creating product group assign conversions, a value must be supplied for the Conversion Id - payload element <ProdGrpConv_ConvId>
  • When creating or amending a product group unit labels, a value must be supplied for Unit Label Code - payload element <UnitLabelCode>
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.

Related data

  • Product Group Assign Conversions
  • Product Group Unit Labels
  • Standard Text
  • Standard Text Language

The attachment of Standard Text is supported by the CreateOrAmend and CreateAsDraft methods. If the standard text supplied in the payload does not exist then it is created. However, it is not possible to amend existing standard text by this means; existing standard text is attached by key only, and any non-key fields in the SSC payload are ignored. Standard text can be amended using the Standard Text Language Variants function from SunSystems or the SSC component StandardTextLanguageVariants.

The standard text to be attached is language specific and therefore must be included within the StandardTextLang part of the payload in order to be detected by the SSC component, as shown in the following example:

<ProductGroups>
	...
		<StandardText>
			<StandardTextLang>
				<Description>Delivery</Description>
				<LanguageCode>1</LanguageCode>
				<Paragraph1>Follow the special Instructions on the Invoice</Paragraph1>
				<ShortHeading>Delivery</ShortHeading>
				<StandardTextClassCode>SALES</StandardTextClassCode>
				<StandardTextCode>DELIVERY</StandardTextCode>
			</StandardTextLang>
		</StandardText>
</ProductGroups>