Get All Machine Basic Info

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/machines \
  --header 'Authorization: <api-key>'

[
  {
    "MachineID": 123,
    "ActorID": 123,
    "CountryID": 123,
    "CurrencyID": 123,
    "InstituteID": 123,
    "LocationID": 123,
    "MachineGroupID": 123,
    "MachineModelID": 123,
    "MachineName": "<string>",
    "MachineNumber": "<string>",
    "MachineStatusBit": 123,
    "LanguageID": 2,
    "OperatorActorID": 123,
    "DistributorActorID": 123,
    "AreaActorID": 123,
    "SalesSourceID": 123,
    "MachineTypeID": 555001,
    "SerialNumber": "<string>",
    "VPOSSerialNumber": "<string>",
    "DeviceSerialNumber": "<string>",
    "VPOSID": 123,
    "DeviceID": 123,
    "UseLocationFrom": 123,
    "GeoCountry": 123,
    "GeoState": "<string>",
    "GeoCity": "<string>",
    "GeoAddress": "<string>",
    "GeoStreetNumber": "<string>",
    "GeoLongitude": 123,
    "GeoLatitude": 123,
    "GeoZoom": 123,
    "GeoZipCode": "<string>",
    "SearchAddress": "<string>",
    "Remarks": "<string>",
    "DexType": 123,
    "DexMidnightReadsEnableBit": true,
    "DexG85CheckEnableBit": true,
    "DexDivideBillsBy": 123,
    "DexG85CheckParsingFilterEnableBit": true,
    "UseCardPriceCorrectCashPriceBit": true,
    "MachineTimeZoneOffset": 123,
    "DexReadInterval": 123,
    "LocationType": 123,
    "ApplyDisplayPickListSelectionsToReportsBit": true,
    "DisplayPickListSelectionsAs": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "MachineProfile": 123,
    "CityID": 123,
    "RegionID": 123,
    "CountryDialingCode": 123,
    "DexIgnoreCRCCheckBit": true,
    "DexParseLABit": true,
    "ProductMapID": 123,
    "Longitude": 123,
    "Latitude": 123,
    "DexTotalSalesMinusCardSalesBit": true,
    "RouteActorID": 123,
    "MachineLogicAlertEnableBit": true,
    "AlertRuleSetId": 123,
    "MachineMemberTypePricingEnableBit": true,
    "DexMultiplyCoinsBy": 123,
    "DexMultiplyTubesBy": 123,
    "CustomerID": 123,
    "CommissionType": 123,
    "CommissionDefaultValue": 123,
    "CreatedBy": 123,
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdateBy": 123,
    "TubeSource": 123,
    "BillSource": 123,
    "SmartStickerId": 123,
    "EnableRemoveVendBit": true,
    "EnableEreceiptBit": true,
    "ProductMapAutomaticCreationBit": true,
    "Refs": {}
  }
]

GET

machines

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/machines \
  --header 'Authorization: <api-key>'

[
  {
    "MachineID": 123,
    "ActorID": 123,
    "CountryID": 123,
    "CurrencyID": 123,
    "InstituteID": 123,
    "LocationID": 123,
    "MachineGroupID": 123,
    "MachineModelID": 123,
    "MachineName": "<string>",
    "MachineNumber": "<string>",
    "MachineStatusBit": 123,
    "LanguageID": 2,
    "OperatorActorID": 123,
    "DistributorActorID": 123,
    "AreaActorID": 123,
    "SalesSourceID": 123,
    "MachineTypeID": 555001,
    "SerialNumber": "<string>",
    "VPOSSerialNumber": "<string>",
    "DeviceSerialNumber": "<string>",
    "VPOSID": 123,
    "DeviceID": 123,
    "UseLocationFrom": 123,
    "GeoCountry": 123,
    "GeoState": "<string>",
    "GeoCity": "<string>",
    "GeoAddress": "<string>",
    "GeoStreetNumber": "<string>",
    "GeoLongitude": 123,
    "GeoLatitude": 123,
    "GeoZoom": 123,
    "GeoZipCode": "<string>",
    "SearchAddress": "<string>",
    "Remarks": "<string>",
    "DexType": 123,
    "DexMidnightReadsEnableBit": true,
    "DexG85CheckEnableBit": true,
    "DexDivideBillsBy": 123,
    "DexG85CheckParsingFilterEnableBit": true,
    "UseCardPriceCorrectCashPriceBit": true,
    "MachineTimeZoneOffset": 123,
    "DexReadInterval": 123,
    "LocationType": 123,
    "ApplyDisplayPickListSelectionsToReportsBit": true,
    "DisplayPickListSelectionsAs": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "MachineProfile": 123,
    "CityID": 123,
    "RegionID": 123,
    "CountryDialingCode": 123,
    "DexIgnoreCRCCheckBit": true,
    "DexParseLABit": true,
    "ProductMapID": 123,
    "Longitude": 123,
    "Latitude": 123,
    "DexTotalSalesMinusCardSalesBit": true,
    "RouteActorID": 123,
    "MachineLogicAlertEnableBit": true,
    "AlertRuleSetId": 123,
    "MachineMemberTypePricingEnableBit": true,
    "DexMultiplyCoinsBy": 123,
    "DexMultiplyTubesBy": 123,
    "CustomerID": 123,
    "CommissionType": 123,
    "CommissionDefaultValue": 123,
    "CreatedBy": 123,
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdateBy": 123,
    "TubeSource": 123,
    "BillSource": 123,
    "SmartStickerId": 123,
    "EnableRemoveVendBit": true,
    "EnableEreceiptBit": true,
    "ProductMapAutomaticCreationBit": true,
    "Refs": {}
  }
]

