ASP.NET Web API Help

Introduction

Welcome to the documentation for the EMC API

Accelerator

POS Shortcuts / "Accelerators"

API	Description
GET api/accelerators	Gets a list of accelerators
POST api/accelerators	Save or update an accelerator
DELETE api/accelerators	Delete accelerator

Account

Retail Customer Accounts

API	Description
GET api/accounts?Take={Take}&Skip={Skip}&Search={Search}&Active={Active}&AccountType={AccountType}&AccountStoreGroupGuid={AccountStoreGroupGuid}&IncludeDeleted={IncludeDeleted}&Updated={Updated}	Find accounts
GET api/account/{id}?relations={relations}	Retrieves an Account and its related records via its unique identifier
GET api/accounts/ageing	Get list of ageing periods for all accounts
GET api/account/findexternal/{externalid}?relations={relations}	Retrieves an Account and its related records via its External ID
GET api/account/{refno}/reference?relations={relations}	Retrieve an account and related records using reference number
DELETE api/account/{id}	Safely deletes an Account
POST api/accounts	Updates an Account record
POST api/account/{id}	Updates an Account record
GET api/account/{refno}/reference/exists	Find an account identifier using reference number
GET api/account/{id}/card	Retrieve an Account's customer card
POST api/account/{guid}/card/{id}	Create or update an account card
POST api/account/card/{id}?guid={guid}	Create or update an account card
GET api/account/{id}/members	List customers belonging to an account
POST api/account/{id}/members	Add a customer to the account customer group
DELETE api/account/{id}/member/{customerID}	Remove a customer from the account customer group
POST api/account/adjust/{id}	this api is dedicated for EMC frontend to make account adjustment
POST api/account/{id}/adjust	this api is dedicated for EMC frontend to make account adjustment
POST api/account/AdjustAccount/{id}	this api is dedicated for POS to create pending data)
POST api/account/{id}/AdjustAccount	this api is dedicated for POS to create pending data)
GET api/customer/{id}/accounts	Find customer accounts, based on account owner or member of group account customer group
GET api/account/{id}/groups	Find any existing customer groups with this account as the account
GET api/account/{id}/reportemails?Active={Active}&ExcludeSentStatements={ExcludeSentStatements}	Get a list of account owner emails for a report
GET api/account/{id}/accountSubLedger?take={take}&skip={skip}	Get ledger entries for an account
GET api/account/{id}/accountPending	Get pending entries for an account
GET api/account/adjustmentTypesFromLedgers	Get adjustment type entries from ledgers
GET api/account/adjustmentTypes	Get adjustment type entries
POST api/account/adjustmentTypes	save adjustment type
DELETE api/account/adjustmentType/{id}	delete adjustment type
GET api/account/{id}/allocatedPayments?take={take}&skip={skip}&search={search}	Get allocated payments for an account
GET api/account/{id}/allocatedCharges?take={take}&skip={skip}&search={search}	Get allocated charges for an account
GET api/account/{id}/unallocatedPayments?take={take}&skip={skip}&search={search}	Get unallocated payments for an account
GET api/account/{id}/unallocatedCharges?take={take}&skip={skip}&search={search}	Get unallocated charges for an account
POST api/account/cancelAllocation/payment/{id}	payment allocation reverting
POST api/account/cancelAllocation/charge/{id}	charge allocation reverting
POST api/account/allocate	do allocations for selected payments and charges
GET api/account/{id}/accountSubLedgerBalance	Get account balance from sub ledgers
POST api/account/import	Imports a list of accounts

AccountingCategory

API	Description
GET api/AccountingCategory	No documentation available.
PUT api/AccountingCategory	No documentation available.
POST api/AccountingCategory	No documentation available.
DELETE api/AccountingCategory/{ID}	No documentation available.

AccountingExport

API	Description
GET api/store/{storeID}/AccountingExportMappers?AccountingExportMethod={AccountingExportMethod}&AccountingProvider={AccountingProvider}&Relations={Relations}	No documentation available.
GET api/store/{storeID}/AccountingExportMapper/{ID}?relations={relations}	No documentation available.
POST api/store/{storeID}/AccountingExportMapper	No documentation available.
PUT api/store/{storeID}/AccountingExportMapper/{ID}	No documentation available.
DELETE api/store/{storeID}/AccountingExportMapper/{ID}	No documentation available.

AccountSettings

API	Description
GET api/accountSettings/{id}	Get an account setting
PUT api/accountSettings/{id}	Store an account setting

AccountStoreGroup

API	Description
GET api/accountStoreGroups?Take={Take}&Skip={Skip}&Search={Search}	No documentation available.
GET api/accountStoreGroup/{id}	No documentation available.
POST api/accountStoreGroups	No documentation available.
PUT api/accountStoreGroup/{id}	No documentation available.
DELETE api/accountStoreGroup/{id}	No documentation available.

Adverts

API	Description
POST api/adverts	Save advert files (images and videos) onto disk and create thumbnails onto database
GET api/adverts?Skip={Skip}&Take={Take}&Name={Name}&Search={Search}&OrderBy={OrderBy}&Sort={Sort}	List all advert DB entries
GET api/advert/{ID}	Image preview
DELETE api/advert/{ID}	Delete an advert by ID
GET api/advert/{name}/exists	No documentation available.
GET api/advert/{ID}/download	Respond with file content

Allergen

Allergens controller

API	Description
GET api/allergens?IncludeDeleted={IncludeDeleted}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get list of allergens
GET api/allergen/{id}	Get allergen
GET api/allergen/{id}/ingredients	Get allergen ingredients
POST api/allergens	Add or save allergen
PUT api/allergen/{id}	Save or Update an allergen
POST api/allergen/{id}/ingredients	Update the list of allergen ingredients
PUT api/allergen/{id}/ingredient/{ingredientID}	Update an allergen ingredient
DELETE api/allergen/{id}	Delete an allergen

Apn

Barcodes

API	Description
GET api/apns?Take={Take}&Skip={Skip}&StoreID={StoreID}&IncludeDeleted={IncludeDeleted}	Get all plu apns
GET api/store/{storeID}/apns?Take={Take}&Skip={Skip}&IncludeDeleted={IncludeDeleted}	Get all plu apns
GET api/Apn/Get/{id}	Formats an EAN
GET api/Apn/Valid/{id}	Returns true if valid EAN

ApplicationInfo

Web Application information

API	Description
GET api/status	Used for load balancing and health monitoring
GET api/applicationinfo	No documentation available.
GET api/versioninfo	EMC version information for communication
GET api/speed	No documentation available.

AutoOrder

Auto order generation and updating

API	Description
GET api/autoOrders	Gets a list of auto order headers
GET api/autoOrder/{id}	Get Auto Order Header
GET api/autoOrder/{id}/detail/{guid}	Get Auto Order detail
GET api/autoOrder/{id}/boosts	Get boost days for auto order
GET api/autoOrder/{id}/total	Get total for this order
GET api/order/{id}/autoOrder	Find the identifier of the auto order header for an order if it exists
POST api/autoOrders	Save/Create Auto Order Header
PUT api/autoOrder/{id}	Save Auto Order Header
POST api/autoOrder/{id}/clone	No documentation available.
POST api/autoOrder/{id}/details/filter	Find and process matching products into auto order
PUT api/autoOrder/{id}/details/filter	Find and process matching products into auto order, replacing existing details
POST api/autoOrder/{id}/product/{pluGuid}	Add a new Auto Order detail and process for auto order
POST api/autoOrder/{id}/update	Update Auto Order
POST api/autoOrder/{id}/process	Process Auto Order
POST api/autoOrder/{id}/complete	Complete Auto Order and send
POST api/autoOrder/{id}/detail/{guid}	Save Auto Order Detail
PUT api/autoOrder/{id}/boost/{day}	Update/Add boost day
POST api/autoOrder/{id}/detail/{guid}/process	Process Auto Order Detail
POST api/autoOrder/{id}/detail/{guid}/update	Update Auto Order Detail
DELETE api/autoOrder/{id}	Delete order
DELETE api/autoOrder/{id}/detail/{guid}	Delete auto order detail
DELETE api/autoOrder/{id}/details/zero	Delete all order details
DELETE api/autoOrder/{id}/details	Delete all auto order details
DELETE api/autoOrder/{id}/boost/{day}	Remove Boost day
POST api/order/{id}/autoOrders	Create Auto Order from Order

Barcode

Read barcodes using barcode templates

API	Description
GET api/barcode/{id}?template={template}	Match barcode against template
POST api/barcode/{id}	Match barcode against templates

BarcodeFormat

For Barcode Printing

API	Description
GET api/barcodeformats	Get the barcode formats
POST api/barcodeformat/{id}	Save barcode format
POST api/barcodeformats	Save barcode formats
PUT api/barcodeformat/{id}	Save barcode format
DELETE api/barcodeformat/{id}	Delete barcode format

BarcodeTemplate

Barcode template management

API	Description
GET api/barcodetemplates	Get barcode templates
GET api/barcodetemplates?function={function}	Get barcode templates based on function
POST api/barcodetemplate	Save barcode templates
POST api/barcodetemplates	Save barcode templates
POST api/barcodetemplate/{id}	Save barcode template
PUT api/barcodetemplate/{id}	Save barcode template
DELETE api/barcodetemplate/{id}	Delete a barcode template
POST api/barcodetemplate/sort	Sort barcode templates

Browser

API	Description
GET api/browser/security/user/{id}	No documentation available.
GET api/browser/security/key/{key}	No documentation available.
PUT api/browser/security/key/{key}	No documentation available.
POST api/browser/security/key/{key}	No documentation available.
DELETE api/browser/security/key/{key}	No documentation available.
GET api/browser/users?search={search}	No documentation available.
GET api/browser/user/{id}	No documentation available.
GET api/browsers?Search={Search}&Status={Status}	No documentation available.
GET api/browser/{id}	No documentation available.
DELETE api/browser/{id}	No documentation available.
POST api/browser/{id}/status/{status}	No documentation available.
PUT api/browser/{id}/status/{status}	No documentation available.
GET api/browser/whitelist/{key}	No documentation available.
GET api/browser/ipwhitelist/{key}	No documentation available.
POST api/browser/whitelist/{key}	No documentation available.

Campaign

Campaigns, promotions, price changes and selling rules

API	Description
GET api/campaigns	Get campaigns
GET api/campaign/name/{name}?relations={relations}	Get campaign
GET api/campaign/{name}?relations={relations}	Get campaign
POST api/campaign/{name}	Create or update campaign
POST api/campaigns	Create or update campaign
POST api/priceGroup/{id}/campaigns	Create Campaign and add price group products to campaign plus
PUT api/campaign/{name}	Create or update campaign
DELETE api/store/{storeID}/campaign/{name}	Delete a campaign from a store
DELETE api/campaign/{name}	Delete a campaign
POST api/store/{storeID}/campaign/{name}/delete	Safely delete campaign from a store
POST api/campaign/{name}/delete	Safely delete campaign
POST api/store/{storeID}/campaign/{name}/refresh	Send campaign record to its stores
POST api/campaign/{name}/refresh	Send campaign record to its stores
GET api/campaign/calendar	Get campaigns as calendar events
POST api/campaign/import	Import a list of campaigns
GET api/campaign/{name}/stores	Get list of StoreIDs that campaign is at
GET api/campaign/{name}/plus?storeID={storeID}&ExcludeAdvertised={ExcludeAdvertised}&OrderBy={OrderBy}&Keyword={Keyword}&ActiveOnly={ActiveOnly}&SupplierIdentifierGuid={SupplierIdentifierGuid}&DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of campaign plus
GET api/store/{storeID}/campaign/{name}/plus?ExcludeAdvertised={ExcludeAdvertised}&OrderBy={OrderBy}&Keyword={Keyword}&ActiveOnly={ActiveOnly}&SupplierIdentifierGuid={SupplierIdentifierGuid}&DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of campaign plus
GET api/campaign/{name}/pools?storeID={storeID}&OrderBy={OrderBy}&Keyword={Keyword}&ActiveOnly={ActiveOnly}&SupplierIdentifierGuid={SupplierIdentifierGuid}&DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of campaign pools
GET api/store/{storeID}/campaign/{name}/pools?OrderBy={OrderBy}&Keyword={Keyword}&ActiveOnly={ActiveOnly}&SupplierIdentifierGuid={SupplierIdentifierGuid}&DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of campaign pools
GET api/campaign/{name}/customerGroup?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get customer groups for a campaign
GET api/campaign/{name}/comboPriceGroups?CampaignName={CampaignName}&Take={Take}&Skip={Skip}&Relations={Relations}	List campaign combo price groups for a campaign
GET api/campaign/{name}/sellingrules	Get list of selling rules
GET api/campaign/{name}/poolProducts?storeID={storeID}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get list of products in a product pool campaign
GET api/campaign/{name}/customer?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get customers for a campaign
POST api/campaign/{name}/plu	Add/Update a campaign plus
PUT api/campaign/{name}/plu/{guid}	Add/Update a campaign plus
POST api/campaign/{name}/plu/{guid}/group	Add/Update a campaign plus and all products in it's price group. This is intended for use with price change campaigns
DELETE api/campaign/{name}/plu/{guid}	Delete a campaign plus
DELETE api/campaign/{name}/priceGroup/{id}/plu	Delete a campaign plus for a price group
DELETE api/campaign/{name}/plus	Delete campaign plus
POST api/campaign/{name}/plus	Add/Update a list of campaign plus
POST api/campaign/{name}/move/campaign/{campaign}/plus	Move campaign plus
POST api/campaign/{name}/plus/filter	Add the results of a product filter to a campaign as campaign plus
POST api/campaign/{name}/pools/filter	Add the results of a product filter to a campaign as campaign pools
POST api/campaign/{name}/pool	Save/update a campaign pool
PUT api/campaign/{name}/pool/{guid}	Save/update a campaign pool
DELETE api/campaign/{name}/pool/{guid}	Delete a campaign pool
DELETE api/campaign/{name}/priceGroup/{id}/pool	Delete a campaign pool for a price group
DELETE api/campaign/{name}/pools	Delete campaign pools
POST api/campaign/{name}/pools	Add/Update a list of campaign pools
POST api/campaign/{name}/move/campaign/{campaign}/pools	Move campaign pools
GET api/campaign/names	Get list of campaign names
POST api/store/{storeID}/campaign/{name}/split	Separate a store campaign from a multistore campaign
GET api/product/{guid}/pricechanges	No documentation available.
GET api/product/{guid}/campaigns?PluGuid={PluGuid}&TodayOnly={TodayOnly}&Past={Past}&SaleTypesOnly={SaleTypesOnly}	Get active campaigns for a product
GET api/product/{guid}/campaigns/deals?PluGuid={PluGuid}&ShowPriceChanges={ShowPriceChanges}&IncludePast={IncludePast}&ShowDealCosts={ShowDealCosts}	Get product campaign information for presentation as deals
GET api/product/{guid}/campaignPrices?todayOnly={todayOnly}	No documentation available.
GET api/campaign/{name}/customer/available?search={search}&active={active}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
POST api/campaign/{name}/customer/{guid}	No documentation available.
POST api/campaign/{name}/customers	Add a list of customers to a campaign
DELETE api/campaign/{name}/customer/{guid}	No documentation available.
POST api/campaign/{name}/customer/customerGroup/{guid}	No documentation available.
DELETE api/campaign/{name}/customer/customerGroup/{guid}	No documentation available.
GET api/campaign/{name}/customerGroup/available?search={search}&active={active}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
POST api/campaign/report/{reportDefinition}	No documentation available.
POST api/campaign/{name}/group/{guid}	No documentation available.
POST api/campaign/{name}/groups	Add a list of customer groups to a campaign
DELETE api/campaign/{name}/group/{guid}	No documentation available.
POST api/campaign/{campaignName}/voucher/{voucherName}	No documentation available.
DELETE api/campaign/{campaignName}/voucher/{voucherName}	No documentation available.
GET api/campaign/{name}/comboPriceGroup/{guid}?relations={relations}	No documentation available.
POST api/campaign/{name}/comboPriceGroup	Save a combo price group
PUT api/campaign/{name}/comboPriceGroup/{guid}	Save a combo price group
POST api/campaign/{name}/comboPriceGroups	Save a list of combo groups to a campaign
POST api/campaign/{name}/comboPriceGroups/deletes	Delete multiple combo price groups
DELETE api/campaign/{name}/comboPriceGroup/{guid}	No documentation available.
GET api/campaign/{name}/comboPriceGroup/{guid}/plus	Load combo price group plus
POST api/campaign/{name}/comboPriceGroup/{guid}/plus	Save combo price plus
PUT api/campaign/{campaignName}/sellingrule/{identifier}	No documentation available.
POST api/campaign/{campaignName}/sellingrule/{identifier}	No documentation available.
POST api/campaign/{campaignName}/sellingrule	No documentation available.
DELETE api/sellingrule/{id}	No documentation available.
POST api/campaign/{name}/merge	No documentation available.
POST api/campaign/{name}/batch	Apply pricing, cost or discount changes to campaign plus as a batch
GET api/campaign/{name}/accept?StoreID={StoreID}&CampaignName={CampaignName}&SortDirection={SortDirection}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get Campaign Acceptance records
GET api/store/{StoreID}/campaign/{name}/accept?CampaignName={CampaignName}&SortDirection={SortDirection}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get Campaign Acceptance records
POST api/store/campaign/plu/accept	No documentation available.
POST api/store/{storeID}/campaign/plu/accept	No documentation available.
POST api/store/{storeID}/campaign/{name}/plu/{plu}/accept	No documentation available.
POST api/store/{storeID}/machine/{machineID}/campaign/{name}/plu/{plu}/accept	No documentation available.
POST api/store/{storeID}/machine/{machineID}/operator/{operatorID}/campaign/{name}/plu/{plu}/accept	No documentation available.
DELETE api/store/campaign/plu/delete	No documentation available.
POST api/store/{StoreID}/campaign/plu/reject	No documentation available.
POST api/store/{storeID}/campaign/plu/acceptall	No documentation available.
POST api/campaign/plu/acceptall	No documentation available.
PUT api/campaign/{name}/signiqticket/{id}	No documentation available.
PUT api/store/{storeID}/campaign/{name}/signiqticket/{id}	No documentation available.
POST api/store/{storeID}/campaign/{name}/signiqticket/{id}	No documentation available.
DELETE api/campaign/{name}/signiqticket/{id}	No documentation available.
POST api/store/{storeID}/pricechanges/print	Add price change products to a print batch so that the products con be printed
GET api/store/{storeID}/campaign/pricechangenotificationsubscriptions	No documentation available.
POST api/store/{storeID}/campaign/pricechangenotificationsubscriptions	No documentation available.
GET api/store/{storeID}/pendingpricechanges/sets?DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Date={Date}&ChangeType={ChangeType}&CreatedByUser={CreatedByUser}&FromHost={FromHost}&Description={Description}&Skip={Skip}&Take={Take}	No documentation available.
GET api/store/{storeID}/pendingpricechanges?DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Date={Date}&ChangeType={ChangeType}&CreatedByUser={CreatedByUser}&FromHost={FromHost}&Description={Description}&Skip={Skip}&Take={Take}	No documentation available.
GET api/store/{storeID}/pendingpricechanges/count?DepartmentCode={DepartmentCode}&SubDepartmentCode={SubDepartmentCode}&MinorDepartmentCode={MinorDepartmentCode}&LesserDepartmentCode={LesserDepartmentCode}&Date={Date}&ChangeType={ChangeType}&CreatedByUser={CreatedByUser}&FromHost={FromHost}&Description={Description}&Skip={Skip}&Take={Take}	No documentation available.
POST api/campaign/applypricechanges	Moves accepted price changes into the PLU normal price, deleting the Campaigns and CampaignPLUs in the process.
POST api/campaign/deactivatefinished	Sets all Campaigns to Inactive if they have reached their EndDate.

Card

Card management (GLCodes)

API	Description
GET api/cards	List all cards
GET api/card/{id}	Load a card from ID
POST api/cards	Save a card
POST api/cardGroups	Save a card group
DELETE api/card/{id}	Shouldn't be used. Delete a card record
GET api/card/{cardName}/find	Find a cards ID by name
GET api/cardGroups	List all card groups
GET api/cardGroup/{id}	Load a card group from ID
DELETE api/cardGroup/{id}	Delete a card group
GET api/cardGroup/name/{name}/exists	Find a card groups ID by name
GET api/cardGroup/tender/{tender}/exists	Find a card groups ID by tender

CaseDeal

API	Description
GET api/casedealranges	No documentation available.
POST api/casedealranges	No documentation available.
PUT api/casedealrange/{id}	No documentation available.
DELETE api/casedealrange/{id}	No documentation available.
GET api/casedeals/casedealrange/{id}	No documentation available.
POST api/casedeals	No documentation available.
PUT api/casedeal/{id}	No documentation available.
DELETE api/casedeal/{id}	No documentation available.

CashBalancing

Cash balancing controller

