NCR DSR Web API Help Page

Retrieves the list of Age Code for a given tenant. The tenant information is verified through the token.

Add a new Age Code.

Add or Update an AgeCode.

Retrieves the Age Code information for the given Age Code name.

Deletes an existing Age Code.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Decrypts encrypted data

Encrypts given data

Add new Encryption Key/Value pair.

Returns the current active encryption key and Id for tenant

Returns all the encryption key and Id for current tenant

Delete an Encryption Key/Value pair.

Returns the encryption key/value pair with the specified Key Code

Retrieves the file (if present) in the specified path configured through sourceData with matching fileName

Delete product group detail information.

Add or Update group detail information.

Create group detail information.

Returns all group detail record from the database.

Returns group detail record from the database.

Returns all products which belong to a specific group.

Returns all products which belong to a group.

Add or Update group information from a client.

Accepts group information from a client.

Returns all group records from the database.

Delete product group information.

Returns a group record from the database.

Retrieve the 'paged' list of hierarchies for a given tenant. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records.

Add a new hierarchy.

Add or Update existing hierarchy.

Retrieve the hierarchy information for the given hierarchy code.

Delete an existing hierarchy.

Retrieve the hierarchy information all departments

Retrieve the hierarchy information for the given hierarchy level code.

Retrieve the hierarchy information for the given hierarchy parent code.

Retrieve the list of all Hierarchy-AgeCodes for current organization

Adds a new Hierarchy-AgeCode

Retrieve the Unit of Measure information for given Hierarchy Code for current organization

Returns HierarchyLevelCode and LevelName for all HierarchyLevels.

Add or Update Hierarchy Level. Accepts HierarchyLevelCode and LevelName and return a response containing an acknowledgement. If the record exists than it updates; If the record does not exist than the API inserts the record.

Adds a HierarchyLevel. Accepts HierarchyLevelCode and LevelName and return a response containing an acknowledgement.

Accepts a HierarchyLevelCode from client and return HierarchyLevelCode and the LevelName as a response.

Receive a hierarchy code from client and return product information as response.

Returns the requested parameter group from the database.

Returns the requested TouchTypes from the database.

Update prePack information from a client.

Accepts prePack information from a client.

Returns all prePack records from the database.

Delete product prePack information.

Returns a prePack record from the database.

Retrieve the list of all AgeCode Restrictions on all Products for current organization

Adds a new Product-AgeCode

Updates/Adds a Product-AgeCode

Retrieve the AgeCode Restriction information for given Product Code for current organization

Add or Update a product description information from a client.

Accepts a product description information from a client.

Search products description for client and return products description information as response.

Retrieve the list of all product features of all Products

Adds a new Product Org Feature

Add or Update a Product Org Feature

Retrieve the product features information for given Product Code for given organization

Add or Update a product price information from a client.

Accepts a product price information from a client.

Search the lowest product price of a product which is still in effect for the specified lowestPriceDate.

Search products price for client and return products price information as response.

Add or Update a product information from a client.

Accepts a product information from a client.

Delete a product information from a client.

Receive a product a code from client and return product information as response.

Receive all products information as response. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records.

Receive a list of comma delimted productcode from client and return product information as response.

Receive a product a code and orgName from client and return product information as response. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records.

Search products for client and return products information as response. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records.

Add or Update a product vendor information from a client.

Accepts a product vendor information from a client.

Get products vendor for client and return products vendor information as response.

Generates a store sales report based on the criteria provided.

Retrieve the list of Restrictions.

Adds a new Restriction

Add or Update an existing Restriction

Retrieve the Restriction information for given Restriction Code

Adds new Restriction Details

Removes existing Restriction Details

Retrieve the products and hierarchies related to a given Restriction Code

Get all roles for a tenant. Tenant information is obtained from Token

Add a new role

Add or Update a role

Get a role by roleCode

Delete a role

Issues an authentication token to a user based on provided orgName, user name and password. The tenant name is optional which can be set via a custom header "nep-organization".

Logs out a previously issued token. The token should be set in 'Authorization' header.

Change the current user password based on provided user name and password within an organization context. The tenant name is optional which can be set in the "nep-organization" header.

Validates an issued token

Retrieve the list of tax class and tax rule for a given tenant.

Add a new tax class and tax type.

Add or Update an existing taxclass-TaxRule.

Retrieve the tax class and tax rule information for the given tax class code.

Retrieve the tax class and tax rule information for the given tax class and tax code.

Retrieve the tax class and tax rule information for the given tax class and tax rule code.

Retrieve the tax class and tax rule information for the given tax class, tax rule and tax code.

Retrieve the tax class and tax rule information for the given tax code.

Retrieve the list of tax class and tax type for a given tenant.

Add a new tax class and tax type.

Add or Update an existing taxclass-taxtype.

Retrieve the tax class and tax type information for the given tax class code.

Retrieve the tax class and tax type information for the given tax type code.