Authorizations

Authorization

string

header

required

Enter your API key. It's required to authenticate API requests.

Query Parameters

ResultsLimit

integer<int32>

default:100

The maximum number of results to return.

ResultsOffset

integer<int32>

default:0

The number of results to skip before starting to return results.

ActorID

integer<int64>

Filter results by the actor ID associated with the machine.

OperatorIdentifier

string

Filter results by the operator identifier.

MachineID

integer<int64>

Filter results by the machine ID.

MachineSerialNumber

string

Filter results by the machine's serial number.

MachineName

string

Filter results by the machine's name.

DeviceID

integer<int32>

Filter results by the device ID associated with the machine.

VposID

integer<int64>

Filter results by the VPOS ID associated with the machine.

Response

200 - application/json

The machine information was successfully retrieved.

MachineID

integer<int64> | null

The unique identifier of the machine.

ActorID

integer<int64> | null

The identifier of the actor associated with the machine.

CountryID

integer<int32> | null

The identifier of the country where the machine is located.

CurrencyID

integer<int32> | null

The identifier of the currency used by the machine.

InstituteID

integer<int64> | null

The identifier of the institute associated with the machine.

LocationID

integer<int64> | null

The identifier of the location where the machine is installed.

MachineGroupID

integer<int32> | null

The identifier of the group to which the machine belongs.

MachineModelID

integer<int64> | null

The identifier of the machine's model.

MachineName

string | null

The name of the machine.

MachineNumber

string | null

The serial number or unique identifier assigned to the machine by the manufacturer.

MachineStatusBit

integer<int32>

A bit field indicating the status of the machine.

LanguageID

enum<integer> | null

The identifier of the language used by the machine.

Available options:

2,

4,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16,

17,

18,

21,

22,

23,

27,

28,

29,

30,

31,

34,

41,

42,

51,

52,

54,

62,

64,

81

OperatorActorID

integer<int64> | null

The identifier of the operator managing the machine.

DistributorActorID

integer<int64> | null

The identifier of the distributor associated with the machine.

AreaActorID

integer<int64> | null

The identifier of the area actor responsible for the machine.

SalesSourceID

integer<int32> | null

The identifier of the sales source associated with the machine.

MachineTypeID

enum<integer> | null

The identifier of the type of machine.

Available options:

555001,

555002,

555003,

555004,

555005,

555006,

555007,

555008,

556017,

556018,

30000514,

30000515,

30000516,

30000517,

30000518,

30000519,

30000520,

30000521,

30000522,

30000523,

30000524,

30000525,

30000526,

30000527,

30000561,

30000578,

30000579,

30000580,

30000581,

30000582,

30000583,

30000602,

30000611,

30000612,

30000617,

30000618,

30000619,

30000620,

30000623,

176649542,

227707459,

227707460,

504059468,

529079224,

363311433,

244797254

SerialNumber

string | null

The serial number of the machine.

VPOSSerialNumber

string | null

The VPOS serial number associated with the machine.

DeviceSerialNumber

string | null

The serial number of the device installed in the machine.

VPOSID

integer<int64> | null

The unique identifier of the VPOS device associated with the machine.

DeviceID

integer<int32> | null

The unique identifier of the device installed in the machine.

UseLocationFrom

