Machine Products

Mapping products to machines (planogram setup) assigns specific products to a machine’s bins or selections, defining its layout for inventory tracking and restocking. You can create product maps in Nayax Core by following the steps below:

Go to Administration > Product Maps.
Click Add New Product Map.
Fill in the required fields for the product map:
- Operator Name: Specify which operator the map belongs to.
- Machine Model: Select which machine the map is for.
- Map Name: The name of the product map.
- Status: Whether the map is active or not.
Click Save.

Now, you can add products to this map. Follow the steps below to do so:

Select the map from the list.
Click on the Map Items tab.
Add products to the map using one of the following options:
- Add BIN: Adds one product directly to the list.
- Add Multiple BINS: Opens a pop-up window to select multiple products at once.

Add a machine product via API

Use the Create Machine Products endpoint to add one or more products to a machine’s product map programmatically.

AuthenticationRefer to the Security & Token page of this documentation to learn how to access your tokens, and how to properly use it to authenticate your API requests.

Send a POST request with the MachineID as a path parameter and an array of product objects in the request body:

Request

curl --request POST \
     --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/machineProducts \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
[
  {
    "NayaxProductID": 0,
    "MDBCode": 0,
    "PAR": 0,
    "CashPrice": 0,
    "CreditCardPrice": 0,
    "MachinePrice": 0,
    "RetailPrice": 0,
    "DEXProductName": "string",
    "PACode": "string",
    "PCCode": "string",
    "ProductMinimumPickQTY": 0,
    "VendOutAlertThreshold": 0,
    "PrePaidCardPrice": 0,
    "OperatorButtonCode": "string",
    "CommissionValue": 0,
    "ExternalPrepaidPrice": 0
  }
]
'

You can add more than one product object in the array to add multiple products to the map in a single request.

Path ParamsChange the MachineID with the unique identifier of the machine to map its products.

In the body parameters, fill in the following:

Parameter	Description
`NayaxProductID`	A unique identifier for the product in the Nayax system.
`MDBCode`	The MDB (Multi-Drop Bus) code associated with the product.
`PAR`	The price adjustment ratio for the product.
`CashPrice`	The price of the product when purchased with cash.
`CreditCardPrice`	The price of the product when purchased with a credit card.
`MachinePrice`	The price of the product set directly on the vending machine.
`RetailPrice`	The suggested retail price of the product.
`DEXProductName`	The product name as it appears in the DEX (Data Exchange) format.
`PACode`	The PA (Price Adjustment) code associated with the product.
`PCCode`	The PC (Product Category) code associated with the product.
`ProductMinimumPickQTY`	The minimum quantity of the product required for restocking or picking.
`VendOutAlertThreshold`	The stock level threshold that triggers a vend-out alert.
`PrePaidCardPrice`	The price of the product when purchased using a prepaid card.
`OperatorButtonCode`	The code used by the operator to select the product manually.
`CommissionValue`	The commission value associated with the product.
`ExternalPrepaidPrice`	The price of the product when purchased with an external prepaid solution.

After mapping products to your machines, you’re ready to generate pick lists.

Lynx API Guides

API Reference

Add a machine product via API

​Add a machine product via API

Add a machine product via API