v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Machines

Update Specific Machine Basic Info

Updates the basic information of a specific machine identified by MachineID.

put/v1/machines/{MachineID}

Path parameters

MachineIDinteger required

The unique identifier of the machine to update.

Request body

MachineIDinteger nullable

The unique identifier of the machine.

ActorIDinteger nullable

The identifier of the actor associated with the machine.

CountryIDinteger nullable

The identifier of the country where the machine is located.

CurrencyIDinteger nullable

The identifier of the currency used by the machine.

InstituteIDinteger nullable

The identifier of the institute associated with the machine.

LocationIDinteger nullable

The identifier of the location where the machine is installed.

MachineGroupIDinteger nullable

The identifier of the group to which the machine belongs.

MachineModelIDinteger nullable

The identifier of the machine's model.

MachineNamestring nullable

The name of the machine.

MachineNumberstring nullable

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

MachineStatusBitinteger

A bit field indicating the status of the machine.

{"stackTrail":"components:schemas:LanguageIdEnum","oasType":"schema","type":"unknown","extensionFields":{"x-enumDescriptions":{"2":"Turkish","4":"Hebrew","7":"English","8":"French","9":"Romanian","10":"Swedish","11":"Norwegian","12":"Russian","13":"Iceland","14":"Portuguese","15":"Spanish","16":"Italian","17":"Danish","18":"Polish","21":"Dutch","22":"Chinese","23":"Hungarian","27":"Thai","28":"German","29":"Japanese","30":"Greek","31":"English UK","34":"Latvian","41":"Slovenian","42":"Estonian","51":"Vietnamese","52":"Czech","54":"Finnish","62":"Arabic","64":"Lithuanian","81":"Bulgarian"}}}

OperatorActorIDinteger nullable

The identifier of the operator managing the machine.

DistributorActorIDinteger nullable

The identifier of the distributor associated with the machine.

AreaActorIDinteger nullable

The identifier of the area actor responsible for the machine.

SalesSourceIDinteger nullable

The identifier of the sales source associated with the machine.

MachineTypeID555001 | 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

SerialNumberstring nullable

The serial number of the machine.

VPOSSerialNumberstring nullable

The VPOS serial number associated with the machine.

DeviceSerialNumberstring nullable

The serial number of the device installed in the machine.

VPOSIDinteger nullable

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

DeviceIDinteger nullable

The unique identifier of the device installed in the machine.

UseLocationFrominteger nullable

Specifies where the location information is sourced from.

GeoCountryinteger nullable

The country identifier based on geographic data.

GeoStatestring nullable

The state or region based on geographic data.

GeoCitystring nullable

The city based on geographic data.

GeoAddressstring nullable

The full address based on geographic data.

GeoStreetNumberstring nullable

The street number based on geographic data.

GeoLongitudenumber double nullable

The geographic longitude where the machine is located.

GeoLatitudenumber double nullable

The geographic latitude where the machine is located.

GeoZoominteger nullable

The zoom level for geographic data representation.

GeoZipCodestring nullable

The postal or ZIP code based on geographic data.

SearchAddressstring nullable

The address used for search purposes.

Remarksstring nullable

Additional remarks or notes about the machine.

DexTypeinteger nullable

The DEX type identifier.

DexMidnightReadsEnableBitboolean nullable

Indicates if midnight DEX reads are enabled.

DexG85CheckEnableBitboolean nullable

Indicates if the G85 check for DEX is enabled.

DexDivideBillsByinteger nullable

The value by which DEX bills are divided.

DexG85CheckParsingFilterEnableBitboolean nullable

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

UseCardPriceCorrectCashPriceBitboolean nullable

Indicates if card prices are used to correct cash prices.

MachineTimeZoneOffsetnumber double nullable

The time zone offset for the machine.

DexReadIntervalinteger nullable

The interval at which DEX reads occur.

LocationTypeinteger nullable

The identifier of the location type.