API	Description
GET api/cashBalancing?Take={Take}&Skip={Skip}&StoreID={StoreID}&EndOfDayManagement={EndOfDayManagement}&StartDate={StartDate}&EndDate={EndDate}	List all cash balancing headers that are available (either created or by time)
GET api/store/{storeID}/cashBalancing?Take={Take}&Skip={Skip}&EndOfDayManagement={EndOfDayManagement}&StartDate={StartDate}&EndDate={EndDate}	Return a list of all existing cash balancing headers. Will not list running days that don't exist yet. For reporting selections ONLY
GET api/store/{storeID}/cashBalancing/finalised?Take={Take}&Skip={Skip}&EndOfDayManagement={EndOfDayManagement}&StartDate={StartDate}&EndDate={EndDate}	Return a list of all finalised cash balancing headers
GET api/store/{storeID}/cashBalancing/finalise	Return the earliest un finalised day for a store
GET api/cashBalancing/{id}?relations={relations}	Load the specified cash balancing header.
POST api/store/{storeID}/cashBalancing/create	Create a new cash balancing header record
POST api/cashBalancing/{id}/update	Update an existing cash balancing header that was created during the trading day
POST api/cashBalancing/{id}/update/fuel	Update fuel information of an existing cash balancing header
POST api/cashBalancing/{id}/recalculate	Force a recalculation of existing cash balancing header that was created during the trading day
POST api/cashBalancing/{id}	Save cash balancing header
POST api/cashBalancing/{id}/unfinalise	After an accounting export failure, unfinalise a cash balancing header
POST api/cashBalancing/{id}/finaliseCash	Finalise the cash values for the day
POST api/cashBalancing/{id}/finaliseEft	Finalise the eft values for the day
POST api/cashBalancing/{id}/finaliseBank	Finalise the bank values for the day
POST api/cashBalancing/{id}/finaliseFuel	Finalise the fuel values for the day
POST api/cashBalancing/{id}/finalise	Mark the header as finalised for a system that doesn't export accounting
POST api/cashBalancing/{id}/reBalance	Mark the header as not finalised for any system, allowing recount and re export
GET api/cashBalancing/{id}/details	List the cash balancing details (operator/ drawer/ machine)
GET api/cashBalancing/{id}/details/total	Get the total values and expected values for cash balancing details
GET api/cashBalancing/{id}/eftDetails/summary	Get list of Cash balancing eft summary records by machine
GET api/cashBalancing/{id}/machine/{machineName}/eftDetails	Get list of Cash balancing eft summary records by machine
GET api/cashBalancing/{id}/efts/total	Get the total values and expected values for cash balancing eft pos records
GET api/cashBalancing/{id}/banking	Get the cash balancing banking summary record
GET api/cashBalancing/{id}/accounts	Get the cash balancing banking accounts
GET api/cashBalancing/{id}/accounts/total	Get the total of cash balancing banking accounts, to be compared to the banking totals
GET api/cashBalancing/{id}/fuelGrades	Get the fuel grade records
GET api/cashBalancing/{id}/fuelVariances	Get the fuel variances for a previous period
GET api/cashBalancing/{id}/fuel/total	Get the total of cash balancing fuel values
GET api/cashBalancing/{id}/fuelGradeMeters	Get the fuel grade meter records
GET api/cashBalancing/{id}/fuelMeter/total	Get the total of cash balancing fuel meter values
POST api/cashBalancing/{id}/details	Saves a list of cash balancing detail records
POST api/cashBalancing/{id}/eftDetails	Get list of Cash balancing eft summary records by machine
POST api/cashBalancing/{id}/banking/create	Create a cash balancing banking record if one doesn't exist yet
POST api/cashBalancing/{id}/banking	Save the banking summary and accounts, and return the accounts total for variance comparison
POST api/cashBalancing/{id}/fuelTankLevels	Save the fuel tank levels
GET api/cashBalancing/operator/{guid}/stores?stores[0]={stores[0]}&stores[1]={stores[1]}	Gets a list of stores based on the open cash balancing headers this operator worked at
GET api/cashBalancing/store/{storeID}/operator/{guid}/headers	Find open cash balancing headers for an operator at a particular store
GET api/cashBalancing/{id}/operator/{guid}	Get the cash balancing record for a particular operator and header
GET api/cashBalancing/{id}/operator/{guid}/drawers	Get all cash balancing drawer records for an operator and headers
GET api/cashBalancing/{id}/machine/{machineID}/drawer/{drawerID}	Get the cash balancing record for a particular drawer and header
POST api/cashBalancing/{id}/operator/{guid}/finalise?drawerID={drawerID}&machineID={machineID}	Uploads/Updates Operators Cash balancing. This will create a header for that day or will find the header. This is for operator cash up only.
POST api/cashBalancing/{id}/machine/{machineID}/operator/{guid}/finalise?drawerID={drawerID}	Uploads/Updates Operators Cash balancing. This will create a header for that day or will find the header. This is for operator cash up only.
POST api/cashBalancing/{id}/drawer/{drawerID}/operator/{guid}/finalise?machineID={machineID}	Uploads/Updates Operators Cash balancing. This will create a header for that day or will find the header. This is for operator cash up only.
POST api/cashBalancing/{id}/finance1Export	Export the cash balancing header for finance1
POST api/cashBalancing/{id}/export	Export the cash balancing header
GET api/accounting/{storeID}/departments	Gets a List of Departments and Exports them to OzBiz
GET api/accounting/{storeID}/AuthorisationRedirectUrl	Generates a url to allow user's to authorise an EMC/accounting provider connection.

CashCounting

API	Description
GET api/cashcount/settings?Skip={Skip}&Take={Take}&StoreID={StoreID}&Search={Search}&Provider={Provider}	List available stores and their cash count settings
GET api/cashcount/settings/store/{storeName}	No documentation available.
GET api/cashcount/setting/{id}	Get cash count setting
PUT api/cashcount/setting	Save cash count setting
POST api/cashcount/setting	Save cash count setting
DELETE api/cashcount/setting/{id}	Delete cash count setting
GET api/cashcount/audits?Skip={Skip}&Take={Take}&StoreID={StoreID}&Search={Search}&Status={Status}	List cash count audits
GET api/cashcount/audit/{id}	Get cash count audit
POST api/cashcount/reprocess?AuditID={AuditID}&Provider={Provider}&StoreName={StoreName}&OperatorName={OperatorName}&Status={Status}	Reprocess cash counts for a given query
PUT api/cashcount/audit	Save cash count audit
POST api/cashcount/audit	Save cash count audit
PUT api/store/{storeName}/count/consillion	Processes a Consillion cash count
POST api/store/{storeName}/count/consillion	Processes a Consillion cash count

CheckoutForm

POS form management

API	Description
GET api/checkoutforms/{formType}/groups?relations={relations}	No documentation available.
GET api/checkoutformgroups/{formType}?relations={relations}	No documentation available.
GET api/checkoutformgroups?relations={relations}	No documentation available.
GET api/checkoutforms/{formType}?relations={relations}	No documentation available.
GET api/store/{storeID}/checkoutforms/{formType}?relations={relations}	No documentation available.
GET api/store/{storeID}/zone/{zoneID}/checkoutforms/{formType}?relations={relations}	No documentation available.
GET api/checkoutpanels/{panelType}	No documentation available.
POST api/checkoutform	Import CheckoutForm XML exported from ezi-POS
POST api/store/{id}/checkoutforms/import	Import a list of checkout forms from a store

CheckoutSetting

POS settings management

API	Description
GET api/checkoutsetting	No documentation available.
GET api/checkoutsettings	No documentation available.
GET api/store/{id}/checkoutsettings	No documentation available.
GET api/store/{id}/machine/{machine}/checkoutsettings	No documentation available.
POST api/checkoutsetting/reset/{id}	No documentation available.
DELETE api/checkoutsetting/reset/{id}	No documentation available.
POST api/store/{id}/checkoutsettings/reset	No documentation available.
DELETE api/store/{id}/checkoutsettings/reset	No documentation available.
GET api/store/{storeID}/checkoutsetting/{section}/{keyName}	No documentation available.
GET api/store/{storeID}/machine/{machine}/checkoutsetting/{section}/{keyName}	No documentation available.
PUT api/store/{storeID}/checkoutsetting/{section}/{keyName}	No documentation available.
POST api/store/{storeID}/checkoutsetting/{section}/{keyName}	No documentation available.
PUT api/store/{storeID}/machine/{machine}/checkoutsetting/{section}/{keyName}	No documentation available.
POST api/store/{storeID}/machine/{machine}/checkoutsetting/{section}/{keyName}	No documentation available.
GET api/store/{storeID}/checkoutsetting/export	No documentation available.
GET api/store/{storeID}/checkoutsetting/machine/{machine}/export	No documentation available.
POST api/checkoutsettings	No documentation available.
DELETE api/store/{storeID}/settingszone/{name}/checkoutsettings	No documentation available.
POST api/store/{storeID}/settingszone/{name}/checkoutsettings	No documentation available.

CheckoutStrings

POS localisation strings

API	Description
GET api/checkoutstrings	Get checkout strings
GET api/checkoutstring/{id}	Get a checkout string
POST api/checkoutstring/{id}	Save a checkout string

CommunityOrganisation

Community Organisation

API	Description
GET api/communityorganisations?Skip={Skip}&Take={Take}&Search={Search}&State={State}&OrderBy={OrderBy}&SortBy={SortBy}	List all CommunityOrganisations without relations
GET api/communityorganisation/{guid}	Load a specific CommunityOrganisation with relations
GET api/communityOrganisation/{id}/external/{externalID}/exists	Determine if External ID is unique
GET api/communityOrganisation/external/{externalID}/exists?id={id}	Determine if External ID is unique
GET api/communityOrganisation/{id}/lookup/{lookupID}/exists	Determine if Lookup Identifier is unique
GET api/communityOrganisation/lookup/{lookupID}/exists?id={id}	Determine if Lookup Identifier is unique
POST api/communityorganisations	Add a CommunityOrganisation
PUT api/communityorganisation/{guid}	Update a CommunityOrganisation along with its relations
DELETE api/communityorganisation/{guid}	Delete a CommunityOrganisation along with its relations

ComplianceIndicator

Manage host compliance indicator

API	Description
GET api/store/{StoreID}/complianceindicators	Get a list of compliance indicators for the store
GET api/store/{storeID}/complianceindicator/{id}	Get a compliance indicator
GET api/store/{StoreID}/complianceindicators/types	Get the list of compliance indicators grouped by type, for filtering
GET api/complianceindicators/types	Get the list of compliance indicators grouped by type, for filtering Multistore compliance indicator type list.
PUT api/store/{storeID}/complianceindicator/{id}	Update compliance indicator
POST api/complianceindicators/import	Import a list of compliance indicators
POST api/store/{storeID}/complianceindicators/import	Import a list of compliance indicators to a store
DELETE api/store/{storeID}/complianceindicators/{id}	Delete compliance indicator

Contact

Contact info for accounts

API	Description
GET api/deliContact/exists	Check for an existing contact against First and Second names and contact information
PUT api/deliContact/{id}	No documentation available.

CreditNote

Credit note controller

API	Description
GET api/creditNotes	List credit notes
GET api/creditNote/{id}/details	List credit details for a credit note
GET api/creditNote/{id}/detail/{guid}/receives?images={images}	List credit detail receive records
GET api/creditNote/{id}	Get credit note
POST api/creditNotes	Create or save a credit note
PUT api/creditNote/{id}	Update a specified credit note
PUT api/creditNote/{id}/detail/{guid}	Save a credit detail for a credit note
POST api/creditNote/{id}/details	Save credit details for a credit note
POST api/creditNote/{id}/detail/{guid}/receive	Save a credit detail receive record
DELETE api/creditNote/{id}	Delete a credit note
DELETE api/creditNote/{id}/detail/{guid}	Delete a credit detail
DELETE api/creditNote/{identifier}/detail/{guid}/receive/{id}	Delete a credit detail receive
POST api/creditNote/{id}/send	Send a credit note request
POST api/creditNote/{id}/resend	Re-send a credit note request. Only places request, does not apply inventory a second time
POST api/creditNote/{id}/sent	Mark credit note request as sent
POST api/creditNote/{id}/accept	Mark a credit note as accepted
POST api/creditNote/{id}/reject	Mark a credit note as rejected
POST api/order/{guid}/creditNotes	Create a credit note from an order
GET api/order/{guid}/creditDetails	List order details, excluding non-ordered lines and surfacing lines with variance
POST api/order/{guid}/creditNote/{id}/details	Create credit details from order
POST api/invoice/{guid}/creditNotes	Create a credit note from an invoice
GET api/invoice/{guid}/creditDetails?ReceivedQuantityOnly={ReceivedQuantityOnly}&VarianceChargesOnly={VarianceChargesOnly}&ImagesOnly={ImagesOnly}&id={id}&Keyword={Keyword}&Search={Search}&UnknownScanOnly={UnknownScanOnly}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&ExcludeReceived={ExcludeReceived}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoice details, surfacing lines with variance
POST api/invoice/{guid}/creditNote/{id}/details	Create credit details from invoice

Customer

Retail Customers and Loyalty

API	Description
GET api/customers?Take={Take}&Skip={Skip}&Search={Search}&CustomerGroupIdentifier={CustomerGroupIdentifier}&Active={Active}&IncludeGroupCustomers={IncludeGroupCustomers}&IncludeHiddenCustomers={IncludeHiddenCustomers}&IncludeDeletedCustomers={IncludeDeletedCustomers}&IncludeUnregisteredCustomers={IncludeUnregisteredCustomers}&UpdatedSince={UpdatedSince}&OrderBy={OrderBy}&Sort={Sort}&Relations={Relations}	Get customer page list
GET api/customer/{id}?Relations={Relations}&Cards={Cards}&Payments={Payments}	Get Customer
GET api/customer/code/{code}?Relations={Relations}&Cards={Cards}&Payments={Payments}	Get Customer
GET api/customers/find?email={email}&givenName={givenName}&familyName={familyName}	Find customer by email and name
POST api/customers	Add a customer
PUT api/customer/{id}	Updates a customer
DELETE api/customer/{id}	Delete customer
POST api/customer/{id}/deactivate	Deactivate customer
POST api/customer/deactivate/{id}	Deactivate customer
POST api/customer/{id}/registered	Mark customer as registered
POST api/customer/{id}/merge/{identifier}	Permanently merge customer into another
GET api/customer/{id}/payments?startDate={startDate}&endDate={endDate}&paymentType={paymentType}	Find a list of payments a customer has made, where the customer bought items or used their account to pay
GET api/customer/{id}/sales?StoreID={StoreID}&StartDate={StartDate}&EndDate={EndDate}&SalesType={SalesType}&OperatorG={OperatorG}&MachineID={MachineID}&DrawerID={DrawerID}&PluGuid={PluGuid}&Tender={Tender}&CardName={CardName}&Customer={Customer}&CustomerIdentifier={CustomerIdentifier}&DepartmentCode={DepartmentCode}&ProductNotMatched={ProductNotMatched}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&PumpNumber={PumpNumber}&MinTenderedAmount={MinTenderedAmount}&MaxTenderedAmount={MaxTenderedAmount}&SaleIdentifier={SaleIdentifier}&ExternalSale={ExternalSale}&Imported={Imported}&OrderBy={OrderBy}&Sort={Sort}&ExcludeVoids={ExcludeVoids}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get transactions a customer was involved in
GET api/customer/{id}/Sales/receipts?StoreID={StoreID}&StartDate={StartDate}&EndDate={EndDate}&SalesType={SalesType}&OperatorG={OperatorG}&MachineID={MachineID}&DrawerID={DrawerID}&PluGuid={PluGuid}&Tender={Tender}&CardName={CardName}&Customer={Customer}&CustomerIdentifier={CustomerIdentifier}&DepartmentCode={DepartmentCode}&ProductNotMatched={ProductNotMatched}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&PumpNumber={PumpNumber}&MinTenderedAmount={MinTenderedAmount}&MaxTenderedAmount={MaxTenderedAmount}&SaleIdentifier={SaleIdentifier}&ExternalSale={ExternalSale}&Imported={Imported}&OrderBy={OrderBy}&Sort={Sort}&ExcludeVoids={ExcludeVoids}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&details={details}&salesOnly={salesOnly}	Get receipts a customer was involved in
GET api/customer/card/{identifier}/customer	Get Customer and specific customer card details using card identifier
GET api/customer/{id}/groups	Get customer's group memberships
POST api/customer/{id}/group	Add customer to customer group
DELETE api/customer/{id}/group/{groupID}	Remove customer from customer group
POST api/customer/{customerID}/groups	Add customer to customer groups
GET api/customer/email/{email}/exists	Check if a customer with this email exists
GET api/customer/email/{email}	Get a list of customers with the specified email
GET api/customercard/{id}?payments={payments}	Get customer card
GET api/customer/card/{id}?payments={payments}	Get customer card
GET api/customer/{id}/cards?CustomerId={CustomerId}&Search={Search}&ActiveOnly={ActiveOnly}&UnexhaustedOnly={UnexhaustedOnly}&UnexpiredOnly={UnexpiredOnly}&IncludeVirtual={IncludeVirtual}&CardType={CardType}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Find customer cards
POST api/customer/{id}/cards	Save customer card to specific customer
POST api/customer/cards/{id}	Save customer card to specific customer
POST api/customer/cards	Save new customer card
GET api/customer/card/exists/{identifier}	Check if customer card exists
DELETE api/customer/{customerID}/card/{identifier}	Delete a card from a customer
POST api/customer/{id}/adjustCard	Adjust gift card value
POST api/customer/{id}/adjustBalance	Adjust customer card value, to return available spending $ after void
POST api/customer/card/{identifier}/activate	Activate a customer card
POST api/customer/card/number/next	Get the next card number
GET api/customer/{guid}/voucher?Skip={Skip}&Take={Take}&TotalCount={TotalCount}&redeemed={redeemed}&expired={expired}	List of customer vouchers for a customer
GET api/customer/{guid}/vouchers/{voucherName}?Skip={Skip}&Take={Take}&TotalCount={TotalCount}&redeemed={redeemed}&expired={expired}	List of customer vouchers for a customer and a specified voucher
POST api/customer/{guid}/voucher/{voucherName}/issue	Manually issue customer voucher for user
POST api/customer/{guid}/voucher/{voucherName}	Redeem or issue customer vouchers for a customer
GET api/customer/{id}/vouchers?redeemed={redeemed}&expired={expired}	Get customerVoucher summaries, count of vouchers, per store for the customer
DELETE api/customer/{guid}/voucher/{voucherName}	Delete customer voucher
POST api/customer/{id}/accrueLoyaltyPoints	Perform a Loyalty transaction
POST api/customer/{guid}/loyaltyPoints	Add or Remove a customer's loyalty points or available spend balance
POST api/customer/{guid}/expireLoyaltyPoints	Expire a customer's loyalty points
GET api/customer/{guid}/loyaltyLedgers?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get Loyalty Ledger entries
POST api/customer/import	Import a list of customers [ONLY Customer records]
POST api/customer/card/import	Import a list of customer cards [ONLY CustomerCard records]

CustomerCompetition

Customer Voucher Competition

API	Description
GET api/customer/{id}/competitions?Take={Take}&Skip={Skip}&CustomerIdentifier={CustomerIdentifier}&VoucherName={VoucherName}	Get Competition list by Customer
GET api/customer/{id}/competitions/{competitionName}?voucherName={voucherName}&Take={Take}&Skip={Skip}&CustomerIdentifier={CustomerIdentifier}	Get Competition list by Customer and voucher
POST api/customer/{id}/competitions	Save a list of customer competitions
POST api/customer/{id}/competition/{competitionName}	Save a customer competition record
DELETE api/customer/{id}/competition/{competitionid}	Delete a CustomerCompetition
GET api/competitions/{competitionName}	Get CustomerCompetition list by Voucher
GET api/customer/{id}/competitions/voucher/{voucherId}	Get CustomerCompetition list by Voucher

CustomerGroup

Retail Customer groups

API	Description
GET api/customerGroups?search={search}&active={active}&includeDeleted={includeDeleted}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List Customer Groups
GET api/customergroup/{id}?relations={relations}	No documentation available.
POST api/customergroups	No documentation available.
PUT api/customergroup/{id}	No documentation available.
DELETE api/customergroup/{id}	Delete customer group
GET api/customergroup/{id}/members?skip={skip}&take={take}	No documentation available.
POST api/customergroup/members/{id}	No documentation available.
POST api/customergroup/{id}/members	No documentation available.
DELETE api/customergroup/{id}/member/{customerID}	No documentation available.
GET api/customergroup/{id}/member/{customerID}/exists	Checks if a customer exists in the customer group
PUT api/customergroup/{groupID}/member/{customerID}	No documentation available.
POST api/customergroup/import	Import a list of customer groups [ONLY CustomerGroup records]
POST api/customergroup/memberimport	Imports a list of customer group memberships If no customer card identifier or object is not provided, one will be created

CustomisedReport

Stimulsoft Customised Reports

API	Description
GET api/customisedreports/{name}	List all customised reports for given standard report which are created by Current User or which are visible to all
POST api/customisedreport	Add new Customised Report. It will copy Standard Report MRT file to Storage under `TenantName/ReportTemplates` folder
PUT api/customisedreport/{id}	Update existing Customised Report detail.
DELETE api/customisedreport/{id}	Delete an existing Customised Report. It will delete .mrt file from Storage too.

DashboardChart

Dashboard chart related APIs

API	Description
GET api/dashboardcharts?Active={Active}&DashboardId={DashboardId}	This is used to load charts for manage dashboard popup
GET api/dashboardcharts/{id}	This is used to load charts on dashboard for specific DashboardId
GET api/dashboardcharts/user	This is used to load charts on Configure charts so its User specific
GET api/dashboards	This is used to load list of dashboards on Dashboard
POST api/dashboardchart	Add new Dashboard chart
PUT api/dashboardchart/{id}	Update existing Dashboard chart
POST api/dashboard/preferences/{id}	Add/edit chart preferences - size and position changes
POST api/dashboard	Add dashboard
PUT api/dashboard/{id}	edit dashboard
DELETE api/dashboardchart/{id}	Delete Dashboard chart
DELETE api/dashboard/{id}	Delete Dashboard

Databar

Generates barcode images