Retrieve the tax class and tax type information for the given tax type code.

Retrieve the list of tax for a given tenant.

Add a new tax.

Add or Update an existing tax.

Retrieve the tax information for the given tax code.

Delete an existing tax.

Retrieve the tax information for the given tax destination.

Retrieve the tax information for the given tax code.

Retrieve the tax information for the given tax code.

Retrieve a list of tax destinations.

Add a new tax destination.

Add or Update an existing tax destination.

Delete an existing tax destination.

Accepts a taxonomy record to add to the database.

Returns all taxonomy records from the database.

Add or Update a taxonomy record in the database.

Returns a taxonomy record from the database.

Removes a taxonomy record from the database.

Returns a set of taxonomy records matching the criteria or all taxonomy records if no criteria are provided.

Returns a set of taxonomy records matching the criteria or all taxonomy records if no criteria are provided.

Returns a taxonomy record and its entire parent chain.

Returns a set of taxonomy records matching the criteria or all taxonomy records if no criteria are provided.

Accepts a taxonomy level record to add to the database.

Returns all taxonomy level records from the database.

Add or Update a taxonomy level record in the database.

Returns a taxonomy level record from the database.

Removes a taxonomy level record from the database.

Retrieve the list of tax rule for a given tenant.

Add a new tax rule.

Add or Update an existing tax rule.

Retrieve the tax rule information for the given tax rule code.

Retrieve the list of tax tables for a given tenant.

Add a new tax table.

Add or Update an existing tax table.

Retrieve the tax table information for the given tax table code.

Delete an existing tax table.

Retrieve the list of tax type for a given tenant.

Add a new tax type.

Add or Update an existing tax type.

Retrieve the tax type information for the given tax type code.

Accepts a terminal status message from a client.

Accepts a property record that describes how a terminal should be presented in the terminal status report.

Returns the terminal status records for a taxonomy group and its child groups.

Search for last customer entry recorded with an email address and return the customer with basic transaction data.

Perform a customer transaction lookup request using the provided customer and period and return the transaction overview information. The period can either be the last N transactions or days.

Perform a display transaction lookup for the specified transaction and return the item data for the transaction or an error message.

Perform a display transaction lookup for the specified transaction and return the detail item data for the transaction or an error message.

Perform a return lookup request using 1 or more original transactions, or a member ID, or an account number to limit the possible transactions and a single item that is in at least one of the transactions.

Perform a return price point lookup request using 1 original transactions, 1 item that is in the transaction and a price point for that item and return a line item and other transaction data associated with the provided data.

Perform a a transaction search based on supplied criteria, which returns transaction summaries of matching records. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records. The body of the post contains the SearchTransactionRequest to be executed

Retrieve the tax details in a transaction (group by line item).

Perform a total spend lookup request using the provided customer and timeframe and return the total spend information

Lookup a transaction based on the provided transaction ID

This method will check if the specified customer has exceeded the specified number of non-receipted returns in the specified period. The customer will be added if it does not exist.

This method will add a non-receipted return for the specified customer on the specified date

Unlock the specified item and make it available for future lookups

Unlock the specified transaction and make it available for future lookups

Checks the specified transaction to see if it can be voided

Accepts a PosLog transaction from a client.

Updates a transaction in the database.

Returns a requested transaction from the database.

Searches transactions based on the provided filters.

Retrieve the list of all UOMs.

Adds a new UOM

Add or Update an existing UOM

Retrieve the Unit of Measure information for given UOM Code

Add a user to an org unit with a role. Please note that ** API supports multiple job codes per user. This will be supported by the POS in a future release. **

Remove a user from an org unit/role

Add or Update the user's org unit/role. Please note that ** API supports multiple job codes per user. This will be supported by the POS in a future release. **

Gets all users for a tenant

Create a new user. Please note that ** API supports multiple job codes per user. This will be supported by the POS in a future release. **

Get a user by id

Add or Update an existing user. Please note that ** API supports multiple job codes per user. This will be supported by the POS in a future release. **

Delete an existing user

Get a user by alternate id

Get a user by orgName

Add or Update vendor information from a client.

Accepts vendor information from a client.

Returns all vendor records from the database.

Delete a product vendor information from a client.

Returns a vendor record from the database.

Returns a set of vendor records matching the criteria or all vendor records if no criteria are provided.

Returns a set of vendor records matching the criteria or all vendor records if no criteria are provided.

Returns a set of vendor records matching the criteria or all vendor records if no criteria are provided.

Issues an authentication token to a user based on provided orgName, user name and password. The tenant name is optional which can be set via a custom header "nep-organization".

Logs out a previously issued token. The token should be set in 'Authorization' header.

Change the current user password based on provided user-name and password within an organization context. The tenant name is optional which can be set in the "nep-organization" header.

Validate an issued token. The token should be set in 'Authorization' header.

Searches transactions based on the provided filters.