ApplyDisplayPickListSelectionsToReportsBitboolean nullable

Indicates if picklist selections should be applied to reports.

DisplayPickListSelectionsAsinteger nullable

Specifies how picklist selections are displayed.

LastUpdatedstring date-time nullable

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

MachineProfileinteger nullable

The identifier of the machine profile.

CityIDinteger nullable

The identifier of the city where the machine is located.

RegionIDinteger nullable

The identifier of the region where the machine is located.

CountryDialingCodeinteger nullable

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

DexIgnoreCRCCheckBitboolean nullable

Indicates if CRC checks are ignored in DEX.

DexParseLABitboolean nullable

Indicates if the DEX LA parsing is enabled.

ProductMapIDinteger nullable

The identifier of the product map associated with the machine.

Longitudenumber double nullable

The geographic longitude where the machine is located.

Latitudenumber double nullable

The geographic latitude where the machine is located.

DexTotalSalesMinusCardSalesBitboolean nullable

Indicates if total sales should exclude card sales in DEX.

RouteActorIDinteger nullable

The identifier of the route actor managing the machine.

MachineLogicAlertEnableBitboolean nullable

Indicates if machine logic alerts are enabled.

AlertRuleSetIdinteger nullable

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

MachineMemberTypePricingEnableBitboolean nullable

Indicates if member type pricing is enabled for the machine.

DexMultiplyCoinsByinteger nullable

The value by which DEX coins are multiplied.

DexMultiplyTubesByinteger nullable

The value by which DEX tubes are multiplied.

CustomerIDinteger nullable

The unique identifier of the customer associated with the machine.

CommissionTypeinteger nullable

The type of commission applied to the machine.

CommissionDefaultValuenumber double nullable

The default commission value applied to the machine.

CreatedByinteger nullable

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

CreatedOnstring date-time nullable

The date and time when the machine entry was created.

UpdateByinteger nullable

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

TubeSourceinteger nullable

The source of the tube data for the machine.

BillSourceinteger nullable

The source of the bill data for the machine.

SmartStickerIdinteger nullable

The identifier of the smart sticker associated with the machine.

EnableRemoveVendBitboolean nullable

Indicates if the remove vend functionality is enabled.

EnableEreceiptBitboolean nullable

Indicates if the e-receipt functionality is enabled.

ProductMapAutomaticCreationBitboolean nullable

Indicates if the product map is automatically created.

Refsobject nullable

Additional references associated with the machine.

Response

The machine information was successfully updated.

MachineIDinteger nullable

The unique identifier of the machine.

ActorIDinteger nullable

The identifier of the actor associated with the machine.

CountryIDinteger nullable

The identifier of the country where the machine is located.

CurrencyIDinteger nullable

The identifier of the currency used by the machine.

InstituteIDinteger nullable

The identifier of the institute associated with the machine.

LocationIDinteger nullable

The identifier of the location where the machine is installed.

MachineGroupIDinteger nullable

The identifier of the group to which the machine belongs.

MachineModelIDinteger nullable

The identifier of the machine's model.

MachineNamestring nullable

The name of the machine.

MachineNumberstring nullable

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

MachineStatusBitinteger

A bit field indicating the status of the machine.

OperatorActorIDinteger nullable

The identifier of the operator managing the machine.

DistributorActorIDinteger nullable

The identifier of the distributor associated with the machine.

AreaActorIDinteger nullable

The identifier of the area actor responsible for the machine.

SalesSourceIDinteger nullable

The identifier of the sales source associated with the machine.

SerialNumberstring nullable

The serial number of the machine.

VPOSSerialNumberstring nullable

The VPOS serial number associated with the machine.

DeviceSerialNumberstring nullable

The serial number of the device installed in the machine.

VPOSIDinteger nullable

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

DeviceIDinteger nullable

The unique identifier of the device installed in the machine.

UseLocationFrominteger nullable

