v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Machine Products

Create Machine Products

Creates new products for the specified machine identified by MachineID.

post/v1/machines/{MachineID}/machineProducts

Path parameters

MachineIDinteger required

The unique identifier of the machine for which products are being created.

Request body

NayaxProductIDinteger nullable

The unique identifier of the product in the Nayax system.

MDBCodeinteger nullable

The MDB (Multi-Drop Bus) code associated with the product.

PARinteger nullable

The PAR level, indicating the standard quantity of the product that should be stocked in the machine.

CashPricenumber double nullable

The price of the product when purchased with cash.

CreditCardPricenumber double nullable

The price of the product when purchased with a credit card.

MachinePricenumber double nullable

The price of the product as set on the machine.

RetailPricenumber double nullable

The retail price of the product.

DEXProductNamestring nullable

The product name according to DEX (Data Exchange) data.

PACodestring nullable

The PA code associated with the product.

PCCodestring nullable

The PC code associated with the product.

ProductMinimumPickQTYinteger nullable

The minimum quantity of the product that should be picked during restocking.

VendOutAlertThresholdinteger nullable

The stock level at which an alert should be triggered for potential vend out.

PrePaidCardPricenumber double nullable

The price of the product when purchased with a prepaid card.

OperatorButtonCodestring nullable

The code used by operators for manual selections.

CommissionValuenumber double nullable

The commission value associated with the product.

ExternalPrepaidPricenumber double nullable

The price of the product when purchased with external prepaid methods.

Response

The machine products were successfully created.

DexPricenumber double nullable

The product price according to DEX (Data Exchange) data.

ProductRefstring nullable

A reference string for the product, typically used for informational purposes.

MachineProductRefstring nullable

A reference string for the machine product, typically used for informational purposes.

ProductGroupRefstring nullable

A reference string for the product group, typically used for informational purposes.

MachineRefstring nullable

A reference string for the machine, typically used for informational purposes.

MachineProductIDinteger nullable

The unique identifier of the machine product.

NayaxProductIDinteger nullable

The unique identifier of the product in the Nayax system.

MachineIDinteger nullable

The unique identifier of the machine associated with this product.

MDBCodeinteger nullable

The MDB (Multi-Drop Bus) code associated with the product.

PARinteger nullable

The PAR level, indicating the standard quantity of the product that should be stocked in the machine.

CashPricenumber double nullable

The price of the product when purchased with cash.

CreditCardPricenumber double nullable

The price of the product when purchased with a credit card.

MachinePricenumber double nullable

The price of the product as set on the machine.

RetailPricenumber double nullable

The retail price of the product.

DEXProductNamestring nullable

The product name according to DEX data.

PACodestring nullable

The PA code associated with the product.

PCCodestring nullable

The PC code associated with the product.

ProductMinimumPickQTYinteger nullable

The minimum quantity of the product that should be picked during restocking.

VendOutAlertThresholdinteger nullable

The stock level at which an alert should be triggered for potential vend out.

LastUpdatedstring date-time nullable

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

MissingStockByDEXinteger nullable

The quantity of stock missing according to DEX data.

DEXMissingStockLastUpdatedstring date-time nullable

The date and time when the missing stock by DEX was last updated.

PrePaidCardPricenumber double nullable

The price of the product when purchased with a prepaid card.

OperatorButtonCodestring nullable

The code used by operators for manual selections.

LastUpdatedByMobilestring date-time nullable

The date and time when the product was last updated via mobile.

ProductGroupIDinteger nullable

The unique identifier of the product group.

MissingStockByMDBinteger nullable

The quantity of stock missing according to MDB data.

MDBMissingStockLastUpdatedstring date-time nullable

The date and time when the missing stock by MDB was last updated.

SelectionVendOutBitboolean nullable

Indicates whether the product selection is marked for vend out.

CommissionValuenumber double nullable

The commission value associated with the product.

ExternalPrepaidPricenumber double nullable

The price of the product when purchased with external prepaid methods.

product_mark_for_alertsinteger nullable

Indicates whether the product is marked for alerts.

last_sale_dtstring date-time nullable

The date and time of the last sale of the product.

last_sale_mdb_dtstring date-time nullable

The date and time of the last sale of the product according to MDB data.

slow_moverboolean nullable

Indicates whether the product is categorized as a slow mover.