API	Description
GET api/databar/{data}?ApplyTilde={ApplyTilde}&BackColor={BackColor}&BarHeightCM={BarHeightCM}&CaptionAbove={CaptionAbove}&CaptionBelow={CaptionBelow}&CaptionBottomAlignment={CaptionBottomAlignment}&CaptionBottomColor={CaptionBottomColor}&CaptionBottomSpace={CaptionBottomSpace}&CaptionFontAbove={CaptionFontAbove}&CaptionFontBelow={CaptionFontBelow}&CaptionTopAlignment={CaptionTopAlignment}&CaptionTopColor={CaptionTopColor}&CaptionTopSpace={CaptionTopSpace}&CharacterGrouping={CharacterGrouping}&Code128Set={Code128Set}&CompositeData={CompositeData}&DataBarSuggestedHeight={DataBarSuggestedHeight}&ExpandedStackedSegments={ExpandedStackedSegments}&FitControlToBarcode={FitControlToBarcode}&Font={Font}&ForeColor={ForeColor}&IncludeAIinHRText={IncludeAIinHRText}&IncludeLinkageFlaginHRText={IncludeLinkageFlaginHRText}&IsComposite={IsComposite}&LeftMarginCM={LeftMarginCM}&OneBitPerPixelImage={OneBitPerPixelImage}&PDFColumns={PDFColumns}&PDFErrorCorrectionLevel={PDFErrorCorrectionLevel}&PDFMode={PDFMode}&PDFRows={PDFRows}&Resolution={Resolution}&ResolutionCustomDPI={ResolutionCustomDPI}&RotationAngle={RotationAngle}&ShowText={ShowText}&ShowTextLocation={ShowTextLocation}&SuppSeparationCM={SuppSeparationCM}&SymbologyID={SymbologyID}&TextFontColor={TextFontColor}&TextMarginCM={TextMarginCM}&TopMarginCM={TopMarginCM}&TruncatePDF417={TruncatePDF417}&UPCESystem={UPCESystem}&XDimensionCM={XDimensionCM}&XDimensionMILS={XDimensionMILS}&XtoYRatio={XtoYRatio}	No documentation available.

API

Description

GET api/databar/{data}?ApplyTilde={ApplyTilde}&BackColor={BackColor}&BarHeightCM={BarHeightCM}&CaptionAbove={CaptionAbove}&CaptionBelow={CaptionBelow}&CaptionBottomAlignment={CaptionBottomAlignment}&CaptionBottomColor={CaptionBottomColor}&CaptionBottomSpace={CaptionBottomSpace}&CaptionFontAbove={CaptionFontAbove}&CaptionFontBelow={CaptionFontBelow}&CaptionTopAlignment={CaptionTopAlignment}&CaptionTopColor={CaptionTopColor}&CaptionTopSpace={CaptionTopSpace}&CharacterGrouping={CharacterGrouping}&Code128Set={Code128Set}&CompositeData={CompositeData}&DataBarSuggestedHeight={DataBarSuggestedHeight}&ExpandedStackedSegments={ExpandedStackedSegments}&FitControlToBarcode={FitControlToBarcode}&Font={Font}&ForeColor={ForeColor}&IncludeAIinHRText={IncludeAIinHRText}&IncludeLinkageFlaginHRText={IncludeLinkageFlaginHRText}&IsComposite={IsComposite}&LeftMarginCM={LeftMarginCM}&OneBitPerPixelImage={OneBitPerPixelImage}&PDFColumns={PDFColumns}&PDFErrorCorrectionLevel={PDFErrorCorrectionLevel}&PDFMode={PDFMode}&PDFRows={PDFRows}&Resolution={Resolution}&ResolutionCustomDPI={ResolutionCustomDPI}&RotationAngle={RotationAngle}&ShowText={ShowText}&ShowTextLocation={ShowTextLocation}&SuppSeparationCM={SuppSeparationCM}&SymbologyID={SymbologyID}&TextFontColor={TextFontColor}&TextMarginCM={TextMarginCM}&TopMarginCM={TopMarginCM}&TruncatePDF417={TruncatePDF417}&UPCESystem={UPCESystem}&XDimensionCM={XDimensionCM}&XDimensionMILS={XDimensionMILS}&XtoYRatio={XtoYRatio}

No documentation available.

DealCost

Purchase Order Suppliers

API	Description
GET api/product/{guid}/supplier/{id}/dealCosts?Description={Description}&SupplierGuid={SupplierGuid}&StoreID={StoreID}&PluGuid={PluGuid}&Start={Start}&End={End}&PromoType={PromoType}&Type={Type}&BonusPluGuid={BonusPluGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/supplier/{id}/product/{guid}/dealCosts?Description={Description}&SupplierGuid={SupplierGuid}&StoreID={StoreID}&PluGuid={PluGuid}&Start={Start}&End={End}&PromoType={PromoType}&Type={Type}&BonusPluGuid={BonusPluGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/product/{id}/dealCosts?Description={Description}&SupplierGuid={SupplierGuid}&StoreID={StoreID}&PluGuid={PluGuid}&Start={Start}&End={End}&PromoType={PromoType}&Type={Type}&BonusPluGuid={BonusPluGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/supplier/{id}/dealCosts?Description={Description}&SupplierGuid={SupplierGuid}&StoreID={StoreID}&PluGuid={PluGuid}&Start={Start}&End={End}&PromoType={PromoType}&Type={Type}&BonusPluGuid={BonusPluGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/dealCosts?Description={Description}&SupplierGuid={SupplierGuid}&StoreID={StoreID}&PluGuid={PluGuid}&Start={Start}&End={End}&PromoType={PromoType}&Type={Type}&BonusPluGuid={BonusPluGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/deal/{id}/dealCosts?storeID={storeID}&HeaderIdentifierGuid={HeaderIdentifierGuid}&Description={Description}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Load the deal costs only for a specific deal
GET api/store/{storeID}/deal/{id}/dealCosts?HeaderIdentifierGuid={HeaderIdentifierGuid}&Description={Description}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Load the deal costs only for a specific deal
GET api/product/{guid}/bestcost?forDate={forDate}	Get the best deal cost for a product
GET api/supplier/{id}/product/{guid}/bestcost	Get the Best deal cost for a specific supplier
GET api/deal/{id}	Load deal cost header
GET api/deal/{id}/stores	Load the stores a deal cost belongs to
POST api/deals	Add or update a deal cost header
POST api/deal/{id}/costs	Save list of deal costs to a header
PUT api/deal/{id}/cost/{guid}	Add or update a deal cost for a deal cost header
PUT api/deal/{id}	Add or update a deal cost header
POST api/store/{storeID}/deal/{id}/split	Separate a deal cost store from a multistore deal cost header
DELETE api/deal/{id}	Delete a deal cost header
DELETE api/store/{storeID}/deal/{id}	Delete a store from a deal cost header
DELETE api/deal/{id}/cost/{guid}	Delete a product from a deal cost header
DELETE api/dealcost/{id}	Deprecated. No documentation available. Removed after 31 Jan 2026
POST api/dealheader/create	Create deal costs based on the batch details
POST api/store/{storeID}/dealCosts	Deprecated. Save a deal cost at a single store Removed after 31 Jan 2026
POST api/dealCosts	Deprecated. Save a deal cost Removed after 31 Jan 2026
POST api/dealcosts/import	Deprecated.
PUT api/dealcost/{id}	Deprecated. No documentation available. Removed after 31 Jan 2026

DeliOrder

Retail customer phone orders

API	Description
GET api/store/{storeID}/deliOrder/count	Get a count of phone orders at a store
GET api/store/{storeID}/customer/{customerID}/orders/count	Get a count of a customer's phone orders at a store
GET api/deliOrder?StoreID={StoreID}&CustomerID={CustomerID}&OrderNo={OrderNo}&PickupAfter={PickupAfter}&PickupBefore={PickupBefore}&IncludeStarted={IncludeStarted}&IncludeCompleted={IncludeCompleted}&IncludeSupplied={IncludeSupplied}&ExcludeDeleted={ExcludeDeleted}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Find a list of DeliOrders
GET api/deliOrder/{id}?relations={relations}	Get a deli order
GET api/deliOrder/customer/{customerID}?StoreID={StoreID}&OrderNo={OrderNo}&PickupAfter={PickupAfter}&PickupBefore={PickupBefore}&IncludeStarted={IncludeStarted}&IncludeCompleted={IncludeCompleted}&IncludeSupplied={IncludeSupplied}&ExcludeDeleted={ExcludeDeleted}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Find a list of DeliOrders for a customer
GET api/store/{storeID}/deliOrder?CustomerID={CustomerID}&OrderNo={OrderNo}&PickupAfter={PickupAfter}&PickupBefore={PickupBefore}&IncludeStarted={IncludeStarted}&IncludeCompleted={IncludeCompleted}&IncludeSupplied={IncludeSupplied}&ExcludeDeleted={ExcludeDeleted}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Find a list of DeliOrders at a store
GET api/deliOrder/{id}/details	Get details attached to a deli order
GET api/deliOrder/popular?Skip={Skip}&Take={Take}&TotalCount={TotalCount}&startDate={startDate}&endDate={endDate}	Get a list of commonly ordered products within a period
GET api/store/{storeID}/deliOrder/popular?Skip={Skip}&Take={Take}&TotalCount={TotalCount}&startDate={startDate}&endDate={endDate}	Get a list of commonly ordered products within a period at a store
POST api/deliOrder	Add/Update deli order
POST api/deliOrders	Add/Update deli order
PUT api/deliOrder/{id}	Update deli order
POST api/deliOrder/{id}/started	Set the started time for a phone order Also applies logic to set the sold column information based on the product
POST api/deliOrder/{id}/completed	Mark the picking of a phone order as complete
POST api/deliOrder/{id}/supplied	Indicate that the customer or delivery provided has been supplied with the phone order
POST api/deliOrder/{id}/details	Save a list of phone order details
PUT api/deliOrder/{id}/detail/{guid}	Save phone order detail
DELETE api/deliOrder/{id}/detail/{guid}	Remove phone order detail
POST api/deliOrder/{id}/mail	Re/Send a customer order email for a customer
DELETE api/deliOrder/{id}/cancel	Cancel a phone order
GET api/deliOrder/Calendar?start={start}&end={end}&excludeUrl={excludeUrl}	Calendar events for deliOrders (customer phone orders) with appropriate linking and colour settings for calendar

Department

Product department management

API	Description
GET api/departments?subDepartments={subDepartments}&minorDepartments={minorDepartments}&lesserDepartments={lesserDepartments}&showExternal={showExternal}	Lists all departments
PUT api/department/{id}	Adds a department
GET api/department/{department}?loadSubDepartments={loadSubDepartments}&loadMinorDepartments={loadMinorDepartments}&loadLesserDepartments={loadLesserDepartments}	No documentation available.
GET api/department/{department}/subdepartment/{subdept}?loadMinorDepartments={loadMinorDepartments}&loadLesserDepartments={loadLesserDepartments}	No documentation available.
GET api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minordepartment}?loadLesserDepartments={loadLesserDepartments}	No documentation available.
GET api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minordepartment}/lesserdepartment/{lesserdepartment}	No documentation available.
GET api/department/{department}/sizes	Get all store size configurations for department
GET api/department/{department}/subdepartment/{subdept}/sizes	Get all store size configurations for sub department
GET api/department/{department}/size/{id}/deals	Get all store size deal configurations for department
GET api/department/{department}/subdepartment/{subdept}/size/{id}/deals	Get all store size deal configurations for sub department
GET api/department/{deptCode}/exists	Find an existing department via codes
GET api/department/{deptCode}/subdepartment/{subDeptCode}/exists	Find an existing sub department via codes
GET api/department/{deptCode}/subdepartment/{subDeptCode}/minordepartment/{minorDeptCode}/exists	Find an existing minor department via codes
GET api/department/{deptCode}/subdepartment/{subDeptCode}/minordepartment/{minorDeptCode}/lesserdepartment/{lesserDeptCode}/exists	Find an existing lesser department via codes
POST api/department/{id}	Updates department defaults
POST api/department/{id}/sizes	Get all store size configurations for department
POST api/department/{dept}/subdepartment/{id}/sizes	Get all store size configurations for department
POST api/department/{dept}/subdepartment/{id}	No documentation available.
POST api/department/{dept}/subdepartment/{sub}/minordepartment/{id}	No documentation available.
POST api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/lesserdepartment/{id}	No documentation available.
DELETE api/department/{id}	Delete department
DELETE api/department/{id}/size/{sizeID}	Remove Department Store Size configurations
DELETE api/department/{dept}/subdepartment/{id}/size/{sizeID}	Remove Sub department Store Size configurations
PUT api/department/{department}/subdepartment/{subdept}	No documentation available.
DELETE api/department/{dept}/subdepartment/{id}	Delete sub department
PUT api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minor}	No documentation available.
PUT api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minor}/lesserdepartment/{lesser}	No documentation available.
DELETE api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}	Delete minor department
DELETE api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/lesserdepartment/{lesser}	Delete lesser department
POST api/departments/sort	Set all departments sort order
POST api/department/{code}/sort	Re-sort a department
GET api/department/{department}/products?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/products/available?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{department}/subdepartment/{subdept}/products?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{dept}/subdepartment/products/available?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minor}/products?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{dept}/subdepartment/{subDept}/minordepartment/products/available?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{department}/subdepartment/{subdepartment}/minordepartment/{minor}/lesserdepartment/{lesser}/products?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
GET api/department/{dept}/subdepartment/{subDept}/minordepartment/{minor}/lesserdepartment/products/available?Take={Take}&Skip={Skip}&StoreID={StoreID}&Name={Name}&PLU={PLU}&APN={APN}	No documentation available.
POST api/department/{dept}/product/{guid}	No documentation available.
DELETE api/department/{dept}/product/{guid}	No documentation available.
POST api/department/{dept}/subdepartment/{subdept}/product/{guid}	No documentation available.
DELETE api/department/{dept}/subdepartment/{subdept}/product/{guid}	No documentation available.
POST api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/product/{guid}	No documentation available.
DELETE api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/product/{guid}	No documentation available.
POST api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/lesserdepartment/{lesser}/product/{guid}	No documentation available.
DELETE api/department/{dept}/subdepartment/{sub}/minordepartment/{minor}/lesserdepartment/{lesser}/product/{guid}	No documentation available.
POST api/departments	No documentation available.
POST api/department/import	No documentation available.
POST api/subdepartment/import	No documentation available.
POST api/minordepartment/import	No documentation available.
POST api/lesserdepartment/import	No documentation available.
POST api/department/restructure	No documentation available.
GET api/msc/departments	No documentation available.
POST api/msc/department	No documentation available.
POST api/msc/category	No documentation available.
POST api/msc/commodity	No documentation available.
POST api/msc/subCommodity	No documentation available.
POST api/msc/departments	No documentation available.
POST api/msc/categories	No documentation available.
POST api/msc/commodities	No documentation available.
POST api/msc/subCommodities	No documentation available.
DELETE api/msc/department	No documentation available.
DELETE api/msc/category	No documentation available.
DELETE api/msc/commodity	No documentation available.
DELETE api/msc/subCommodity	No documentation available.

DumpStock

Manage discarded inventory

API	Description
GET api/dumpstocks?Take={Take}&Skip={Skip}&PluGuid={PluGuid}&Start={Start}&End={End}	List dump stock records requested
GET api/product/{id}/dumpstocks?Take={Take}&Skip={Skip}&PluGuid={PluGuid}&Start={Start}&End={End}	List dump stock records requested
GET api/dumpstock/{id}?relations={relations}	Get dump stock record, with relational data
POST api/product/{id}/dumpstock	Generate a new DumpStock record. Many fields will be filled in by the current Product records
DELETE api/dumpstock/{id}	Soft delete a dumpstock record
POST api/dumpstock/imports	Import a list of dump stock records

ElectronicShelfLabel

Electronic Shelf Label management

API	Description
GET api/ElectronicShelfLabels?StoreID={StoreID}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Gets a list of Electronic Shelf Label Configuration
GET api/ElectronicShelfLabel/{id}?relations={relations}	Retrieves an Electronic Shelf Label Configuration
POST api/ElectronicShelfLabel	Creates a new
PUT api/ElectronicShelfLabel/{id}	Save or Create a with a set ID
DELETE api/ElectronicShelfLabel/{id}	Hard deletes a
GET api/ElectronicShelfLabel/{id}/StoreConfigurations?relations={relations}	Retrieves an Electronic Shelf Label Store Configuration
POST api/ElectronicShelfLabel/{id}/StoreConfiguration	Creates a new
PUT api/ElectronicShelfLabel/{id}/StoreConfiguration/{StoreConfigurationID}	Save or Create a with a set ID
DELETE api/ElectronicShelfLabel/{id}/StoreConfiguration/{StoreConfigurationID}	Deletes a
GET api/ElectronicShelfLabel/{id}/StoreConfigurations/{StoreConfigurationID}/Format?relations={relations}	Retrieves the Electronic Shelf Label Formats.
POST api/ElectronicShelfLabel/{id}/StoreConfigurations/{StoreConfigurationID}/Format	No documentation available.
PUT api/ElectronicShelfLabel/{id}/StoreConfigurations/{StoreConfigurationID}/Format/{FormatID}	No documentation available.
DELETE api/ElectronicShelfLabel/{id}/StoreConfigurations/{StoreConfigurationID}/Format/{FormatID}	No documentation available.
GET api/store/{StoreID}/ElectronicShelfLabel	List ElectronicShelfLabelType configured for the current store
POST api/store/{StoreID}/ElectronicShelfLabel/{id}/product	Saves a product(s) into the Electronic Shelf Label Provider
PUT api/store/{StoreID}/ElectronicShelfLabel/{id}/product	Updates a product(s) into the Electronic Shelf Label Provider
DELETE api/store/{StoreID}/ElectronicShelfLabel/{id}/product	Deletes a product(s) into the Electronic Shelf Label Provider
POST api/store/{StoreID}/ElectronicShelfLabel/assign	Assigns a products to the Electronic Shelf Labels.
POST api/store/{StoreID}/ElectronicShelfLabel/unassign	unassigns a products to the Electronic Shelf Labels.
GET api/store/{StoreID}/ElectronicShelfLabels/templates	Gets a list of all the mapped templates for all ESL providers at specified store
POST api/store/{StoreID}/ElectronicShelfLabel/blink	Causes any Electronic Shelf Label based on the
GET api/store/{StoreID}/ElectronicShelfLabels/{id}/providerLayouts	Gets a list of layouts, which are available at that current store, from the ESL provider
GET api/store/{StoreID}/ElectronicShelfLabels/{id}/testConnection	Test if the currently saved settings can successfully connect to the ESL provider.

EndOfDay

API	Description
POST api/endOfDay/import	Import a list of end of day records

ErrorLog

Post errors to underlying logging infrastructure

API	Description
POST api/errorlog?message={message}&url={url}&line={line}&column={column}&error={error}	Write an error to logs
POST api/errorlogs?message={message}&url={url}&line={line}&column={column}&error={error}	Write an error to logs

ExportSetting

Export Settings

API	Description
GET api/exportsetting/{id}	No documentation available.
GET api/exportsettings	No documentation available.
PUT api/exportsetting	No documentation available.
POST api/exportsetting	No documentation available.
DELETE api/exportsetting/{id}	No documentation available.

Feedback

API	Description
POST api/feedback	Send a feedback email to support about a feature

FlipChart

POS flip chart maintenance

API	Description
GET api/flipcharts	No documentation available.
GET api/flipchart/{id}	No documentation available.
PUT api/flipchart/{id}	No documentation available.
DELETE api/flipchart/{id}	No documentation available.
POST api/flipcharts	No documentation available.
POST api/flipcharts/{id}/send	No documentation available.
PUT api/flipchart/{id}/page/{pageId}	No documentation available.
POST api/flipcharts/flush	No documentation available.
GET api/product/{id}/flipchartpages	No documentation available.
GET api/flipchart/{id}/page/{pageID}/products	List all flipchart page products
POST api/flipchart/{id}/page/{pageID}/products	Add list of flipchart page products to existing page
POST api/product/{productGuid}/flipchartpages/{pageGuid}	Add a product to a flip chart page
DELETE api/product/{productGuid}/flipchartpages/{pageGuid}	Remove a product from a flip chart page
POST api/flipchart/page/{pageGuid}/rename	Rename a flip chart page
GET api/flipChart/{id}/page/{name}/exists	Check if the flip chart page name exists
GET api/product/{id}/flipcharts	No documentation available.

Font

Lists all available system fonts

API	Description
GET api/fonts	No documentation available.
GET api/font/{name}	No documentation available.
GET api/fonts/saved	No documentation available.
POST api/fonts	No documentation available.
DELETE api/font/{name}	No documentation available.

FTPSite

FTP Sites

API	Description
GET api/ftpsite/{id}	Test FTP Site credentials
GET api/ftpsites	List FTP Sites
PUT api/ftpsite/{id}	Update FTP Site
POST api/ftpsites	Create or Update FTP Site
DELETE api/ftpsite/{id}	Delete FTP Site

Fuel

POS fuel data