Specifies where the location information is sourced from.

GeoCountryinteger nullable

The country identifier based on geographic data.

GeoStatestring nullable

The state or region based on geographic data.

GeoCitystring nullable

The city based on geographic data.

GeoAddressstring nullable

The full address based on geographic data.

GeoStreetNumberstring nullable

The street number based on geographic data.

GeoLongitudenumber double nullable

The geographic longitude where the machine is located.

GeoLatitudenumber double nullable

The geographic latitude where the machine is located.

GeoZoominteger nullable

The zoom level for geographic data representation.

GeoZipCodestring nullable

The postal or ZIP code based on geographic data.

SearchAddressstring nullable

The address used for search purposes.

Remarksstring nullable

Additional remarks or notes about the machine.

DexTypeinteger nullable

The DEX type identifier.

DexMidnightReadsEnableBitboolean nullable

Indicates if midnight DEX reads are enabled.

DexG85CheckEnableBitboolean nullable

Indicates if the G85 check for DEX is enabled.

DexDivideBillsByinteger nullable

The value by which DEX bills are divided.

DexG85CheckParsingFilterEnableBitboolean nullable

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

UseCardPriceCorrectCashPriceBitboolean nullable

Indicates if card prices are used to correct cash prices.

MachineTimeZoneOffsetnumber double nullable

The time zone offset for the machine.

DexReadIntervalinteger nullable

The interval at which DEX reads occur.

LocationTypeinteger nullable

The identifier of the location type.

ApplyDisplayPickListSelectionsToReportsBitboolean nullable

Indicates if picklist selections should be applied to reports.

DisplayPickListSelectionsAsinteger nullable

Specifies how picklist selections are displayed.

LastUpdatedstring date-time nullable

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

MachineProfileinteger nullable

The identifier of the machine profile.

CityIDinteger nullable

The identifier of the city where the machine is located.

RegionIDinteger nullable

The identifier of the region where the machine is located.

CountryDialingCodeinteger nullable

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

DexIgnoreCRCCheckBitboolean nullable

Indicates if CRC checks are ignored in DEX.

DexParseLABitboolean nullable

Indicates if the DEX LA parsing is enabled.

ProductMapIDinteger nullable

The identifier of the product map associated with the machine.

Longitudenumber double nullable

The geographic longitude where the machine is located.

Latitudenumber double nullable

The geographic latitude where the machine is located.

DexTotalSalesMinusCardSalesBitboolean nullable

Indicates if total sales should exclude card sales in DEX.

RouteActorIDinteger nullable

The identifier of the route actor managing the machine.

MachineLogicAlertEnableBitboolean nullable

Indicates if machine logic alerts are enabled.

AlertRuleSetIdinteger nullable

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

MachineMemberTypePricingEnableBitboolean nullable

Indicates if member type pricing is enabled for the machine.

DexMultiplyCoinsByinteger nullable

The value by which DEX coins are multiplied.

DexMultiplyTubesByinteger nullable

The value by which DEX tubes are multiplied.

CustomerIDinteger nullable

The unique identifier of the customer associated with the machine.

CommissionTypeinteger nullable

The type of commission applied to the machine.

CommissionDefaultValuenumber double nullable

The default commission value applied to the machine.

CreatedByinteger nullable

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

CreatedOnstring date-time nullable

The date and time when the machine entry was created.

UpdateByinteger nullable

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

TubeSourceinteger nullable

The source of the tube data for the machine.

BillSourceinteger nullable

The source of the bill data for the machine.

SmartStickerIdinteger nullable

The identifier of the smart sticker associated with the machine.

EnableRemoveVendBitboolean nullable

Indicates if the remove vend functionality is enabled.

EnableEreceiptBitboolean nullable

Indicates if the e-receipt functionality is enabled.

ProductMapAutomaticCreationBitboolean nullable

Indicates if the product map is automatically created.

Refsobject nullable

Additional references associated with the machine.