Retail Group API

This topic describes the retail group APIs for the Integration Framework.

API

Name Description
void Delete(LogonInfo, RecordIdentifier)

Delete a retail group.

Parameters:

  • logonInfo: Login information for the database
  • retailGroupID: The ID of the retail group to delete
void Get(LogonInfo, RecordIdentifier)

Get a retail group.

Parameters:

  • logonInfo: Login information for the database
  • retailGroupID: The ID of the retail group to get
void Save(LogonInfo, RetailGroup)

Save a retail group.

Parameters:

  • logonInfo: Login information for the database
  • retailGroup: The retail group to save
RetailGroupsSaveResult SaveList(LogonInfo, List<RetailGroup>)

Save multiple retail groups.

Parameters:

  • logonInfo: Login information for the database
  • retailGroups: The retail groups to save

 

Business objects

The following business objects are used by the retail group API.

Name Description
ID The ID of the retail group.
ItemSalesTaxGroupId The default sales tax group ID used for items added to this group.
MasterID The unique identifier of the retail group.
ProfitMargin The default profit margin of the retail group.
RetailDepartmentID The retail department ID to which this group belongs to.
RetailDepartmentID The unique identifier of the retail department.
Text The name the retail group.
ValidationPeriod The ID of the validation period used for this group.

For a retail group object to be valid the ID and Text properties must be set.

Name Description
RetailGroupsSaveResult A list of objects containing the retail groups that failed the saving process along with the error message.
EndTime The time at which the saving process finished.
StartTime The time at which the saving process started.
Success True if the saving process finished successfully.

 

Examples

To update retail groups you must use the optimized update feature.

Updating a retail group


	RetailGroup group = wcfRetailGroupService.Get(CreateLogonInfo(dataModel), "0000001");
	group.Text += "-Updated";
	group.ProfitMargin = 2.00;

	((IOptimizedUpdate) group).CloneUpdateListToTransportList();
	wcfRetailGroupService.Save(CreateLogonInfo(dataModel), group);

In the above example, firstly we get an existing retail group through the Integration Framework, update it, then we clone the update list using the optimized update functionality. After we update all properties accordingly we save the retail group through the Integration Framework.

Deleting a retail group


	wcfRetailGroupService.Delete(CreateLogonInfo(dataModel), "0000001");

See also