API	Description
GET api/fuel	Obtains a list of Stores which have Fuel
GET api/store/{storeID}/fuel	Gets the StoreFuel object by the supplied store ID
GET api/tanks?StoreID={StoreID}&Take={Take}&Skip={Skip}&Relations={Relations}	Gets a collection of fuel tanks
GET api/store/{storeID}/tanks?Take={Take}&Skip={Skip}&Relations={Relations}	Gets a collection of fuel tanks from the supplied store
GET api/store/{storeID}/tank/{tankID}	Gets a FuelTank from the store
GET api/store/{storeID}/tank/{tankID}/adjustments?GradeID={GradeID}&TankNumber={TankNumber}&Before={Before}&After={After}&FilterAdjustedAtDate={FilterAdjustedAtDate}&Take={Take}&Skip={Skip}&Relations={Relations}	Get a list of fuel tank adjustments at store meters
GET api/store/{storeID}/tank/fuelGrade/{gradeID}/adjustments?TankNumber={TankNumber}&Before={Before}&After={After}&FilterAdjustedAtDate={FilterAdjustedAtDate}&Take={Take}&Skip={Skip}&Relations={Relations}	Get a list of fuel tank adjustments at a store and fuel grade
GET api/store/{storeID}/tank/{tankID}/hoses	Gets all hoses for a selected tank
GET api/store/{storeID}/tank/{tankID}/hose/{hoseID}/dispenser/{dispenserNo}	Save FuelHose record
GET api/store/{storeID}/tank/{tankID}/dispenser/{dispenserNo}/hose/{hoseID}/adjustments?GradeID={GradeID}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&DispenserNumber={DispenserNumber}&Before={Before}&After={After}&FilterAdjustedAtDate={FilterAdjustedAtDate}&Take={Take}&Skip={Skip}&Relations={Relations}	Get a list of fuel hose adjustments at store meters
GET api/store/{storeID}/tank/{tankID}/meter/adjustments?GradeID={GradeID}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&DispenserNumber={DispenserNumber}&Before={Before}&After={After}&FilterAdjustedAtDate={FilterAdjustedAtDate}&Take={Take}&Skip={Skip}&Relations={Relations}&dispenserNo={dispenserNo}&hoseID={hoseID}	Get a list of fuel hose adjustments at store meters
GET api/store/{storeID}/meter/fuelGrade/{gradeID}/adjustments?TankNumber={TankNumber}&HoseNumber={HoseNumber}&DispenserNumber={DispenserNumber}&Before={Before}&After={After}&FilterAdjustedAtDate={FilterAdjustedAtDate}&Take={Take}&Skip={Skip}&Relations={Relations}	Get a list of fuel hose adjustments at a store and fuel grade
GET api/store/{storeID}/deliveries?TankNumber={TankNumber}&GradeID={GradeID}&Before={Before}&After={After}&FilterRecordedDate={FilterRecordedDate}&SupplierGuid={SupplierGuid}&Take={Take}&Skip={Skip}&Relations={Relations}&tankID={tankID}	Load list of fuel delivery
GET api/store/{storeID}/tank/{tankID}/deliveries?TankNumber={TankNumber}&GradeID={GradeID}&Before={Before}&After={After}&FilterRecordedDate={FilterRecordedDate}&SupplierGuid={SupplierGuid}&Take={Take}&Skip={Skip}&Relations={Relations}	Load list of fuel delivery
POST api/store/{storeID}/tank/{tankID}/deliveries	Adds a new fuel delivery record for a specified tank
PUT api/store/{storeID}/tank/{tankID}	Save a FuelTank in the store
POST api/store/{storeID}/tank/{tankID}/levels	Save a FuelTank in the store
POST api/store/{storeID}/tank/{tankID}/adjustments	Adds a new tank adjustment record for a tank
POST api/store/{storeID}/tank/{tankID}/hoses	Save a list of hoses for a specific store and tank
PUT api/store/{storeID}/tank/{tankID}/hose/{hoseID}/dispenser/{dispenserNo}	Save FuelHose record
POST api/store/{storeID}/dispenser/{dispenserNo}/hose/{hoseID}/reading	Adds a new hose reading record for a particular hose and dispenser
POST api/store/{storeID}/tank/{tankID}/dispenser/{dispenserNo}/hose/{hoseID}/adjustments	Adds a new hose adjustment record for a particular hose and dispenser
PUT api/store/{storeID}/fuelGrade/{id}/margin	This API will save Fuel Grade Margin field only based on FuelGradeID and Store
POST api/store/{id}/fuel/import	Import Store fuel configuration data

GeneralLedger

API	Description
GET api/generalLedger	Gets The GL Codes from the General Ledger Table
POST api/generalLedgers	Saves General Ledger
DELETE api/generalLedger/{code}	Removes the selected General Ledger Code from the database

GenericImport

All APIs used for Generic Import

API	Description
GET api/genericimport/batches?Skip={Skip}&Take={Take}&Id={Id}&GenericImportHeaderId={GenericImportHeaderId}&FileName={FileName}&ValidationStatus={ValidationStatus}&ProcessStatus={ProcessStatus}&CreatedByUser={CreatedByUser}&ImportType={ImportType}	Returns list of import batches based on filter criteria This API is used to bind Import batch grid and is being used from react app
GET api/genericimport/mappingconfigurations	Returns list of available mapping configurations with its child data - file fields and application fields mapping
GET api/genericimport/details/{importType}/{relations}	Returns list of application fields for supplied import type with its relations
POST api/genericimport/filefields/{fileDelimiter}/{headerRowIndex}/{fileType}	Get list of fields name(column header) available on uploaded file
POST api/genericimport/save	Save import detail - header, batches and mapping configurations as well
POST api/genericimport/mappingconfiguration/save	Save - Add/Update mapping configuration with child values - fiel fields and application fields mappings
POST api/genericimport/processbatch/{batchId}/{isAsync}	Add import header, batches and then Validate to check if it has any errors
POST api/genericimport/upload	Upload import batch file after correcting errors
POST api/genericimport/process/{headerId}/{isAsync}	Process import batches
DELETE api/genericimport/mappingconfiguration/{id}	Deletes mapping configuration
DELETE api/genericimport/batch/{id}	Deletes import batch

GlobalUpdate

Controller for Global Updates

API	Description
POST api/globalupdate/SubmitGlobalUpdateRequest	End point for global update submissions Processes a Global Update request, which will push out the desired changes to the desired stores
POST api/globalupdate/Rollback/{GlobalUpdateID}	Rolls back a Global Update change
GET api/globalupdate/requestlist	Returns a list of Global Update Requests which where created in the past
GET api/globalupdate/requestlist/{GlobalUpdateID}	Returns a list of Products which was touched by the supplied global update ID
POST api/globalUpdate/eCommerce	Use a product filter to request a global update
POST api/globalUpdate/electronicShelfLabel	Use a product filter to request a electronic shelf label update

Host

Management for host files

API	Description
GET api/hosts?includeAllStores={includeAllStores}	No documentation available.
GET api/host/{id}	No documentation available.
GET api/host/{id}/files	Get the files for a host
GET api/hosts/hostTypes	No documentation available.
POST api/hosts	No documentation available.
PUT api/host/{id}	No documentation available.
DELETE api/host/{id}	No documentation available.
POST api/host/{guid}/collect	No documentation available.
GET api/host/{guid}/file/{id}	No documentation available.
GET api/host/{guid}/file/{id}/metadata	No documentation available.
POST api/host/{guid}/file/{id}/markasprocessed	No documentation available.
POST api/host/{guid}/file/{id}/markasunprocessed	No documentation available.
POST api/host/{guid}/file/{fileID}/process/commoditymaps	No documentation available.
GET api/host/lastprocessed	Get the last processed (host file) host
POST api/host/{guid}/uploadHostFile	Upload a host file
GET api/host/{id}/store/{storeID}/supplier/{guid}/settings	Get HostStoreSettings for selected supplier
GET api/host/{id}/settings	No documentation available.
GET api/host/{provider}/store/{storeID}/settings	Get Hosts for selected provider and storeID
POST api/host/{id}/store/{storeID}/settings	Save a host store setting.
DELETE api/host/{id}/store/{storeID}/setting	Create a store host setting.
GET api/host/vendors	Get list of Host Vendors based on host settings
GET api/product/{guid}/hostTypes	get a list of Host Types based on product
GET api/hosts/metcash/supplier/{id}	No documentation available.
POST api/hosts/metcash	No documentation available.
GET api/host/store/{id}/supplier/{guid}	No documentation available.
GET api/zonematrix	No documentation available.
POST api/zonematrix	No documentation available.
GET api/host/{hostType}/commoditymaps?Skip={Skip}&Take={Take}&SortOrder={SortOrder}&OrderBy={OrderBy}	No documentation available.
POST api/host/{hostType}/commoditymaps	No documentation available.
POST api/host/{hostType}/commoditymaps/mscUpdate	No documentation available.
PUT api/host/{hostType}/commoditymap/{commodity}	No documentation available.
DELETE api/host/{hostType}/commoditymap/{commodity}	No documentation available.
GET api/host/promotionplacements	No documentation available.
POST api/host/promotionplacements	No documentation available.
PUT api/host/promotionplacement/{code}	No documentation available.
DELETE api/host/promotionplacement/{code}	No documentation available.
GET api/host/iba/promotionstates	No documentation available.
GET api/host/iba/state/{state}/promotiongroups	No documentation available.
GET api/host/iba/zones	No documentation available.
POST api/host/conversion/metcash	Check that this user has permission to do the conversion
POST api/host/conversion/metcashV7Numbers	Update product item numbers for MetcashV7 host
POST api/host/conversion/commodityMaps	No documentation available.
GET api/host/ilg/freightfees	No documentation available.
DELETE api/host/ilg/freightfee/{id}	No documentation available.
PUT api/host/ilg/freightfee	No documentation available.
POST api/host/ilg/freightfee	No documentation available.

HostItem

Host item batches

API	Description
GET api/host/{id}/item/counts?HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}&HideInactive={HideInactive}&ItemNumber={ItemNumber}&Barcode={Barcode}&Description={Description}&SortBy={SortBy}&SortAsc={SortAsc}	Listing all host item counts or by host identifier
GET api/hostitem/counts?id={id}&HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}&HideInactive={HideInactive}&ItemNumber={ItemNumber}&Barcode={Barcode}&Description={Description}&SortBy={SortBy}&SortAsc={SortAsc}	Listing all host item counts or by host identifier
GET api/host/{id}/items?HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}&HideInactive={HideInactive}&ItemNumber={ItemNumber}&Barcode={Barcode}&Description={Description}&SortBy={SortBy}&SortAsc={SortAsc}	Listing all host items or by host identifier
GET api/hostitems?id={id}&HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}&HideInactive={HideInactive}&ItemNumber={ItemNumber}&Barcode={Barcode}&Description={Description}&SortBy={SortBy}&SortAsc={SortAsc}	Listing all host items or by host identifier
GET api/hostitem/itemheader/{headerID}/items?FilterType={FilterType}	Listing store items
PUT api/hostitem/{id}	Updating price changes onto the holding table
PUT api/hostitem/{id}/zone	Updating price changes onto the holding table
DELETE api/hostitem/{id}/pricechange	Dropping price change items
DELETE api/hostitem/{id}/pricechange/zone	Dropping price change items from zone
POST api/hostitem/pricechange/dropselected	Dropping selected price change items
DELETE api/host/{id}/type/{type}/pricechanges	Dropping all price change items
DELETE api/hostitem/type/{type}/pricechanges?id={id}	Dropping all price change items
POST api/hostitem/{id}/apply/addition	Releasing addition items
POST api/hostitem/{id}/apply/addition/zone	Releasing addition items to zone
POST api/hostitem/apply/addition/selected	Releasing selected addition items to zone
POST api/host/{id}/apply/additions	Releasing all addition items
POST api/hostitem/apply/additions?id={id}	Releasing all addition items
POST api/hostitem/{id}/release/pricechange/zone	Releasing price change items to zone
POST api/hostitem/release/pricechange/selected	Releasing selected price change items to zone
POST api/hostitem/type/{type}/release/pricechanges?id={id}	Releasing all price change items
POST api/host/{id}/type/{type}/release/pricechanges	Releasing all price change items
GET api/host/{id}/stores	Listing related stores by host(per zone)
GET api/hoststores?id={id}	Listing related stores by host(per zone)
GET api/hostitem/pricechange/count?id={id}	Get the number of unreleased price change items.
GET api/host/{id}/pricechange/count	Get the number of unreleased price change items.
GET api/hostitem/promoheaders?id={id}&HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}	Listing host promo headers by host identifier
GET api/host/{id}/promoheaders?HostIdentifier={HostIdentifier}&Skip={Skip}&Take={Take}&HostFileID={HostFileID}&FilterType={FilterType}	Listing host promo headers by host identifier
GET api/hostitem/promoheader/{id}/promoitems?Skip={Skip}&Take={Take}	Listing promo holdings(per product) by promo header(per campaign)

HourlySales

An interface to the hourlysales table, used by some external scale systems

API	Description
POST api/hourlysales	No documentation available.

Image

Image management

API	Description
POST api/image	Upload an image
PUT api/image/{id}	Upload image data and metadata
POST api/image/{id}	Upload image data and metadata
POST api/images	No documentation available.
GET api/image?data={data}	List all image metadata
GET api/images?data={data}	List all image metadata
GET api/image/{id}/metadata?data={data}	Get image metadata and optionally data
GET api/image/{id}?width={width}&height={height}	No documentation available.
DELETE api/image/{id}	No documentation available.
GET api/image/{id}/exists	No documentation available.

Inventory

Stock tracking

API	Description
GET api/inventory/{id}?relations={relations}	Get inventory record
POST api/inventory/{id}/accuracy	Change the inventory accuracy value and update all attached base unit values
POST api/product/{pluGuid}/inventory	Create inventory and assign to the specified product
POST api/product/{pluGuid}/inventory/{inventoryGuid}	Assign this product to the specified inventory
POST api/product/{id}/alternate/{pluGuid}/inventory	Assign inventory to an alternate product. If the extended product already has inventory then the alt product will be assigned to it, and provided inventory will not be used
POST api/inventory/{id}/consolidate/{guid}	Replace two inventory records with a single consolidated one
DELETE api/inventory/{id}	No documentation available.
DELETE api/inventory/{id}/tracking	Turn off AllowAutoOrder and Inventory tracking
POST api/inventory/{id}/transfer/{guid}	No documentation available.
POST api/product/{id}/inventory/adjust	No documentation available.
POST api/inventory/{id}/adjust	No documentation available.
POST api/inventory/{id}/onOrder/reset	Reset the on order value of inventory to 0
POST api/inventory/{id}/onHand/set	Set Inventory values
GET api/inventory/{id}/history/dates?InventoryGuid={InventoryGuid}&Sort={Sort}&Relations={Relations}&ShowReasonDetail={ShowReasonDetail}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get inventory history records
GET api/inventory/{id}/history?InventoryGuid={InventoryGuid}&Date={Date}&Relations={Relations}	Get inventory history records
GET api/inventory/invoice/{invoiceID}	Get InventoryInvoice
POST api/inventory/{id}/invoice	No documentation available.
POST api/inventory/{id}/invoice/{invoiceID}	No documentation available.
GET api/inventory/{id}/product/parent	No documentation available.
GET api/inventory/{id}/products	No documentation available.
GET api/inventory/{id}/count/active	Find out how many of the products attached to this inventory record are active
GET api/product/{pluguid}/inventory	No documentation available.
POST api/product/{id}/manufacture	Record a batch of manufacture for a product, deducting inventory from ingredient products and incrementing product inventory
GET api/product/{id}/storeinventory	No documentation available.
POST api/inventory/rebuild/verifyPassword	No documentation available.
POST api/inventory/import	No documentation available.

InventoryReasons

Descriptions for stock level events

API	Description
GET api/inventoryreasons?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/inventoryreason/{id}	No documentation available.
POST api/inventoryreason	No documentation available.
POST api/inventoryreason/{id}	No documentation available.
DELETE api/inventoryreason/{id}	No documentation available.

Invoice

Electronic invoicing for Orders

