Pick List Actions - Nayax Developer Portal

Pick list actions in Nayax Core are available in the Operations > Machine Inventory menu.

These actions can also be performed through Lynx API using the following endpoints:

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.

Get a pick list

Use the Get Pick List endpoint to retrieve the pick list associated with a specific machine.

Request

curl --request GET \
     --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/pickList \
     --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
     --header 'accept: application/json'

Path ParamChange MachineID with the actual ID of the machine to retrieve the pick list from.

A successful response returns the pick list with all products associated with the machine.

Update a pick list

Use the Update Pick List endpoint to modify product quantities or other details in a machine’s pick list.

Request

curl --request PUT \
     --url https://qa-lynx.nayax.com/operational/v1/machines/inventory/picklists/update \
     --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{
       "MachineId": 12345,
       "Products": [
         {
           "MachineProductId": 67890,
           "PickQty": 10
         },
         {
           "MachineProductId": 54321,
           "PickQty": 5
         }
       ]
     }'

The request body contains the following parameters:

Parameter	Type	Description
`MachineId`	`int64`	The unique identifier of the machine whose pick list is being updated.
`Products`	`array of objects`	A list of products to update. Each object contains `MachineProductId` (unique identifier of the product in the machine) and `PickQty` (updated quantity to be picked).

A successful response returns the pick list with the updated pick quantities.

Delete a pick list

Use the Delete Pick List endpoint to remove the pick list associated with a specific machine.

Request

curl --request DELETE \
     --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/pickList \
     --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
     --header 'accept: application/json'

A 200 OK response confirms the pick list has been deleted.

​Get a pick list

​Update a pick list

​Delete a pick list

​See also

Get a pick list

Update a pick list

Delete a pick list

See also