integer<int32> | null

Specifies where the location information is sourced from.

GeoCountry

integer<int32> | null

The country identifier based on geographic data.

GeoState

string | null

The state or region based on geographic data.

GeoCity

string | null

The city based on geographic data.

GeoAddress

string | null

The full address based on geographic data.

GeoStreetNumber

string | null

The street number based on geographic data.

GeoLongitude

number<double> | null

The geographic longitude where the machine is located.

GeoLatitude

number<double> | null

The geographic latitude where the machine is located.

GeoZoom

integer<int32> | null

The zoom level for geographic data representation.

GeoZipCode

string | null

The postal or ZIP code based on geographic data.

SearchAddress

string | null

The address used for search purposes.

Remarks

string | null

Additional remarks or notes about the machine.

DexType

integer<int32> | null

The DEX type identifier.

DexMidnightReadsEnableBit

boolean | null

Indicates if midnight DEX reads are enabled.

DexG85CheckEnableBit

boolean | null

Indicates if the G85 check for DEX is enabled.

DexDivideBillsBy

integer<int32> | null

The value by which DEX bills are divided.

DexG85CheckParsingFilterEnableBit

boolean | null

Indicates if the parsing filter for DEX G85 check is enabled.

UseCardPriceCorrectCashPriceBit

boolean | null

Indicates if card prices are used to correct cash prices.

MachineTimeZoneOffset

number<double> | null

The time zone offset for the machine.

DexReadInterval

integer<int32> | null

The interval at which DEX reads occur.

LocationType

integer<int32> | null

The identifier of the location type.

ApplyDisplayPickListSelectionsToReportsBit

boolean | null

Indicates if picklist selections should be applied to reports.

DisplayPickListSelectionsAs

integer<int32> | null

Specifies how picklist selections are displayed.

LastUpdated

string<date-time> | null

The date and time when the machine information was last updated.

MachineProfile

integer<int32> | null

The identifier of the machine profile.

CityID

integer<int64> | null

The identifier of the city where the machine is located.

RegionID

integer<int32> | null

The identifier of the region where the machine is located.

CountryDialingCode

integer<int32> | null

The dialing code for the country where the machine is located.

DexIgnoreCRCCheckBit

boolean | null

Indicates if CRC checks are ignored in DEX.

DexParseLABit

boolean | null

Indicates if the DEX LA parsing is enabled.

ProductMapID

integer<int64> | null

The identifier of the product map associated with the machine.

Longitude

number<double> | null

The geographic longitude where the machine is located.

Latitude

number<double> | null

The geographic latitude where the machine is located.

DexTotalSalesMinusCardSalesBit

boolean | null

Indicates if total sales should exclude card sales in DEX.

RouteActorID

integer<int64> | null

The identifier of the route actor managing the machine.

MachineLogicAlertEnableBit

boolean | null

Indicates if machine logic alerts are enabled.

AlertRuleSetId

integer<int32> | null

The identifier of the alert rule set associated with the machine.

MachineMemberTypePricingEnableBit

boolean | null

Indicates if member type pricing is enabled for the machine.

DexMultiplyCoinsBy

integer<int32> | null

The value by which DEX coins are multiplied.

DexMultiplyTubesBy

integer<int32> | null

The value by which DEX tubes are multiplied.

CustomerID

integer<int64> | null

The unique identifier of the customer associated with the machine.

CommissionType

integer<int32> | null

The type of commission applied to the machine.

CommissionDefaultValue

number<double> | null

The default commission value applied to the machine.

CreatedBy

integer<int64> | null

The unique identifier of the user who created the machine entry.

CreatedOn

string<date-time> | null

The date and time when the machine entry was created.

UpdateBy

integer<int64> | null

The unique identifier of the user who last updated the machine entry.

TubeSource

integer<int32> | null

The source of the tube data for the machine.

BillSource

integer<int32> | null

The source of the bill data for the machine.

SmartStickerId

integer<int64> | null

The identifier of the smart sticker associated with the machine.

EnableRemoveVendBit

boolean | null

Indicates if the remove vend functionality is enabled.

EnableEreceiptBit

boolean | null

Indicates if the e-receipt functionality is enabled.

ProductMapAutomaticCreationBit

boolean | null

Indicates if the product map is automatically created.

Refs

object

Additional references associated with the machine.

Show child attributes

Update Specific Machine Basic Info Create New Machine

⌘I

Guides

API Reference

Get All Machine Basic Info

Authorizations

Query Parameters

Response