API	Description
GET api/invoices	Get a list of invoices
GET api/invoice/{id}/details?Keyword={Keyword}&Search={Search}&UnknownScanOnly={UnknownScanOnly}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&ExcludeReceived={ExcludeReceived}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get invoice details
GET api/invoice/details	Get invoice details for a specified list of invoices
GET api/invoice/{id}?relations={relations}	Load an invoice
GET api/invoices/tradingPartners	List integers of trading partners with configured hosts
GET api/store/{storeID}/invoices/tradingPartners	List integers of trading partners with configured hosts
GET api/store/{storeID}/invoices/find	Identifier similar existing invoices to warn users and avoid accidental duplicates
GET api/invoice/{id}/total	Get the total values for an invoice
POST api/invoice/{id}/count	Reset the invoice received counts for a manual count
POST api/invoices/count	Reset the invoice received counts for a manual count, for multiple invoices
GET api/invoices/pickup/{storeID}
POST api/invoices/files/{storeID}	Get the total count of invoicing files for a particular store
POST api/store/{storeID}/invoices/process	Process all invoices that are on file
POST api/invoice/{id}/details	Save a list of invoice details
GET api/invoice/{id}/detail/{pluGuid}	Get invoice detail
GET api/invoice/{id}/detail/{pluGuid}/populate	Get invoice detail prepared to add a new product to an invoice
PUT api/invoice/{id}/detail/{pluGuid}	Update a single Invoice detail
POST api/invoice/{id}/detail/{pluGuid}	Update/increment or add a single invoice detail
POST api/invoice/{id}/detail/{guid}/receive	Post an image for an invoice detail
POST api/invoice/{id}/detail/{pluGuid}/price	Update a product's future price
POST api/order/{id}/invoice/{guid}/details	Creates and invoice detail for each order detail in an order
POST api/invoice/{id}/detachOrder	Formally detangle and invoice and an order
POST api/invoices	Save invoice
POST api/invoice/{id}/itemTotalCost	No documentation available.
POST api/invoice/{id}/freight	Split the invoice freight costs among all invoice lines
POST api/invoice/{id}/temperature	Save the invoice receiving temperature
POST api/invoice/{id}/rating/{rating}	Save the quality rating for the invoice
POST api/invoice/{id}/supplier/notes	Add notes to the supplier notes field
POST api/invoice/{id}/complete	API to complete invoice
POST api/invoices/complete	API to complete multiple invoices
POST api/invoice/{id}/substituteSupplier/{newSupplierGuid}	Match a generated supplier with an existing supplier
POST api/invoice/{id}/rematch	Attempt to rematch invoice using current supplier
POST api/invoice/{guid}/supplier/{id}/accept	Stop considering a supplier in need of matching
POST api/invoice/{identifier}/detail/{id}/match/{guid}	Replace the created product of an invoice detail line with a specified product.
POST api/invoice/{guid}/detail/{id}/accept	Stop considering a product as created from unknown
POST api/invoice/{guid}/detail/{id}/accept/apply	Apply an accepted product to invoice details
POST api/invoice/{id}/receiveAll	Receive all the details on the invoice.
DELETE api/invoice/{id}	Delete invoice header
DELETE api/invoice/{id}/detail/{guid}	Delete invoice detail
GET api/invoice/{id}/detail/{pluGuid}/exists	Checks if any invoice detail with same product already exists
POST api/store/{storeID}/invoices/export	Export bills for a given store
POST api/invoice/{id}/export	Export a single invoice
POST api/invoice/{id}/markasnotexported	Mark invoice as Not Exported This will be available for AccountingProvider=OzBiz(1)
POST api/invoice/{id}/notExported	Mark invoice as Not Exported This will be available for AccountingProvider=OzBiz(1)
GET api/invoice/attention/suppliers?StoreID={StoreID}&TradingPartner={TradingPartner}&InvoiceDate={InvoiceDate}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoices that require supplier matches
GET api/store/{StoreID}/invoice/attention/suppliers?TradingPartner={TradingPartner}&InvoiceDate={InvoiceDate}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoices that require supplier matches
GET api/invoice/attention/details?StoreID={StoreID}&HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoice details that require matches
GET api/store/{StoreID}/invoice/attention/details?HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoice details that require matches
GET api/attention/details/invoices?StoreID={StoreID}&HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoices that require detail matches
GET api/store/{StoreID}/attention/details/invoices?HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List invoices that require detail matches
GET api/attention/details/orders?StoreID={StoreID}&HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List orders belonging to invoices that require detail matches
GET api/store/{StoreID}/attention/details/orders?HeaderIdentifier={HeaderIdentifier}&InvoiceDate={InvoiceDate}&TradingPartner={TradingPartner}&SupplierIdentifier={SupplierIdentifier}&OrderGuid={OrderGuid}&SortBy={SortBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List orders belonging to invoices that require detail matches
GET api/invoice/discrepancy/orders?StoreID={StoreID}&TradingPartner={TradingPartner}&InvoiceDate={InvoiceDate}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get all invoices that have an unknown order attached
GET api/store/{StoreID}/invoice/discrepancy/orders?TradingPartner={TradingPartner}&InvoiceDate={InvoiceDate}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get all invoices that have an unknown order attached
GET api/invoice/discrepancy/details?StoreID={StoreID}&HeaderIdentifier={HeaderIdentifier}&SupplierIdentifier={SupplierIdentifier}&InvoiceDate={InvoiceDate}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get all invoice details that have a discrepancy
GET api/store/{StoreID}/invoice/discrepancy/details?HeaderIdentifier={HeaderIdentifier}&SupplierIdentifier={SupplierIdentifier}&InvoiceDate={InvoiceDate}&OrderBy={OrderBy}&AscOrDesc={AscOrDesc}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get all invoice details that have a discrepancy

KPIGrouping

Controller to handle KPI Groups/Targets/Figures

API	Description
GET api/kpigroup/list	Returns a list of all KPI Department Groupings
POST api/kpigroup/create	Creates a KPI Department Group
GET api/kpigroup/{ID}	Returns a single KPI Department Group
POST api/kpigroup/update/{ID}	Updates a single KPI Department Group
DELETE api/kpigroup/delete/{ID}	Deletes a single KPI Department Group
GET api/kpigroup/ExistsByID/{ID}	Checks if a KPI Dept Group exists by ID
GET api/kpigroup/ExistsByName/{name}	Checks if a KPI Dept Group exists by ID
POST api/store/{storeID}/kpigroup/{KPIGroupID}/figures	Saves KPI Labour Figures for the supplied KPI Group
GET api/store/{storeID}/kpigroup/{KPIGroupID}/figures	Gets the weekly labor figures for the supplied KPI Group ID
GET api/store/{storeID}/kpigroup/{KPIGroupID}/figures/monthly	Gets the monthly labor figures for the supplied KPI Group ID
GET api/store/{storeID}/kpigroup/{KPIGroupID}/targets	Gets the weekly KPI Targets for the supplied KPI Group ID
GET api/store/{storeID}/kpigroup/{KPIGroupID}/targets/monthly	Gets the monthly KPI Targets for the supplied KPI Group ID
POST api/store/{storeID}/kpigroup/{KPIGroupID}/targets	Saves the KPI Targets for the supplied KPI Group ID
GET api/kpigroup/departments	Gets a list of departments which have not already been used in a KPI Group

LabelPageLayout

Label pages

API	Description
GET api/labelPageLayouts?storeID={storeID}&Keyword={Keyword}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List label page layouts
GET api/store/{storeID}/labelPageLayouts?Keyword={Keyword}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List label page layouts
GET api/labelpagelayout/{guid}	No documentation available.
GET api/labelpagelayout/name/{LayoutName}/exists	Find out if a page layout name is already in use
PUT api/labelpagelayout/{guid}	Update a page layout
POST api/labelpagelayouts	Update or Create a page layout
DELETE api/labelpagelayout/{guid}	No documentation available.
GET api/labelpagelayout/{guid}/store/{storeID}/printer	No documentation available.
POST api/labelpagelayout/{guid}/store/{storeID}/printers	No documentation available.
DELETE api/labelpagelayout/{guid}/store/{storeID}/printer	No documentation available.

LeadInOut

Lead in/out

API	Description
GET api/leadinoutsummary/{id}/leadinouts	No documentation available.
GET api/leadinout/tree/{code}	No documentation available.
GET api/leadinoutsummary/{summaryID}/periodType/{periodType}/promotionTypeCodes	No documentation available.
PUT api/leadinout/{id}	No documentation available.
POST api/leadinouts	No documentation available.
DELETE api/leadinoutsummary/{id}/leadinouts	No documentation available.
GET api/leadinoutsummaries	No documentation available.
POST api/leadinoutsummaries	No documentation available.
PUT api/leadinoutsummary/{id}/description/{description}	No documentation available.
GET api/leadinoutsummary/availablehosts/provider/{hostProvider}	No documentation available.

LeadInOutMemberPricing

API	Description
GET api/memberPricing/departmentAllocations	No documentation available.
POST api/memberPricing/departmentAllocations	No documentation available.
GET api/memberPricing/customerGroups	No documentation available.
POST api/memberPricing/customerGroups	No documentation available.

Licence

Licence attributes

API	Description
GET api/licence	Get the Licence Attributes for the currently authenticated user. These are determined from their Stores, and associated attributes from GaPUpdateWeb.

Limits

Retail Customer and loyalty account limits

API	Description
GET api/limits	No documentation available.
GET api/limit/{id}?value={value}	No documentation available.
POST api/limit/{id}	No documentation available.
DELETE api/limit/{id}	No documentation available.

Markdown

API	Description
GET api/markdown/exists	Find a markdown record
POST api/markdowns	Add a markdown record
DELETE api/markdown/{id}	Remove a markdown record

Message

Business event notifications

API	Description
GET api/message?Skip={Skip}&Take={Take}&StoreID={StoreID}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/messages?Skip={Skip}&Take={Take}&StoreID={StoreID}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/message/{id}?deserialiseDocument={deserialiseDocument}	No documentation available.
GET api/store/{storeID}/message?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/messages?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/operator/{operatorGuid}/message?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/operator/{operatorGuid}/messages?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/operator/{operatorGuid}/message?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/operator/{operatorGuid}/messages?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/message?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/messages?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/message/count?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/messages/count?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/operator/{operatorGuid}/message/count?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/operator/{operatorGuid}/messages/count?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/message/count?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/messages/count?Skip={Skip}&Take={Take}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/operator/{operatorGuid}/message/count?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/store/{storeID}/machine/{machineName}/operator/{operatorGuid}/messages/count?Skip={Skip}&Take={Take}&Sender={Sender}&User={User}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/message/count?Skip={Skip}&Take={Take}&StoreID={StoreID}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
GET api/messages/count?Skip={Skip}&Take={Take}&StoreID={StoreID}&OperatorGuid={OperatorGuid}&Sender={Sender}&User={User}&MachineName={MachineName}&External={External}&IncludeReceived={IncludeReceived}&IncludeSnoozed={IncludeSnoozed}&MessageTypes={MessageTypes}&DeserialiseDocument={DeserialiseDocument}	No documentation available.
POST api/message	Create or update a message
POST api/messages	Create or update a message
PUT api/message/{id}	Update a message
POST api/operator/{operatorID}/message/{messageID}/acknowledge	No documentation available.
POST api/message/{id}/acknowledge	No documentation available.
POST api/message/acknowledge?storeID={storeID}&operatorGuid={operatorGuid}&user={user}	No documentation available.
POST api/message/{id}/snooze	Stop notifying users about a message
DELETE api/message/{id}	No documentation available.
GET api/message/{id}/document	Gets the message document, provided that the client can understand it
PUT api/message/{id}/document	Updates message document
GET api/message/senders	No documentation available.

ModifierSet

POS modifiers for Cafe products

API	Description
GET api/modifierSets	Loads all modifiers based on query
GET api/modifierSet/{name}/exists	Checks if modifier set name has been used
GET api/modifierSet/{id}?relations={relations}&loadProducts={loadProducts}	Get modifier set
POST api/modifierSets/new	Create a new Modifier Set
PUT api/modifierSet/new/{id}	Put Modifier Set
DELETE api/modifierSet/{id}	Delete modifier set
DELETE api/store/{storeID}/modifierSet/{id}	Deprecated. Use DELETE 'api/modifierSet/{id}' instead Removed after 30 Jun 2025
GET api/modifierSet/{setID}/productModifierSets	Loads all product modifier sets based on query
GET api/product/{id}/modifierSets	Get modifier sets which have the specified product attached to them
GET api/product/{id}/modifierSet/{name}/exists	Checks if modifier set name has been used in a product modifier set
GET api/store/{storeID}/product/{id}/modifierSet/{name}/exists	Checks if modifier set name has been used in a StoreProduct modifier set
POST api/product/{id}/modifierSet/{guid}/sort	Sort a product's modifier sets
POST api/modifierSet/{setID}/productModifierSets	Assign a product to an existing modifier set
PUT api/modifierSet/{setID}/productModifierSet/{pluGuid}	Update an existing product's link to a modifier set
PUT api/store/{storeID}/modifierSet/{setID}/productModifierSet/{pluGuid}	Update an existing store product's link to a modifier set
DELETE api/modifierSet/{setID}/productModifierSet/{pluGuid}	Delete an existing product's link to a modifier set
POST api/store/{storeID}/modifierSet/{setID}/productModifierSets	Assign a store product to an existing modifier set
DELETE api/store/{storeID}/modifierSet/{setID}/productModifierSet/{pluGuid}	Delete an existing store product's link to a modifier set
POST api/product/{guid}/modifierSet/{id}	Add a list of exclusion modifiers from product recipe to modifier set (as new group if modifiers already exist)
GET api/modifierSets/default	Deprecated. ModifierSets no longer have defaults; Use GET 'api/modifierSets' with storeID=pluGuid=null instead Removed after 30 Jun 2025
POST api/modifierSets	Deprecated. Use POST 'api/modifierSets/new' and/or POST 'api/modifierSet/{id}/productModifierSets' instead Removed after 30 Jun 2025
POST api/store/{storeID}/modifierSets	Deprecated. Use POST 'api/modifierSets/new' and/or POST 'api/store/{storeID}/modifierSet/{setID}/productModifierSets' instead Removed after 30 Jun 2025
PUT api/modifierSet/{id}	Deprecated. Use PUT 'api/modifierSet/new/{id}' and/or POST 'api/modifierSet/{setID}/productModifierSets' instead Removed after 30 Jun 2025
PUT api/store/{storeID}/modifierSet/{id}	Deprecated. Use PUT 'api/modifierSet/new/{id}' and/or PUT 'api/store/{storeID}/modifierSet/{setID}/productModifierSet/{pluGuid}' instead Removed after 30 Jun 2025

OpenTill

Open Till controller

API	Description
GET api/openTillReasons	Get all OpenTillReasons
GET api/openTillReason/{name}/exists	No documentation available.
POST api/openTillReasons	Save all open till reasons
POST api/openTills/import	Import a list of open till records
DELETE api/store/{storeID}/openTills/processAsync	remove a open till task identifier from AsyncRunner
GET api/changeAmounts	No documentation available.
GET api/changeAmount/{name}/exists	No documentation available.
POST api/changeAmounts	No documentation available.

Operator

POS Operators/Staff

API	Description
GET api/operators	Query operators
GET api/store/{storeID}/operators	Query operators
GET api/operators/sales	Get operators based on sales history
GET api/operator/{id}	No documentation available.
GET api/operator/{number}/exists	Search for operator using operator number
GET api/operator/tag/{rfid}/exists	Search for operator using rfid tag
GET api/operator/tag/{rfid}/find	Search for operator using rfid tag
GET api/operator/{number}/find	Search for operator using operator number
POST api/Operator/Account	No documentation available.
GET api/Operator/Account/{email}	No documentation available.
POST api/operator/{id}	No documentation available.
POST api/operator	No documentation available.
PUT api/operator/{id}	No documentation available.
DELETE api/operator/{id}	Soft delete operator
DELETE api/operator/{id}/hard	Hard delete operator
POST api/operator/{guid}/unlock	Unlock an Operator, allowing them to access POS,etc again
POST api/operator/{guid}/logout	Forcibly log an Operator out of POS. Used for recovering crashed users
POST api/operator/{id}/enable	Re-enable a soft deleted operator
GET api/operator/{id}/{password}	Check operator, returning if Operator number and password match
POST api/store/{id}/operators/import	Import a list of operators from a store
POST api/operator/overrides/import	Import a list of operator overrides

OperatorGroup

POS Operator/Staff groups

API	Description
GET api/operatorGroups?Search={Search}&Take={Take}&Skip={Skip}	Get a list of Operator Groups
GET api/operatorgroup/{id}	Get a operator
POST api/operatorgroups	No documentation available.
PUT api/operatorgroup/{id}	Update operator group name
DELETE api/operatorGroup/{id}	Delete operator group
GET api/operatorGroup/name/{name}/exists	Get the guid of an Operator Group with a group name
GET api/operatorGroup/open/exists	Check if the Open Operator Group exists

OperatorPermissions

POS Operator/Staff permissions

API	Description
GET api/operatorGroup/{id}/permissions	No documentation available.
PUT api/operatorGroup/{id}/permissions	No documentation available.
POST api/operatorGroup/{id}/permissions/all	No documentation available.
PUT api/operatorGroup/{id}/permissions/{role}	No documentation available.
GET api/operatorGroup/{id}/permissions/{role}	No documentation available.
DELETE api/operatorGroup/{id}/permissions/{role}	No documentation available.
DELETE api/operatorGroup/{id}/permissions	No documentation available.

OperatorRole

POS Operator/Staff Roles, assigned to Groups

API	Description
GET api/operatorRoles	List operator roles
GET api/operatorRole/{id}	Get an operator role

Order

Purchase Orders

API	Description
GET api/order/{id}?relations={relations}	No documentation available.
GET api/order/id/{id}?relations={relations}&details={details}	No documentation available.
GET api/pde/order/id/{id}	Returns the order details as needed to summarise them for the PDE order receiving screen.
POST api/order	No documentation available.
POST api/orders	No documentation available.
PUT api/order/{id}	No documentation available.
POST api/order/{id}	No documentation available.
POST api/order/{id}/supplier/notes	Add notes to the supplier notes field
POST api/order/{id}/clone	No documentation available.
POST api/order/{id}/temperature	Save the order receiving temperature
POST api/order/{id}/rating/{rating}	Save the quality rating for the order
DELETE api/order/{id}	No documentation available.
POST api/order/{id}/restore	Restore a safely deleted draft order
GET api/order/{id}/details	No documentation available.
POST api/order/{id}/details/filter	Find and add matching products into order
GET api/order/{id}/detail/{pluGuid}/quantity	Returns the quantity of a product in an order
GET api/order/{id}/detail/{pluGuid}?relations={relations}	Returns the product of an order detail line
POST api/order/{id}/detail/{pluGuid}/status	Set the order detail status of a detail line in an order
POST api/order/{id}/detail/{pluGuid}/substitute/{guid}	Set the order detail status of a detail line in an order
PUT api/order/{id}/detail/{pluGuid}	Save order detail
POST api/order/{id}/detail/{pluGuid}	Save order detail
POST api/order/{id}/detail/{pluGuid}/receive	Post an image for an order detail
POST api/order/{id}/products	Save multiple products to order detail
POST api/order/{id}/details	Save a list of order details
POST api/order/{id}/input	Accept an order input from PDE and process into a new order detail line
POST api/store/{storeID}/order/{id}/input	Accept an order input from PDE and process into a new order detail line
DELETE api/order/{id}/detail/{pluGuid}	Remove an order detail from an order
DELETE api/order/{id}/details	Delete all order details
DELETE api/order/{id}/details/zero	Delete all order details
POST api/offlineOrders	No documentation available.
POST api/order/{id}/document/{orderDocumentId}	No documentation available.
GET api/orders	Lists orders matching query paramenters
GET api/product/{id}/history/purchases	Lists purchase orders and invoices matching query parameters, that have specified product in detail table
GET api/orders/tradingpartners	List integers of trading partners with configured hosts
GET api/store/{storeID}/orders/tradingpartners	List integers of trading partners with configured hosts
GET api/tradingPartner/{id}/store/{storeID}/host/{guid}/orderCodes	Get available host order codes
GET api/order/{id}/total	Get the order total values
GET api/order/{id}/empty	Find out if the order has any facially valid order details This does not perform Barcode and ItemNumber validation
GET api/product/{id}/orderLookup	Order History information
GET api/orderDetail	Populate and order detail with cost and details based on product and supplier information
POST api/order/{id}/split/{mode}	Split an order
POST api/order/{id}/send	Send an order
POST api/order/{id}/resend	No documentation available.
POST api/order/{id}/sent	Mark an order as sent
POST api/order/{id}/cancel	Cancel a sent order
POST api/order/{id}/counted	Update an order and change it's status to Counted
POST api/order/{id}/stockReceive	Update an order and change it's status to Stock Receive. Performs logical updates for this
POST api/order/{id}/receive	Mark order as received
POST api/order/{id}/receiveAll	Mark all order detail lines as received
POST api/order/{id}/complete	Mark order as completed
POST api/order/{id}/picking	Mark order as picking
POST api/order/{id}/pickAll	Mark all order detail lines as picked
POST api/order/{id}/picked	Mark order as picked
POST api/order/{id}/transit	Mark order as in transit
POST api/order/{id}/shipAll	Mark all order detail lines as shipped
POST api/order/{id}/shipped	Mark order as received
POST api/order/{id}/editorder	Reopen order for editing after it has been sent

OtherCountryOfOrigin

Other Country of Origins list

API	Description
GET api/countriesOfOrigin	List all other countries of origin
GET api/countriesOfOrigin/{origin}/exists	Check if country of origin already exists
POST api/countriesOfOrigin	Add or save a country of origin record
DELETE api/countryOfOrigin/{id}	Remove a saved other country of origin

Pde

API	Description
GET api/version/{id}	No documentation available.
GET api/apk/{id}	No documentation available.

Permission

Web User permissions

API	Description
GET api/permissions/defaults	No documentation available.

Playlist

Playlists

API	Description
GET api/playlists?Skip={Skip}&Take={Take}&Search={Search}&Active={Active}&includeEnded={includeEnded}	List all playlists without relations
GET api/playlist/{ID}	Load a specific playlist with relations
POST api/playlists	Add a playlist
PUT api/playlist/{id}	Update a playlist along with its relations
DELETE api/playlist/{id}	Delete a playlist along with its relations

PluRecogniser

API	Description
POST api/plurecognisers	No documentation available.
DELETE api/plurecogniser/{pluGuid}	No documentation available.
GET api/plurecogniser/{id}/product/apn	No documentation available.
GET api/plurecogniser/{pluGuid}?storeIDs[0]={storeIDs[0]}&storeIDs[1]={storeIDs[1]}	No documentation available.

PosPopupMessage

POS popup messages

API	Description
GET api/pos/messages?Take={Take}&Skip={Skip}&Search={Search}&CountEvents={CountEvents}&OrderBy={OrderBy}&SortOrder={SortOrder}	Get matching PopupMessages
GET api/pos/message/{id}	Get PopupMessage object at the guid location
GET api/pos/message/{name}/exists	Get PopupMessage object at the guid location
POST api/pos/message	Add or update a PopupMessage
PUT api/pos/message/{id}	Place PopupMessage object at the guid location
DELETE api/pos/message/{id}	Delete PopupMessage at the GUID location and associated DialogMessageEvents
POST api/pos/message/import	Save a list of popup messages
GET api/pos/message/{id}/products	Get matching products for popup message
POST api/pos/message/{id}/products	Add products to popup message
POST api/pos/message/{id}/product/{guid}/displayType/{type}	Change the dialog display type
DELETE api/pos/message/{id}/product/{guid}	Remove product from popup message; if guid is for master product, remove all products
DELETE api/pos/message/{id}/product/{guid}/store/{storeID}	Remove product from popup message using guid for master prodduct
GET api/pos/message/{id}/campaigns?Take={Take}&Skip={Skip}&Search={Search}&DisplayType={DisplayType}&OrderBy={OrderBy}&SortOrder={SortOrder}	Get matching campaigns for popup message
POST api/pos/message/{id}/campaigns	Add campaigns to popup message
POST api/pos/message/{id}/campaign/{campaignName}/displayType/{type}	Change the dialog display type
DELETE api/pos/message/{id}/campaign/{campaignName}	Add campaigns to popup message
GET api/pos/message/{id}/sellingRules?Take={Take}&Skip={Skip}&OrderBy={OrderBy}&SortOrder={SortOrder}

PrePack

API	Description
POST api/prepacks/import	No documentation available.

PriceGroup

Product Price Groups

API	Description
GET api/pricegroup/{id}	Get PriceGroup object
GET api/pricegroups?Take={Take}&Skip={Skip}&Search={Search}&Code={Code}&CountProducts={CountProducts}&OrderBy={OrderBy}&SortOrder={SortOrder}	Get matching PriceGroups
GET api/priceGroup/{name}/exists	Find a price group by name
POST api/pricegroup	Add or update a PriceGroup
PUT api/pricegroup/{id}	Place PriceGroup object at the guid location
GET api/pricegroup/{id}/products	Get products in the price group
GET api/pricegroup/{id}/details?storeID={storeID}	Get Product settings of other price group products
GET api/store/{storeID}/pricegroup/{id}/details	Get Product settings of other price group products
PUT api/priceGroup/{id}/product/{guid}	Sets a specified product's price group
POST api/priceGroup/{id}/products	Sets a group of products' price group
DELETE api/priceGroup/{id}/product/{guid}	Removes a product from a specified price group
DELETE api/store/{storeID}/priceGroup/{id}/product/{guid}	Removes a product from a specified price group
DELETE api/pricegroup/{id}	Delete PriceGroup object at the guid location
POST api/pricegroups/import	Save a list of price groups

PriceLevel

Price Level maintenance APIs

API	Description
GET api/pricelevels	Load all price levels
GET api/product/{guid}/pricelevels	Load all product price levels
POST api/pricelevels	Add/udpate price levels
POST api/product/{guid}/pricelevels	Save price level for master product
POST api/store/{id}/product/{guid}/pricelevels	Save price level for store product
DELETE api/pricelevel/{id}	Delete an existing price level

PriceZone

Store Zones

API	Description
GET api/pricezone	No documentation available.
GET api/pricezones	No documentation available.
GET api/pricezone/{id}	No documentation available.
POST api/pricezone	No documentation available.
POST api/pricezone/{id}	No documentation available.
PUT api/pricezone/{id}	No documentation available.
POST api/pricezone/{id}/sort	Re-sort a price zone
DELETE api/pricezone/{id}	No documentation available.
POST api/pricezones/import	No documentation available.

PrintBatch

Label print batches

API	Description
GET api/printbatches?storeID={storeID}&Take={Take}&Skip={Skip}&PrintBatchType={PrintBatchType}&PrintRequestType={PrintRequestType}&User={User}&Process={Process}&PendingOnly={PendingOnly}&Description={Description}&StartDate={StartDate}&EndDate={EndDate}&Relations={Relations}	List print batches requested
GET api/store/{storeID}/printbatches?Take={Take}&Skip={Skip}&PrintBatchType={PrintBatchType}&PrintRequestType={PrintRequestType}&User={User}&Process={Process}&PendingOnly={PendingOnly}&Description={Description}&StartDate={StartDate}&EndDate={EndDate}&Relations={Relations}	List print batches requested
GET api/printbatch/{id}	Get print batch object
POST api/printbatches	Saves a print batch header without a guid as a new print batch.
PUT api/printbatch/{id}	Save print batch header
DELETE api/printbatch/{id}	Delete print batch header and associated print batch details
POST api/printbatch/{id}/merge/{guid}	Merge all additional details from a second Print Batch into this Print Batch
POST api/printbatch/{id}/reprint	Set print batch up to be easily reprinted by resetting the printed value of details
GET api/printbatches/talkers/available?Take={Take}&Skip={Skip}&Description={Description}&StoreID={StoreID}&StartDate={StartDate}&EndDate={EndDate}&CampaignType={CampaignType}&Active={Active}&Printed={Printed}&System={System}	Get a list of available campaigns for printing. Never returns PriceChange Campaigns
GET api/store/{storeID}/printBatches/{type}/users	Get all users for unprinted batches
GET api/printBatches/campaigns?storeID={storeID}	Get a list of unique campaigns for unprinted batches
GET api/store/{storeID}/printBatches/campaigns	Get a list of unique campaigns for unprinted batches
POST api/printBatch/{id}/details	This is a GET request masked as a POST request to get around query string limits for location filtering. Lists print batch products/locations in request
POST api/printBatch/details	This is a GET request masked as a POST request to get around query string limits for location filtering. Lists all print batch products and is written/added for react app
GET api/printBatch/{id}/details/count	This is a GET request masked as a POST request to get around query string limits for location filtering. Gets a count of details that match request
POST api/printBatch/details/count	Get a count of particular item(Warehouse Indicator items) for current search criteria This is a GET request masked as a POST request to get around query string limits for location filtering. Need to pass the specific item=true for which count is needed This is used by react app
POST api/printBatch/designs/{designCount}/pageCount	This is a GET request masked as a POST request to get around query string limits for location filtering. Gets a count of labels printed based on current settings that can be used to determine a page count
GET api/printBatch/{id}/operators/available	List operators matching query that are not already in the print batch header
GET api/printBatch/{id}/detail/{guid}?relations={relations}	Get print batch detail which match the printbatch and product information, location information is assumed to be default
GET api/printBatch/{id}/detail/{guid}/location/{identifier}?relations={relations}	Get print batch detail which match the printbatch, product and location information
PUT api/printBatch/{id}/detail/{guid}	Save print batch detail, location guid is assumed to be empty guid
PUT api/printBatch/{id}/detail/{guid}/location/{loc}	Save print batch detail
DELETE api/printBatch/{id}/detail/{guid}	Delete print batch detail, location guid is assumed to be empty guid
DELETE api/printBatch/{id}/detail/{guid}/location/{loc}	Delete print batch detail
POST api/campaign/{name}/printbatches	Create a new print batch from the specified campaign. If no StoreID is set, will create a new print batch for each store the campaign has.
POST api/store/{storeID}/pricegroup/{id}	Add all products of price group to print batch Based on StoreID and other header details, it will try to find existing matching print header or add new one. This API is being used from react app
POST api/store/{storeID}/printbatch/plus	Add all products to an existing/new print batch This API is being used by react app
POST api/printBatch/store/{storeID}/details/filter	Request product filter labels
POST api/store/{storeID}/printBatch/details	Add all PrintBatchDetails to an existing/new print batch
POST api/product/{id}/print	Add the product specified in all locations to a matching or new print list
POST api/product/{id}/location/{loc}/print	Add the product specified in location specified to a matching or new print list
POST api/store/{storeID}/product/{id}/print	Add the product specified in all locations to a matching or new print list
POST api/store/{storeID}/product/{id}/location/{loc}/print	Add the product specified in location specified to a matching or new print list
POST api/shelfLocation/{id}/print	Add shelf location specified to a new or existing printbatch.
POST api/printBatches/details/printed	Mark all details that match with provided print batch filters
POST api/printBatch/details/printed?printedTimeUtc={printedTimeUtc}	Mark all the details that are provided as printed at the same time
POST api/printBatch/details/printed/{printedTimeUtc}	Mark all the details that are provided as printed at the same time
PUT api/printBatch/details/markAsUnprinted	No documentation available.
PUT api/printBatch/printedTime/{printedTime}/markAsUnprinted	No documentation available.
POST api/store/{id}/signiqprint	Export an .imp file in the HFM layout style

Printer

Label printers

API	Description
GET api/printers?Take={Take}&Skip={Skip}&Search={Search}	Get list of printers
GET api/store/{storeID}/windowsPrinters?connected={connected}	Gets the available printers for the given store.
POST api/store/{storeID}/windowsPrinters	Updates the list of windows printers
GET api/windowsPrinters?connected={connected}	Gets the available printers.
GET api/printer/{name}	Get or Find Printer
GET api/printerGroups?Take={Take}&Skip={Skip}&Search={Search}&IncludeDeleted={IncludeDeleted}	Get list of printer groups
GET api/printerGroup/{name}?relations={relations}	Get PrinterGroup
GET api/printerGroup/{name}/printer/{printerName}	Get a PrinterGroup member
PUT api/printer/{name}	Update printer
POST api/printer/{name}/delete	Safely remove printer
DELETE api/printer/{name}	Delete printer
POST api/printerGroups	Create PrinterGroup
PUT api/printerGroup/{name}	Update PrinterGroup
POST api/printerGroup/{name}/delete	Safely remove PrinterGroup
DELETE api/printerGroup/{name}	Delete PrinterGroup
PUT api/printerGroup/{name}/printer/{printerName}	Add a Printer to a PrinterGroup
DELETE api/printerGroup/{name}/printer/{printerName}	Remove a Printer from a PrinterGroup safely

Product

Product maintenance

API	Description
GET api/product/{id}?relations={relations}&includeStoreProducts={includeStoreProducts}	No documentation available.
PATCH api/product/{id}	No documentation available.
POST api/product	No documentation available.
POST api/products	No documentation available.
POST api/product/{id}	No documentation available.
PUT api/product/{id}	No documentation available.
PUT api/store/{storeID}/product/{id}	Create or update a product
PUT api/product/plu/{plu}	No documentation available.
POST api/product/plu/{plu}	No documentation available.
POST api/store/{storeID}/products	Create or Save a product
PATCH api/store/{storeID}/product/{id}	No documentation available.
POST api/store/{storeID}/product/{id}/fastPricing	Update product pricing
DELETE api/product/{id}	Delete a product via guid, from master and all stores
DELETE api/store/{storeID}/product/{id}	Delete a product via guid. Deletes product from store only.
GET api/product/{id}/exists	No documentation available.
GET api/store/{storeID}/product/{id}/exists	No documentation available.
GET api/product	No documentation available.
GET api/products	No documentation available.
GET api/store/{storeID}/products	Product lookup
GET api/products/filter	Return products as filtered by product filter model
GET api/store/{storeID}/products/filter	Return products as filtered by product filter model
GET api/store/{storeID}/product/{id}	Get store product
GET api/store/{storeID}/product/findexternal/{externalID}	No documentation available.
GET api/product/plu/{id}	No documentation available.
GET api/product/findexternal/{externalID}	No documentation available.
GET api/product/apn/{id}	Look up master products via APN
POST api/product/{id}/tun/{tun}	No documentation available.
POST api/store/{storeID}/product/{id}/tun/{tun}	No documentation available.
POST api/product/tuns	No documentation available.
DELETE api/product/{id}/apn/{apn}/tun/{tun}	No documentation available.
DELETE api/store/{storeID}/product/{id}/apn/{apn}/tun/{tun}	No documentation available.
GET api/tun/{tun}/tuns	Look up TUN for master product
GET api/store/{storeID}/tun/{tun}/tuns	Look up TUNs for store product. Should only be one for a given store
GET api/product/{id}/competitionPricing?storeID={storeID}	Get a competition pricing for a product
GET api/store/{storeID}/product/{id}/competitionPricing	Get a competition pricing for a product
POST api/product/{id}/competitionpricings	Save/Add Competition Pricing
PUT api/product/{id}/competitionpricing/{guid}	Save Competition Pricing
GET api/product/itemnumber/{itemNumber}	No documentation available.
GET api/store/{storeID}/product/tun/{tun}/ids	No documentation available.
GET api/product/tun/{tun}/ids	No documentation available.
GET api/product/plu/next	Retrieve the next Scale PLU number in the sequence
GET api/department/{code}/product/plu/next	Retrieve the next Scale PLU number in the sequence for a department
GET api/product/plu/{plu}/id	Retrieve a Product via its Scale PLU
GET api/product/apn/{apn}/ids	No documentation available.
GET api/product/apn/{apn}/checkexistingdeleted	No documentation available.
GET api/product/{id}/restoredeleted	Restore the master product with the specified guid.
GET api/product/{id}/allergens	Get product's allergen information
POST api/product/{id}/allergens	Save product allergen information
POST api/store/{storeID}/product/{id}/allergens	Save product allergen information
DELETE api/product/{id}/allergen/{allergenID}	Remove allergen information
GET api/product/{id}/costs	Retrieves all costings for a Product
GET api/store/{storeID}/product/{id}/costs	Retrieves all costings for a Product
GET api/product/{id}/dates	Retrieve dates for a product
GET api/store/{storeID}/product/{id}/dates	Retrieve dates for a product
POST api/product/{id}/parent/{guid}	Assign a parentPluGuid and PCR to a product
POST api/store/{storeID}/product/{id}/parent/{guid}	Assign a parentPluGuid and PCR to a product
DELETE api/product/{id}/parent	Remove parent guid from a product
DELETE api/store/{storeID}/product/{id}/parent	Remove parent guid from a product
GET api/product/{guid}/children	No documentation available.
GET api/store/{storeID}/product/{guid}/children	No documentation available.
GET api/product/{guid}/priceverify	No documentation available.
GET api/product/{id}/storeprices	No documentation available.
GET api/store/{storeId}/batch/{batchId}/products?Skip={Skip}&Take={Take}&SortBy={SortBy}&SortDirection={SortDirection}	No documentation available.
GET api/store/{storeID}/product/plu/{plu}	No documentation available.
GET api/store/{storeID}/product/apn/{apn}	Looks up products in store matching the given APN
GET api/store/{storeID}/product/plu/{plu}/id	No documentation available.
GET api/store/{storeID}/product/apn/{apn}/ids	No documentation available.
GET api/store/{storeID}/check/{apn}	Check for a store product with an apn and get or create store product
GET api/store/{storeID}/provider/{providerName}/products/names	This returns unique product names for specific provider name and store
GET api/product/{id}/buyinglimits	No documentation available.
POST api/product/{id}/buyinglimits	No documentation available.
POST api/products/calculateaws	No documentation available.
POST api/product/{guid}/scalelocation/{deptNo}	No documentation available.
DELETE api/product/{guid}/scalelocation/{deptNo}	No documentation available.
POST api/product/plu/{plu}/apn/{apn}	No documentation available.
POST api/product/{id}/apn/{apn}	No documentation available.
POST api/store/{storeID}/product/{id}/apn/{apn}	No documentation available.
DELETE api/product/{id}/apn/{apn}	No documentation available.
DELETE api/store/{storeID}/product/{id}/apn/{apn}	No documentation available.
DELETE api/product/plu/{plu}/apn/{apn}	No documentation available.
DELETE api/store/{storeID}/product/plu/{plu}/apn/{apn}	No documentation available.
PUT api/store/{storeID}/product/plu/{plu}	No documentation available.
POST api/store/{storeID}/product/plu/{plu}	No documentation available.
POST api/store/{storeID}/product/plu/{plu}/stockunitmeasure/{code}	No documentation available.
POST api/product/plu/{plu}/stockunitmeasure/{code}	No documentation available.
DELETE api/store/{storeID}/product/plu/{plu}/stockunitmeasure/{code}	No documentation available.
DELETE api/product/plu/{plu}/stockunitmeasure/{code}	No documentation available.
POST api/product/{guid}/supplier/{id}/preferred	Set a product's preferred supplier to this supplier
GET api/product/{guid}/pricehistory?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/store/{storeID}/product/{guid}/pricehistory?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
POST api/product/item/{plu}/hierarchy	No documentation available.
POST api/store/{storeID}/product/item/{plu}/hierarchy	Perform an update to all products via Item number.
GET api/product/{guid}/ingredients?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of ingredients for a product
GET api/product/{guid}/manufacturedProducts?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Gets a list of products that use the current product as an ingredient
GET api/store/{storeID}/product/{guid}/ingredient/{ingredientGuid}	Get a product ingredient
GET api/product/{guid}/ingredient/{ingredientGuid}	Get a product ingredient
PUT api/product/{guid}/ingredient/{ingredientGuid}	Add / save an ingredient to a product
PUT api/store/{storeID}/product/{guid}/ingredient/{ingredientGuid}	Add / save an ingredient to a product
DELETE api/product/{guid}/ingredient/{ingredientGuid}	Remove an ingredient from a product
DELETE api/store/{storeID}/product/{guid}/ingredient/{ingredientGuid}	Remove an ingredient from a product
POST api/product/{id}/ingredients/cost	Update cost of a product based on it's ingredient's product costs
POST api/store/{storeID}/product/{id}/ingredients/cost	Update cost of a product based on it's ingredient's product costs
POST api/product/{guid}/ingredient/cost?id={id}	Update the cost of manufactured products which has this product as an ingredient
GET api/product/export?guids[0]={guids[0]}&guids[1]={guids[1]}	No documentation available.
GET api/product/apn/export?apns[0]={apns[0]}&apns[1]={apns[1]}	No documentation available.
POST api/product/stockunitmeasure/import	No documentation available.
POST api/product/import	No documentation available.
POST api/product/parents/import	Set PCRs en masse
POST api/product/apns/import	No documentation available.
POST api/product/item/hierarchy/import	No documentation available.

ProductActivation

Product activation and deactivation

API	Description
POST api/product/{id}/activate	Activates a product
POST api/store/{storeID}/product/{id}/activate	Activates a product
POST api/product/{id}/deactivate	Deactivates a product
POST api/store/{storeID}/product/{id}/deactivate	Deactivates a product

ProductDateCheck

POS Product Date Check

API	Description
GET api/productdatechecks?StoreID={StoreID}&Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&id={id}&guid={guid}	Get all Product Date Expiry
GET api/product/{id}/datechecks?StoreID={StoreID}&Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&guid={guid}	Get all Product Date Expiry
GET api/shelfLocation/{guid}/datechecks?StoreID={StoreID}&Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&id={id}	Get all Product Date Expiry
GET api/store/{StoreID}/productdatechecks?Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&id={id}&guid={guid}	Get all Product Date Expiry
GET api/store/{StoreID}/product/{id}/datechecks?Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&guid={guid}	Get all Product Date Expiry
GET api/store/{StoreID}/shelfLocation/{guid}/datechecks?Search={Search}&PluGUID={PluGUID}&ShelfLocationIdentifier={ShelfLocationIdentifier}&FromDate={FromDate}&ToDate={ToDate}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&MinorDeptCode={MinorDeptCode}&LesserDeptCode={LesserDeptCode}&OrderBy={OrderBy}&Sort={Sort}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}&id={id}	Get all Product Date Expiry
POST api/productdatechecks	Create new Product Date Expiry
PUT api/product/{id}/date/{date}/check	Update quantity for Product Date Expiry
DELETE api/product/{id}/date/{date}/check	Delete expiry check

