Help >

NoshPOS API Reference


  • A NoshPOS API client ID and secret
  • Composer
  • Smarty


  1. Require the following packages in your composer:
    1. noshpos/apiwrapper
    2. smarty/smarty
    3. symfony/yaml
  2. Run composer install
  3. Load the wrapper namespace in your code: use NoshPOS\APIWrapper
  4. Instantiate the API wrapper using your client id, secret and project url: $noshpos = new NoshPOS($clientId, $clientSecret, $url).
  5. This is found by default in the noshpos-settings file.


  1. Now that the API wrapper is instatiated, use the $noshpos variable to start making calls for varying requests.
  2. Set $noshpos->returnDataArray()before making any calls to ensure that a php data array is returned.
  3. $noshPOS->customers()->get($pageSize, $pageIndex). By passing $pageSize 1 and $pageIndex 0, the wrapper would return one customer.

For example:

$products = $noshpos->products()->get();

Structure: $noshpos->[Endpoint Type]->[Request Type]

This would return a data array of all of the products related to the project.

Request Types

The API currently supports 4 types of requests which come at the end of a call. These include:

  • Get ->get()
  • Post ->post()
  • Put ->put()
  • Delete ->delete()



Note: When passing parameters through requests, they should be passed as arrays. This array should be passed through the request as follows:

$productParams['limit'] = 2;

Otherwise, variables can be passed directly through the endpoint:

$userID = 2;
$userParams['c_firstname'] = 'Joe';




GET /products

Optional Parameters

Parameter Name Description
limit Limit the number of rows returned
offset How many rows should be passed over




Last updated: 2018-02-10 12:06:37