ProductDoNotRange

API	Description
POST api/product/{id}/range	Range a product
POST api/store/{storeID}/product/{id}/range	Range a store product
POST api/product/{id}/donotrange	Unrange a product
POST api/store/{storeID}/product/{id}/donotrange	Unrange a store product

Product filters for reuse

API	Description
GET api/productFilters?category={category}	List product filters
GET api/productFilter/{id}	Load a saved product filter
GET api/productFilter/{id}/validate	Validate a saved filter
GET api/productFilter/validate	Validate a product filter
POST api/productFilters	Save new product filter
PUT api/productFilter/{id}	Save product filter with id
DELETE api/productFilter/{id}	Delete a saved filter

ProductImage

API	Description
GET api/productImageSettings	List Product Image settings
GET api/product/{id}/images?storeID={storeID}	List Product Image settings
GET api/store/{storeID}/product/{id}/images	List Product Image settings
POST api/productImageSetting	Save a product image setting
PUT api/productImage/{id}	Save a product image setting
POST api/productImageSettings	Save a list of product image settings
DELETE api/productImageSetting/{id}	Remove a product image setting
POST api/product/{id}/image?storeID={storeID}	Save or add product image
POST api/store/{storeID}/product/{id}/image	Save or add product image
PUT api/product/{id}/image/{position}?storeID={storeID}	Save product image
PUT api/store/{storeID}/product/{id}/image/{position}	Save product image
POST api/product/{id}/images?storeID={storeID}	Save product images
POST api/store/{storeID}/product/{id}/images	Save product images
DELETE api/product/{id}/image/{position}?storeID={storeID}	Save product image
DELETE api/store/{storeID}/product/{id}/image/{position}	Save product image

PromotionType

Campaign promotion types

API	Description
GET api/promotionTypes?Take={Take}&Skip={Skip}&HostType={HostType}&HostProvider={HostProvider}	Gets a list of promotion types
GET api/promotionTypes/types	Get a list of promotion types grouped by code
GET api/promotionType/{id}	Get a promotion type
POST api/promotionTypes	Save promotion type
PUT api/promotionType/{id}	Save promotion type
DELETE api/promotionType/{id}	Delete promotion type

Quote

Contains APIs to create, update and delete Quote Header and details

API	Description
GET api/quotes	List all quotes
GET api/quote/{id}?details={details}	Return requested Quote with details
POST api/quotes	Create new quote header record
PUT api/quote/{id}	Update an existing Quote Header record
PUT api/quote/{id}/pickup/{date}	Update pickup date of an existing Quote.
DELETE api/quote/{id}	Deletes an existing Quote Header record with details
POST api/quote/{id}/details	Create a new Quote Detail i.e. add a product to Quote
PUT api/quote/{id}/detail/{guid}	Updates an existing Quote detail
POST api/quote/{id}/detail/{guid}/refund/{reason}	Mark a quote detail line as being refunded using this refund reason
DELETE api/quote/{id}/detail/{guid}	Delete an existing
POST api/quote/{id}/payments	Add quote payment
PUT api/quote/{id}/payment/{guid}	Update an existing quote payment record
POST api/quote/{id}/process	It converts quote to sales and set Quote as Finalised
POST api/quote/{id}/email	Send quote report as an email

RebateClaim

Rebate claim controller

API	Description
GET api/rebates?Take={Take}&Skip={Skip}&Relations={Relations}&Search={Search}&Status={Status}&RebateFrequency={RebateFrequency}&RebateType={RebateType}&RebateSource={RebateSource}&Supplier={Supplier}&SupplierGroup={SupplierGroup}&SortOrder={SortOrder}&OrderBy={OrderBy}	Get matching RebateClaims
GET api/rebate/{id}?relations={relations}	Get RebateClaim object
GET api/rebate/{name}/exists	Find a rebate claim by name
POST api/rebate	Add or update a RebateClaim
POST api/rebate/{id}/claim	Process a RebateClaim (populate RebateDetails from source tables)
PUT api/rebate/{id}	Place RebateClaim object at the guid location
DELETE api/rebate/{id}	Delete RebateClaim object at the guid location (soft delete)
GET api/rebate/{id}/details	Get RebateClaim detail list from RebateDetail table
GET api/rebate/{id}/summary	Get RebateClaim summary list from RebateDetail table
GET api/rebate/{id}/claim	Get RebateClaim detail list from source files
GET api/rebate/{id}/total	Get RebateClaim totals from source files
POST api/rebate/{id}/send	Email a RebateClaim report
POST api/rebate/supplier/{id}/default	Save supplier rebate defaults
POST api/rebate/suppliergroup/{id}/default	Save supplier group rebate defaults

RefundReason

POS refund reasons

API	Description
GET api/refundreason?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/refundreasons?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/refundreason/{id}	No documentation available.
GET api/refundreason/{description}/exists	No documentation available.
POST api/refundreason	No documentation available.
PUT api/refundreason/{id}	No documentation available.
POST api/refundreason/{id}/sort	No documentation available.

Report

Business Intelligence reports

API	Description
GET api/reports?names[0]={names[0]}&names[1]={names[1]}	Get list of saved reports
GET api/report/{id}	Get report
GET api/report/{report}/find/{name}	Find duplicate saved report names
POST api/report	Save report
POST api/reports	Save report
PUT api/report/{id}	Save report
DELETE api/report/{id}	Delete a saved report
GET api/report/{reportDefinition}/print	Render a report as a PDF Accepts query parameters as from request
GET api/Report/PrintReport/{reportDefinition}	Render a report as a PDF Accepts query parameters as from request
POST api/report/{reportDefinition}/email
POST api/Report/EmailReport/{reportDefinition}
POST api/report/{reportDefinition}/email/account/{guid}	Send Report Emails to all/selected accounts
POST api/report/{reportDefinition}/email/accounts?guid={guid}	Send Report Emails to all/selected accounts
GET api/report/{reportDefinition}/load	Loads a report dataset, using the query string as parameters
GET api/report/{reportDefinition}/render/{fileName}.{extension}	Render a report to a file

RestaurantTable

Restaurant Table management

API	Description
GET api/restaurantTables?StoreID={StoreID}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Query RestaurantTable
GET api/restaurantTable/{id}	Get a restaurant table by GUID
POST api/restaurantTables	Adds a Table
PUT api/restaurantTable/{id}	Updates restaurant Table using GUID
DELETE api/restaurantTable/{id}	Delete restaurant Table using GUID

Restriction

API	Description
GET api/restrictions?Keyword={Keyword}&RestrictionType={RestrictionType}&StoreID={StoreID}&ActiveOnly={ActiveOnly}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get RestrictionHeaders
GET api/store/{storeID}/restrictions?Keyword={Keyword}&RestrictionType={RestrictionType}&ActiveOnly={ActiveOnly}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get RestrictionHeaders
GET api/restriction/{id}	Get Restriction header
GET api/restriction/{id}/details	Get restriction details for a header
GET api/restriction/{id}/stores	Get restriction stores for a header
GET api/restrictionGroups?Keyword={Keyword}&ActiveOnly={ActiveOnly}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get restriction item groups
GET api/restrictionGroup/{id}	Get restriction item group
GET api/restrictionGroup/{id}/items	Get restriction items
POST api/restrictions	Create or update restriction header
PUT api/restriction/{id}	Create or update restriction header
POST api/restriction/{id}/details	Save a list of restriction details
POST api/restriction/{id}/stores	Save a list of restriction stores
POST api/restrictionGroups	Create or update item group
PUT api/restrictionGroup/{id}	Create or update item group
POST api/restrictionGroup/{id}/items	Save list of Restriction Items
DELETE api/restriction/{id}	Remove restriction header
DELETE api/restriction/{id}/detail/{guid}	Remove restriction detail
DELETE api/restriction/{id}/store/{guid}	Remove restriction store
DELETE api/restrictionGroup/{id}	Delete Restriction Item Group
DELETE api/restrictionGroup/{id}/item/{guid}	Delete Restriction Item

Rounding

Rounding rules for Product pricing

API	Description
GET api/round/cents/{value}	No documentation available.
GET api/round/dollars/{value}	No documentation available.
GET api/roundingrules	No documentation available.
PUT api/roundingrules	No documentation available.

SavedList

PDE saved lists

API	Description
POST api/savedList/store/{storeId}/batches	No documentation available.
PUT api/savedList/batch/{id}	No documentation available.
DELETE api/savedList/batch/{id}	No documentation available.
GET api/savedList/store/{storeId}/batches?Skip={Skip}&Take={Take}	No documentation available.
POST api/savedList/batch/{batchId}/batchDetails	No documentation available.
DELETE api/savedList/batchDetail/{batchDetailId}	No documentation available.
DELETE api/savedList/batch/{batchId}/batchDetail/{guid}	No documentation available.
GET api/savedList/batch/{batchId}/batchDetails?Skip={Skip}&Take={Take}	No documentation available.

ScaleDescription

API	Description
GET api/scaledescription	No documentation available.
GET api/machines	No documentation available.
GET api/scaledescription/{id}	No documentation available.
GET api/machine/{id}	No documentation available.
GET api/scaledescription/list?Skip={Skip}&Take={Take}&StoreID={StoreID}&ZoneID={ZoneID}&LocationID={LocationID}&ScaleType={ScaleType}	No documentation available.
GET api/machines/list?Skip={Skip}&Take={Take}&StoreID={StoreID}&ZoneID={ZoneID}&LocationID={LocationID}&ScaleType={ScaleType}	No documentation available.
GET api/store/{storeID}/scaledescription	No documentation available.
GET api/store/{storeID}/machines	No documentation available.
GET api/store/{storeID}/settingszone/{name}	No documentation available.
POST api/store/{storeID}/settingszone/{name}	No documentation available.
POST api/scaledescription	No documentation available.
POST api/machine	No documentation available.
GET api/store/{storeID}/settingszones	No documentation available.
DELETE api/scaledescription/{id}/delete	No documentation available.
POST api/store/{id}/machines/import	Import a list of scale descriptions / machines
POST api/store/{id}/machine/ping	Keeps track of store lanes
GET api/ping/lane/{guid}/date/{date}	Returns the end of day total for the specified lane
GET api/pings/lane/{guid}	Returns a list of pings for the specified lane
GET api/lane/list?Skip={Skip}&Take={Take}&StoreID={StoreID}&ZoneID={ZoneID}&Status={Status}&SortBy={SortBy}&Sort={Sort}	Returns a list of lanes based on the search query
GET api/store/{storeID}/lane/name/{name}/exists	Searches lane by name and returns its Guid if found
GET api/lane/machine/{id}/exists	Checks to see if the machine ID has already been assigned
PUT api/lane	Save lane
POST api/lane	Save lane
GET api/lane/{id}	Retrieve lane data
DELETE api/lane/{id}	Delete the specified lane

ScaleLabel

Label printing templates

API	Description
GET api/scaleLabel?labelType={labelType}	Get all labels
GET api/scaleLabels?labelType={labelType}	Get all labels
GET api/scaleLabel/{id}	Load a label
DELETE api/scaleLabel/{id}	Delete label
PUT api/scaleLabel/{id}	Save a label
GET api/scaleLabel/name/{name}	Find ScaleLabel ID of a known label
GET api/scaleLabel/{name}/exists	Find ScaleLabel ID of a known label
POST api/scaleLabel/import	Imports a ScaleLabel XML file
GET api/scaleLabel/{name}/export	Exports a ScaleLabel XML file
GET api/scalelabel/headings	No documentation available.
POST api/scalelabel/headings	No documentation available.

ScaleLocation

Deli scale locations

API	Description
GET api/scalelocations	Gets all ScaleLocations
GET api/scalelocation/{id}	Gets a ScaleLocation
PUT api/scalelocations	Replaces ScaleLocations
PUT api/scalelocation/{id}	Updates a single ScaleLocation
POST api/scalelocations	Creates or updates a single ScaleLocation
DELETE api/scalelocation/{id}	Deletes a ScaleLocation

Scandata

API	Description
DELETE api/store/{storeID}/postSale/processAsync	No documentation available.
GET api/scandata/{apiID}/expiry	No documentation available.
PUT api/scandata/{apiID}/expiry/{expiry}	No documentation available.
POST api/scandata/{apiID}/expiry/{expiry}	No documentation available.
DELETE api/scandata/{apiID}/expiry	No documentation available.
GET api/scandata/type/{type}/api/{apiID}/settings	No documentation available.
PUT api/scandata/type/{type}/settings	No documentation available.
POST api/scandata/type/{type}/settings	No documentation available.
DELETE api/scandata/type/{type}/api/{apiID}/settings	No documentation available.
PUT api/scandata/error	No documentation available.
POST api/scandata/error	No documentation available.
GET api/scandata/errors?StoreID={StoreID}&Relations={Relations}&Take={Take}&Skip={Skip}	No documentation available.
GET api/scandata/errordetails/{id}	No documentation available.
GET api/scandata/igarewards/{apiID}	No documentation available.
PUT api/scandata/igarewards/{apiID}	No documentation available.
POST api/scandata/igarewards/{apiID}	No documentation available.
DELETE api/scandata/igarewards/{apiID}	No documentation available.

ScheduledOrder

Scheduled order controller

API	Description
GET api/scheduledOrders?StoreID={StoreID}&Keyword={Keyword}&TradingPartner={TradingPartner}&OrderType={OrderType}&SupplierIdentifierGuid={SupplierIdentifierGuid}&HostIdentifierGuid={HostIdentifierGuid}&TransportCompanyGuid={TransportCompanyGuid}&ActiveOnly={ActiveOnly}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Gets a list of scheduled orders
GET api/scheduledOrders/timeline?StoreID={StoreID}&Keyword={Keyword}&TradingPartner={TradingPartner}&OrderType={OrderType}&SupplierIdentifierGuid={SupplierIdentifierGuid}&HostIdentifierGuid={HostIdentifierGuid}&TransportCompanyGuid={TransportCompanyGuid}&ActiveOnly={ActiveOnly}&OrderBy={OrderBy}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get scheduled orders timeline information
GET api/scheduledOrder/{id}?relations={relations}	Get a scheduled order
GET api/scheduledOrder/{id}/history?ScheduledOrderGuid={ScheduledOrderGuid}&SortOrder={SortOrder}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get scheduled order histories
POST api/scheduledOrders	Create or update a scheduled order
PUT api/scheduledOrder/{id}	Update a scheduled order
DELETE api/scheduledOrder/{id}	Remove a scheduled order
POST api/scheduledOrder/{id}/runNow	Run a scheduled order task now

ScheduledTask

Background tasks

API	Description
GET api/scheduledtask?TaskType={TaskType}&OrderBy={OrderBy}&SortOrder={SortOrder}	List of ScheduledTasks for current account, ordered by task type
GET api/scheduledtasks?TaskType={TaskType}&OrderBy={OrderBy}&SortOrder={SortOrder}	List of ScheduledTasks for current account, ordered by task type
GET api/scheduledtask/{type}	Get a scheduled task based on the task type
POST api/scheduledtasks	Saves scheduled task and returns identifier.
PUT api/scheduledtask/{id}	Save scheduled task. Update scheduled task
DELETE api/scheduledtask/{id}	Delete scheduled task.

Search

Search routines to create Batches of Id's used in other areas of the system

API	Description
GET api/search/generalproductsearch	Return Batch for a general product search eg. Search for 'diet' in StoreId 1. Return BatchId 97, Count 203...
GET api/search/deptcodesearch?OperatorId={OperatorId}&DeptCode={DeptCode}&StoreId={StoreId}&ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&Skip={Skip}&Take={Take}&SortBy={SortBy}&SortDirection={SortDirection}	Return Batch for products for a DeptId search
GET api/search/subdeptcodesearch?OperatorId={OperatorId}&DeptCode={DeptCode}&SubDeptCode={SubDeptCode}&StoreId={StoreId}&ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&Skip={Skip}&Take={Take}&SortBy={SortBy}&SortDirection={SortDirection}	Return Batch for products for a SubDeptId search
GET api/search/notsoldsincedatesearch?OperatorId={OperatorId}&NotSoldSinceDate={NotSoldSinceDate}&StoreId={StoreId}&ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&Skip={Skip}&Take={Take}&SortBy={SortBy}&SortDirection={SortDirection}	Return Batch for products for a NotSoldSinceDate search
GET api/search/standardproductsearchresults?BatchId={BatchId}	No documentation available.
GET api/search/heirarchyproductsearchresults?BatchId={BatchId}	No documentation available.

ServerMessage

Server messaging from admin to users

API	Description
GET api/serverMessages?unreadOnly={unreadOnly}	Get a list of the active server messages
POST api/serverMessage/{id}/read	Mark a message as read
POST api/serverMessage/{id}/unread	Mark a message as unread
POST api/serverMessage/expirySeen	Record the first time that the current user has seen the expiry warning message

ServiceFee

Service fees

API	Description
GET api/servicefees	Lists all service fees
GET api/servicefee/{id}	Load service fee
POST api/servicefees	Save or create new service fee
PUT api/servicefee/{id}	Save service fee
DELETE api/servicefee/{id}	Delete service fee

Session

Web User sessions

API	Description
GET api/session	No documentation available.
GET api/session/restrictions	No documentation available.
GET api/session/fieldPermissions	No documentation available.
GET api/tenant/settings	No documentation available.
POST api/session	No documentation available.
DELETE api/session	No documentation available.
POST api/session/CreateToken	Generates Access token using username and password
POST api/session/regeneratetoken	Regenerate JWT Token for react client if System is being used by User This API will fetch the user details from expired token and generate new token
GET api/session/frillredirect?redirect={redirect}	No documentation available.

Settings

Configuration management

API	Description
GET api/settings/{section}/{id}/{machineID}	No documentation available.
GET api/setting/{section}/{id}/{machineID}	No documentation available.
GET api/settings/{section}/{id}	No documentation available.
GET api/settings/{id}	No documentation available.
PUT api/settings/{section}/{id}/{machineID}	No documentation available.
PUT api/settings/{section}/{id}?protect={protect}&replicate={replicate}	No documentation available.
PUT api/settings/{id}?protect={protect}&replicate={replicate}	No documentation available.
POST api/settings/{section}/{id}/{machineID}?protect={protect}&replicate={replicate}	Sets a Setting
POST api/settings/{section}/{id}?protect={protect}&replicate={replicate}	Sets a Setting
GET api/settings/maxpctphrases	No documentation available.
POST api/settings/maxpctphrases	No documentation available.
DELETE api/settings/{section}/{id}/{machineID}	No documentation available.
DELETE api/settings/{section}/{id}	No documentation available.
DELETE api/settings/{id}	No documentation available.

ShareDocument

Document to share

API	Description
POST api/shareDocument	Save share product filter
PUT api/shareDocument/{documentID}	Update share Document using document Id
GET api/shareDocument/{documentID}/details	Load a Shared details
GET api/shareDocument/{documentID}/users	No documentation available.
GET api/shareDocument/{documentID}/shareLevel	No documentation available.

ShelfLocation

Shelf item locations

API	Description
GET api/shelflocations?StoreID={StoreID}&Name={Name}&Take={Take}&Skip={Skip}	No documentation available.
GET api/shelflocation/{id}	No documentation available.
GET api/store/{storeID}/shelflocation/{name}/exists	Check if a location with this name exists at store
GET api/store/{storeID}/shelflocation/find/{blueprintID}/id	No documentation available.
PUT api/shelflocation/{id}	No documentation available.
POST api/shelflocations	No documentation available.
POST api/shelflocations/generate	No documentation available.
POST api/shelflocations/import	Import shelf locations
POST api/store/{storeID}/shelflocations/import	Import shelf locations
DELETE api/shelflocation/{id}	No documentation available.
GET api/shelflocation/{id}/products	No documentation available.
GET api/product/{id}/shelflocations?relations={relations}	No documentation available.
GET api/shelflocation/{id}/products/available	No documentation available.
GET api/shelflocation/{id}/product/{guid}?relations={relations}	Get shelf location information for a product
GET api/product/{guid}/shelflocation/{id}?relations={relations}	Get shelf location information for a product
PUT api/shelflocation/{id}/product/{guid}	Add or update a product to a shelf location
PUT api/product/{guid}/shelflocation/{id}	Add or update a product to a shelf location
POST api/shelflocation/{id}/product/{guid}/relocate	Add or update a product to a shelf location
POST api/product/{guid}/shelflocation/{id}/relocate	Add or update a product to a shelf location
DELETE api/shelflocation/{id}/product/{guid}	Remove a product from a shelf location
DELETE api/product/{guid}/shelflocation/{id}	Remove a product from a shelf location

ShrinkGrouping

Controller to handle Shrink Groups/Targets/Figures

API	Description
GET api/shrinkgroup/list	Returns a list of all Shrink Groupings
POST api/shrinkgroup/create	Creates a Shrink Group
GET api/shrinkgroup/{ID}	Returns a single Shrink Group
POST api/shrinkgroup/update/{ID}	Updates a single Shrink Group
DELETE api/shrinkgroup/delete/{ID}	Deletes a single Shrink Group
GET api/shrinkgroup/ExistsByID/{ID}	Checks if a Shrink Group exists by ID
GET api/shrinkgroup/ExistsByName/{name}	Checks if a Shrink Group exists by ID
GET api/shrinkgroup/reasons	Gets a list of departments which have not already been used in a KPI Group

StandardMeasurement

Standard units of measure

API	Description
GET api/standardmeasurements?Skip={Skip}&Take={Take}&TotalCount={TotalCount}&type={type}&name={name}	No documentation available.
GET api/standardmeasurement/standard/{type}/amount/{amount}	No documentation available.
GET api/standardmeasurement/standard/{type}/exists?name={name}	No documentation available.
POST api/standardmeasurement	No documentation available.
DELETE api/standardmeasurement/{name}/standard/{type}	No documentation available.

Stocktake

Inventory stocktakes

API	Description
GET api/store/{storeID}/stocktakerequest/{dueDate}	No documentation available.
GET api/store/{storeID}/stocktakerequest	No documentation available.
GET api/stocktakerequest	No documentation available.
PUT api/store/{storeID}/stocktakerequest/{dueDate}/{name}	No documentation available.
GET api/store/{storeID}/stocktakerequest/{dueDate}/{name}	No documentation available.
DELETE api/store/{storeID}/stocktakerequest/{dueDate}/{name}	No documentation available.
GET api/stocktakes?StoreID={StoreID}&Name={Name}&ForDate={ForDate}&OutOfStock={OutOfStock}&Take={Take}&Skip={Skip}&Status={Status}&SortBy={SortBy}&SortOrder={SortOrder}	List stocktakes
GET api/stocktake/{id}?relations={relations}	Get stocktake
POST api/store/{storeID}/stocktakes	Save stocktake header
POST api/stocktakes	Save stocktake header
PUT api/store/{id}/stocktake/{guid}?storeID={storeID}	Save or Update Stocktake header
PUT api/stocktake/{id}	Save or Update Stocktake header
DELETE api/stocktake/{id}	Delete stocktake
POST api/stocktake/{id}/close	Mark a stocktake as closed
POST api/stocktake/{id}/setcount	Set products inventory levels based on stocktake values
GET api/stocktake/{id}/inputs	Get header inputs
GET api/stocktake/{id}/input/{guid}	Load stocktake input
PUT api/stocktake/{id}/input/{guid}	input add
POST api/stocktake/{id}/inputs	Save stocktake input
DELETE api/stocktake/{id}/input/{guid}	Delete stocktake input
POST api/stocktake/{id}/input/{inputID}/open	Open stocktake input
POST api/stocktake/{id}/input/{inputID}/close	Close stocktake input
GET api/stocktake/{id}/details?inputID={inputID}	Detail list for an header or relevant subset as defined by query
GET api/stocktake/{id}/input/{inputID}/details	Detail list for an header or relevant subset as defined by query
GET api/stocktake/{id}/total?inputID={inputID}	Stocktake total options
GET api/stocktake/{id}/input/{inputID}/total	Stocktake total options
GET api/stocktake/{id}/input/{inputID}/detail/{guid}	Find stocktake detail summary (total of all inputs)
GET api/stocktake/{id}/detail/{guid}?inputID={inputID}	Find stocktake detail summary (total of all inputs)
POST api/stocktake/{id}/input/{inputID}/details	Add details to a product
POST api/stocktake/{id}/detailCosts	Update the saved price or cost for a stocktake detail product
PUT api/stocktake/{id}/input/{inputID}/detail/{guid}	Add a detail to a header and input
POST api/stocktake/{guid}/input/{inputID}/detail/{id}/delete	Delete detail from stocktake, creating new record with reverse
POST api/store/{id}/stocktakes/import	Import complete stocktakes
POST api/stocktake/{id}/input/{guid}/import	Import stocktake details from PDE file import utility. This is for when product details are not provided
GET api/sections?StoreID={StoreID}&Name={Name}&Take={Take}&Skip={Skip}	No documentation available.
GET api/store/{storeID}/sections	No documentation available.
GET api/section/{guid}	No documentation available.
POST api/store/{storeID}/sections	Add a new section
PUT api/section/{id}	Update a section
DELETE api/section/{guid}	delete
GET api/store/{id}/stocktakes/open	Determine if any stocktakes are currently open
GET api/stocktakes/open?id={id}	Determine if any stocktakes are currently open
GET api/store/{id}/stocktake/export.csv?StoreID={StoreID}&HostIdentifier={HostIdentifier}&DepartmentCode={DepartmentCode}&ActiveOnly={ActiveOnly}	Export a .csv file for a third party stocktake export

Store

Site maintenance

API	Description
GET api/stores?Relations={Relations}&Details={Details}&IncludeDeactive={IncludeDeactive}&IncludeBrowser={IncludeBrowser}&ZoneID={ZoneID}&Search={Search}&SortOrder={SortOrder}&OrderBy={OrderBy}	Returns a list of stores in the current users scope
GET api/zonestores	Price Zone / Stores mapping object
GET api/store/{id}	Get a store
GET api/store/{storeID}/identifier	Generate a unique POS identifier for a store
GET api/store/{id}/timeZone	Get the store's time zone identifier Defaults to tenant timezone if not configured
GET api/store/findbyname/{shortname}	Search for store based on its name and return it
POST api/stores	Create new store
PUT api/store/{id}	Save or Create a store with a set ID
POST api/store/{id}/deactivate	Deactivate a store
POST api/stores/import	Import and save a list of stores
POST api/store/{id}/accounts	Save new store account
PUT api/store/{id}/account/{accountID}	Save store account StoreIDStoreAccount IDStore Account
DELETE api/store/{id}/account/{accountID}	Delete StoreAccount
GET api/stores/locations	Returns a list of location in the current users scope
GET api/store/{id}/location	Get a store Location
POST api/store/{id}/externalSales
PUT api/store/{id}/externalSale/{saleID}
DELETE api/store/{id}/externalSale/{saleID}
GET api/externalSales	Get the external sales providers configured
GET api/store/{id}/cashManagements	Get the configured Cash Management systems for the specified store
GET api/cashManagements/api/{apiID}?id={id}	No documentation available.
GET api/store/{id}/cashManagement/{CashManagementID}	Retrieves the Cash Management system by the CashManagementID
POST api/store/{id}/cashManagement	Saves/updates the Cash Management settings
PUT api/store/{id}/cashManagement/{CashManagementID}	Saves/updates the Cash Management settings
DELETE api/store/{id}/cashManagement/{CashManagementID}	Deletes the specified Cash Management system
POST api/store/{id}/ping	No documentation available.
POST api/store/{id}/initialise	No documentation available.
POST api/store/{id}/initialise/{sourceID}	No documentation available.
POST api/store/{id}/initialise/{sourceID}/{service}	No documentation available.
POST api/store/{id}/initialise/new	Runs new store initialise, copying values to store database
POST api/store/{id}/initialise/{sourceID}/Products/Departments	No documentation available.
POST api/store/{id}/initialise/{sourceID}/Products/Departments/{code}	No documentation available.
GET api/storeupdate/poison?limit={limit}	No documentation available.
DELETE api/storeupdate/poison/{id}	No documentation available.
GET api/store/{id}/replication/peek?limit={limit}	No documentation available.

StoreSales

Services for POS transactions

API	Description
GET api/storesales/{id}	Gets a single sale from any Store
GET api/storesale/{id}	Gets a single sale from any Store
GET api/storesale/{id}/receipt	Gets a single receipt from any Store
GET api/store/{storeID}/sales?StartDate={StartDate}&EndDate={EndDate}&SalesType={SalesType}&OperatorG={OperatorG}&MachineID={MachineID}&DrawerID={DrawerID}&PluGuid={PluGuid}&Tender={Tender}&CardName={CardName}&Customer={Customer}&CustomerIdentifier={CustomerIdentifier}&DepartmentCode={DepartmentCode}&ProductNotMatched={ProductNotMatched}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&PumpNumber={PumpNumber}&MinTenderedAmount={MinTenderedAmount}&MaxTenderedAmount={MaxTenderedAmount}&SaleIdentifier={SaleIdentifier}&ExternalSale={ExternalSale}&Imported={Imported}&OrderBy={OrderBy}&Sort={Sort}&ExcludeVoids={ExcludeVoids}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Gets a list of sales, no sales, end of day and end of shift records Negative TranTypes indicate that it is not a sale record, but a no sale (-1), end of day (-2), or end of shift (-3) record
GET api/store/{storeID}/sales.{format}?StartDate={StartDate}&EndDate={EndDate}&SalesType={SalesType}&OperatorG={OperatorG}&MachineID={MachineID}&DrawerID={DrawerID}&PluGuid={PluGuid}&Tender={Tender}&CardName={CardName}&Customer={Customer}&CustomerIdentifier={CustomerIdentifier}&DepartmentCode={DepartmentCode}&ProductNotMatched={ProductNotMatched}&TankNumber={TankNumber}&HoseNumber={HoseNumber}&PumpNumber={PumpNumber}&MinTenderedAmount={MinTenderedAmount}&MaxTenderedAmount={MaxTenderedAmount}&SaleIdentifier={SaleIdentifier}&ExternalSale={ExternalSale}&Imported={Imported}&OrderBy={OrderBy}&Sort={Sort}&ExcludeVoids={ExcludeVoids}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/product/{id}/history/sales?storeID={storeID}	Get sales history for a product
GET api/store/{storeID}/product/{id}/history/sales	Get sales history for a product
GET api/product/{id}/history/sales.{format}?storeID={storeID}	Get sales history for a product exported as a file
GET api/store/{storeID}/product/{id}/history/sales.{format}	Get sales history for a product exported as a file
GET api/product/{id}/history/sales/total?storeID={storeID}	Get sales history total for a product
GET api/store/{storeID}/product/{id}/history/sales/total	Get sales history total for a product
GET api/product/{id}/sales/histories?storeID={storeID}	Get a group of sales histories for multiple periods
GET api/store/{storeID}/product/{id}/sales/histories	Get a group of sales histories for multiple periods
GET api/product/{id}/history/summary	No documentation available.
POST api/storesales/reprocess	No documentation available.
POST api/storesales/{identifier}/reprocess	No documentation available.
POST api/storesales/{saleHeaderID}/reprocess/external	Reprocess a single external sale
POST api/storesales/reprocess/external	Reprocess a set of external sales
POST api/storesales/{storeID}/summary	Forcibly summarise a day or days of sales
POST api/store/{storeID}/sales	Import sales at store
POST api/storesales/import	Import sales with no store other than from objects
POST api/storesales/sync	Import sales at store sync
GET api/store/{storeID}/storesales/processAsync	start a task to process sales in the pipeline for a store
DELETE api/store/{storeID}/storesales/processAsync	remove a task identifier from AsyncRunner

StoreSize

API	Description
GET api/storeSizes	Get all store sizes
GET api/storeSize/{id}/deals	Get all investment buy deals for a store size
GET api/storeSize/{id}	Get a current store size
POST api/storeSizes	Create or update a store save
PUT api/storeSize/{id}	Create or update a store save with a particular identifier
POST api/storeSize/{id}/deals	Save a list of investment buy deals
DELETE api/storeSize/{id}	Delete a store size
DELETE api/storeSize/{id}/deal/{dealID}	Delete an investment buy deal

Supplier

Purchase Order Suppliers

API	Description
GET api/supplier?Skip={Skip}&Take={Take}&ABN={ABN}&Code={Code}&AccountCode={AccountCode}&Name={Name}&Store={Store}&ShowAll={ShowAll}&Fuel={Fuel}&IncludeDeleted={IncludeDeleted}&SortBy={SortBy}&Sort={Sort}&SupplierGroupGuid={SupplierGroupGuid}&Updated={Updated}&Relations={Relations}	No documentation available.
GET api/suppliers?Skip={Skip}&Take={Take}&ABN={ABN}&Code={Code}&AccountCode={AccountCode}&Name={Name}&Store={Store}&ShowAll={ShowAll}&Fuel={Fuel}&IncludeDeleted={IncludeDeleted}&SortBy={SortBy}&Sort={Sort}&SupplierGroupGuid={SupplierGroupGuid}&Updated={Updated}&Relations={Relations}	No documentation available.
GET api/supplierGroups?Skip={Skip}&Take={Take}&Name={Name}	Get a list of supplier groups
GET api/supplier/{id}	No documentation available.
GET api/supplier/{id}/contact?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/supplierGroup/{id}	Load Supplier Group
POST api/supplier	No documentation available.
POST api/suppliers	No documentation available.
PUT api/supplier/{id}	Update supplier
DELETE api/supplier/{id}	Safely delete a supplier
POST api/supplier/{id}/restore	Restore a deleted supplier
GET api/supplier/{code}/exists	Check if supplier host code already exists
POST api/supplier/{id}/contact	No documentation available.
DELETE api/supplier/{id}/contact/{contactGuid}	No documentation available.
POST api/supplierGroups	Save new supplier group
PUT api/supplierGroup/{id}	Save supplier group
DELETE api/supplierGroup/{id}	Delete supplier group
GET api/supplierGroup/{id}/suppliers?Skip={Skip}&Take={Take}&ABN={ABN}&Code={Code}&AccountCode={AccountCode}&Name={Name}&Store={Store}&ShowAll={ShowAll}&Fuel={Fuel}&IncludeDeleted={IncludeDeleted}&SortBy={SortBy}&Sort={Sort}&SupplierGroupGuid={SupplierGroupGuid}&Updated={Updated}&Relations={Relations}	Get Suppliers in a group
PUT api/supplierGroup/{id}/supplier/{guid}	Add supplier to a supplier group
DELETE api/supplier/{id}/supplierGroup	Remove supplier from supplierGroup
GET api/supplierGroup/{id}/contact?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	Get a list of supplier group contacts
POST api/supplierGroup/{id}/contact	Get a list of supplier group contacts
GET api/supplier/{id}/products?storeID={storeID}	Returns a list of SupplierProductDetails with product information for the specified supplier
GET api/supplier/{id}/store/{storeID}/products	Returns a list of SupplierProductDetails with product information for the specified supplier
GET api/product/{id}/suppliers?PluGuid={PluGuid}&Skip={Skip}&Take={Take}&ShowAll={ShowAll}	Returns a list of ProductOrderingDetail with supplier information for the specified product
GET api/product/{id}/suppliers/hostTypes	Returns a list of Host Types from orderings for the specified product
GET api/supplier/product/{pluGuid}/hostType/{hostType}	Get supplier ordering information for host supplier
GET api/supplier/product/{pluGuid}/host/{hostGuid}	Get supplier ordering information for host supplier
GET api/supplier/{id}/product/itemCode/{itemCode}/exists?storeID={storeID}	Get pre-existing ordering details
GET api/store/{storeID}/supplier/{id}/product/itemCode/{itemCode}/exists	Get pre-existing ordering details
GET api/product/{guid}/supplier/{id}?relations={relations}	Get supplier ordering information
GET api/supplier/{id}/product/{guid}?relations={relations}	Get supplier ordering information
PUT api/product/{guid}/supplier/{id}	Save or update supplier ordering information
POST api/product/{guid}/supplier/{id}	Save or update supplier ordering information
PUT api/supplier/{id}/product/{guid}	Save or update supplier ordering information
POST api/supplier/{id}/product/{guid}	Save or update supplier ordering information
GET api/product/{guid}/supplier/{id}/invoice/{code}/exists	Get existing invoice code supplier
GET api/supplier/{id}/product/{guid}/invoice/{code}/exists	Get existing invoice code supplier
POST api/product/{guid}/supplier/{id}/invoices	Add a supplier invoicing code to product record
POST api/supplier/{id}/product/{guid}/invoices	Add a supplier invoicing code to product record
DELETE api/product/{guid}/supplier/{id}/invoice/{code}	Remove supplier invoicing code from product record
DELETE api/supplier/{id}/product/{guid}/invoice/{code}	Remove supplier invoicing code from product record
POST api/supplier/{id}/flag	Flag a supplier as Is supplier
GET api/product/{guid}/supplier	Get a product's preferred supplier
DELETE api/product/{guid}/supplier/{id}	Delete the supplier ordering information
DELETE api/supplier/{id}/product/{guid}	Delete the supplier ordering information
GET api/supplier/abnexists/{abn}?id={id}	This API checks whether any supplier(s) exist with same ABN If yes, it returns supplier identifier and name only.
POST api/supplier/{id}/merge/{abn}	No documentation available.
PUT api/store/{storeID}/product/{id}/fastprice	Deprecated. No documentation available. Removed after 31 Dec 2025
GET api/store/{storeID}/host/{provider}/suppliers	No documentation available.
GET api/supplier/{id}/transportCompanies	Get supplier primary transport companies
GET api/supplier/{id}/store/{storeID}/transportCompany	Get default store and supplier transport company information
POST api/supplier/{id}/transportCompanies	Save supplier transport companies
DELETE api/supplier/{id}/store/{storeId}/transportCompany/{guid}	Remove a primary transport company for a supplier at a specified store
GET api/store/{storeID}/supplier/{id}/orderCycles?deptCode={deptCode}&indicator={indicator}	Get list of order cycles applicable for supplier/host and other details
GET api/store/{storeID}/supplier/{id}/department/{deptCode}/orderCycles?indicator={indicator}	Get list of order cycles applicable for supplier/host and other details
GET api/store/{storeID}/supplier/{id}/department/{deptCode}/warehouseIndicator/{indicator}/orderCycles	Get list of order cycles applicable for supplier/host and other details
GET api/store/{storeID}/supplier/{id}/orderCycleDetails	Get a list of ALL order cycles for given store/supplier
POST api/store/{storeID}/supplier/{id}/orderCycles?deptCode={deptCode}&indicator={indicator}	Save list of order cycles for supplier/host and other details
POST api/store/{storeID}/supplier/{id}/department/{deptCode}/orderCycles?indicator={indicator}	Save list of order cycles for supplier/host and other details
POST api/store/{storeID}/supplier/{id}/department/{deptCode}/warehouseIndicator/{indicator}/orderCycles	Save list of order cycles for supplier/host and other details
POST api/store/{storeID}/supplier/{id}/department/orderCycles?indicator={indicator}	Save list of order cycles for supplier/host and other details, against multiple departments
POST api/store/{storeID}/supplier/{id}/department/warehouseIndicator/{indicator}/orderCycles	Save list of order cycles for supplier/host and other details, against multiple departments
DELETE api/store/{storeID}/supplier/{id}/orderCycles?deptCode={deptCode}&indicator={indicator}	Remove order cycles from supplier
DELETE api/store/{storeID}/supplier/{id}/department/{deptCode}/orderCycles?indicator={indicator}	Remove order cycles from supplier
DELETE api/store/{storeID}/supplier/{id}/department/{deptCode}/warehouseIndicator/{indicator}/orderCycles	Remove order cycles from supplier
POST api/suppliers/ordercycles/import	Import a list of order cycles
GET api/supplier/{id}/orderCycleHeaders?Skip={Skip}&Take={Take}&StoreID={StoreID}	Returns list of Order Cycle Headers for supplier
POST api/supplier/import	No documentation available.
POST api/suppliers/import	No documentation available.
POST api/supplierproducts	No documentation available.
POST api/supplier/{id}/products	Import a list of supplier details
POST api/supplier/{id}/preferred?storeID={storeID}	Set all products with a pluOrderingDetail for the specified supplier, to use this one as it's preferred supplier
POST api/store/{storeID}/supplier/{id}/preferred	Set all products with a pluOrderingDetail for the specified supplier, to use this one as it's preferred supplier
POST api/supplier/{id}/rebate?storeID={storeID}	Set all products with a pluOrderingDetail for the specified supplier, to use this one as it's rebate supplier
POST api/store/{storeID}/supplier/{id}/rebate	Set all products with a pluOrderingDetail for the specified supplier, to use this one as it's rebate supplier
POST api/supplier/{id}/freight?storeID={storeID}	Update the freight settings of products with suppliers's default freight settings
POST api/store/{storeID}/supplier/{id}/freight	Update the freight settings of products with suppliers's default freight settings
POST api/preferredsuppliers	Set preferred supplier for a list of product, supplier pairs

Survey

API	Description
GET api/surveys?Name={Name}&StoreID={StoreID}&ZoneID={ZoneID}&DisplayToWho={DisplayToWho}&DisplayWhen={DisplayWhen}&Start={Start}&End={End}&OrderBy={OrderBy}&SortOrder={SortOrder}&Relations={Relations}&IncludeDeleted={IncludeDeleted}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/survey/{id}?relations={relations}	No documentation available.
POST api/surveys	No documentation available.
POST api/surveyresponses/store/{storeID}/import	Imports survey responses from a store; processes the responses async
PUT api/survey/{id}	No documentation available.
GET api/survey/{id}/responses?SurveyGuid={SurveyGuid}&SaleHeaderGuid={SaleHeaderGuid}&TextResponse={TextResponse}&TextResponseMatching={TextResponseMatching}&MinimumIntegerResponse={MinimumIntegerResponse}&MaximumIntegerResponse={MaximumIntegerResponse}&GuidResponse={GuidResponse}&WhoAnswered={WhoAnswered}&AnsweredAfterUTC={AnsweredAfterUTC}&AnsweredBeforeUTC={AnsweredBeforeUTC}&OrderBy={OrderBy}&SortOrder={SortOrder}&StoreID={StoreID}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
GET api/surveyresponses?SurveyGuid={SurveyGuid}&SaleHeaderGuid={SaleHeaderGuid}&TextResponse={TextResponse}&TextResponseMatching={TextResponseMatching}&MinimumIntegerResponse={MinimumIntegerResponse}&MaximumIntegerResponse={MaximumIntegerResponse}&GuidResponse={GuidResponse}&WhoAnswered={WhoAnswered}&AnsweredAfterUTC={AnsweredAfterUTC}&AnsweredBeforeUTC={AnsweredBeforeUTC}&OrderBy={OrderBy}&SortOrder={SortOrder}&StoreID={StoreID}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
POST api/surveyresponses	No documentation available.
POST api/surveyresponses/sync	Import survey responses from a store sync

Tag

Product tags

API	Description
GET api/tags?Take={Take}&Skip={Skip}&Search={Search}	Get list of tags
GET api/product/{id}/tags?Take={Take}&Skip={Skip}&PluGuid={PluGuid}	Get list of product tags
POST api/tags	Save New Tag
PUT api/tag/{id}	Save Tag
PUT api/product/{id}/tag/{tagID}	Save/update product tag
POST api/tags/import	Save New Tag
POST api/tag/{id}/merge/{mergeID}	Merge two tags together (in case of typos or duplicates
DELETE api/tag/{id}	Delete tag
DELETE api/product/{id}/tag/{tagID}	Delete tag from product
GET api/product/{id}/tag/{tagID}	Get product tag

Tender

API	Description
GET api/tenders	Get all Tenders
POST api/tenders	Save or Update a tender

Terminal

API	Description
GET api/terminal/{id}?relations={relations}	No documentation available.
GET api/terminal/posKey/{posKey}?relations={relations}	No documentation available.
GET api/store/{storeId}/terminal/{storeMachineId}?relations={relations}	No documentation available.
PUT api/terminal/{id}	No documentation available.
POST api/terminals	No documentation available.
DELETE api/terminal/{id}	No documentation available.
POST api/terminal/{id}/assignMachine	No documentation available.
GET api/terminals?Name={Name}&Skip={Skip}&Take={Take}&StoreID={StoreID}&ZoneID={ZoneID}&LocationID={LocationID}&IncludeDeleted={IncludeDeleted}&Relations={Relations}&MachineAssigned={MachineAssigned}&TerminalNumber={TerminalNumber}	No documentation available.
GET api/terminal/{id}/history?TerminalGuid={TerminalGuid}&MachineID={MachineID}&From={From}&To={To}&Relations={Relations}&Skip={Skip}&Take={Take}	No documentation available.

ThirdPartyApi

Third Party API management

API	Description
GET api/thirdpartyapi?Description={Description}&Address={Address}&Username={Username}&APIType={APIType}&APISubType={APISubType}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List all Third Party APIs
GET api/thirdpartyapis?Description={Description}&Address={Address}&Username={Username}&APIType={APIType}&APISubType={APISubType}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List all Third Party APIs
GET api/thirdpartyapi/type/{apiType}	List all Third Party APIs based on APIType
GET api/thirdpartyapis/type/{apiType}	List all Third Party APIs based on APIType
GET api/thirdpartyapi/{id}	Get the specified Third Party API record
POST api/thirdpartyapi	Creates a Third Party API record
PUT api/thirdpartyapi/{id}	Creates a Third Party API record
DELETE api/thirdpartyapi/{id}	Delete the specified Third Party API record

TimeZoneInfo

Lists system time zones

API	Description
GET api/timezones	Lists system time zones

TransportCompany

API	Description
GET api/transportCompanies?Skip={Skip}&Take={Take}&ABN={ABN}&CompanyName={CompanyName}	No documentation available.
GET api/transportCompanies/{id}	No documentation available.
GET api/transportCompany/{id}/contact?Skip={Skip}&Take={Take}&TotalCount={TotalCount}	No documentation available.
POST api/transportCompany	Save or update a transport company
POST api/transportCompany/{id}/contact	No documentation available.
DELETE api/transportCompany/{id}/contact/{contactGuid}	No documentation available.
DELETE api/transportCompany/{id}	No documentation available.

User

Allows Tenants to setup their own Users

API	Description
GET api/users?includeCustomer={includeCustomer}&includeBrowser={includeBrowser}	Get all users for current tenant
GET api/user/{id}	Get account
GET api/user/email/{email}	Get account
GET api/user/stores	Get update store list for current tenant, ignoring current user's permissions
GET api/user/exists/{email}	Find Account id via email
POST api/user/{id}/lock	Disable account
POST api/user/{id}/unlock	Enable account
POST api/users	Create or update a user account. If create adds to current tenant
POST api/user/{id}	Update a user account, in account id location
GET api/user/{email}/dataRetention	Get a customer account's data retention time span
POST api/user/{email}/dataRetention	Set the customer account's data retention time span
GET api/user/routes	Get all available api routes for current user
GET api/user/features	Get all available api routes for current user
GET api/user/privileges	Get account privileges for current tenant
GET api/user/privileges/{id}	Get account privileges group
GET api/user/privileges/{groupName}/find	Get account privileges group by name
POST api/user/privileges	Save or create an Account Privilege for current tenant
PUT api/user/privileges/{id}	Update an account privileges group or create at location
DELETE api/user/privileges/{id}	Remove privileges settings, if not applied to the current user account
DELETE api/user/{id}	No documentation available.
GET api/user/privileges/fieldPermissions/{groupId}	No documentation available.
POST api/user/privilege/fieldPermissions	Save a list of field permissions
PUT api/user/privilege/fieldPermission/{id}	No documentation available.
POST api/user/privilege/fieldPermission	No documentation available.
GET api/user/configuration	Get the tenant case configuration
POST api/user/configuration	Saves tenant case configuration
GET api/user/connectionIDs	No documentation available.

Voucher

POS Vouchers

API	Description
GET api/vouchers?Name={Name}&VoucherType={VoucherType}	Get voucher list
GET api/vouchers/{name}/search	No documentation available.
GET api/voucher/{search}	Get voucher
GET api/voucherlabels	Get list of voucher scale labels
POST api/vouchers	Save/Update voucher
PUT api/voucher/{name}	Save voucher with specified name, either creating, or updating model at location
DELETE api/voucher/{name}	Delete voucher
GET api/voucher/{name}/campaigns?Skip={Skip}&Take={Take}&VoucherName={VoucherName}&Active={Active}&System={System}&IncludeEnded={IncludeEnded}&StoreID={StoreID}	Find Selling Rule campaigns for a specified campaign

WebHook

Web Hook subscription control

API	Description
GET api/webHooks?StoreID={StoreID}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}	List current web hooks
GET api/webHook/{id}	Get the web hook
GET api/webHook/secret	No documentation available.
POST api/webHooks	Create a web hook
PUT api/webHook/{id}	Update a web hook
DELETE api/webHook/{id}	Delete a webhook
POST api/webHook/mailGun	No documentation available.

WebHookFilters

API	Description
GET api/webhooks/filters	No documentation available.

WebHookRegistrations

API	Description
GET api/webhooks/registrations	No documentation available.
GET api/webhooks/registrations/{id}	No documentation available.
POST api/webhooks/registrations	No documentation available.
PUT api/webhooks/registrations/{id}	No documentation available.
DELETE api/webhooks/registrations/{id}	No documentation available.
DELETE api/webhooks/registrations	No documentation available.

Zone

In-store Zones

API	Description
GET api/zones?Skip={Skip}&Take={Take}&StoreID={StoreID}&Search={Search}&IncludeDefault={IncludeDefault}	Get all zones
GET api/store/{id}/zones	Get store zones
GET api/zone/{id}	Get zone
POST api/zones	Add/Save zone
PUT api/zone/{id}	Save zone with specified id, either creating, or updating model at location
DELETE api/zone/{id}	Delete a zone