v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Products

Create New Operator Product

Creates a new product associated with a specific operator, identified by the OperatorID. The request body contains the details of the product to be created.

post/v1/operators/{OperatorID}/products

Path parameters

OperatorIDinteger required

The unique identifier of the operator for whom the product is being created.

Request body

NayaxProductIDinteger nullable

The unique identifier for the product in the Nayax system.

ProductGroupIDinteger nullable

The unique identifier of the product group to which the product belongs.

ActorIDinteger nullable

The unique identifier of the actor associated with the product.

ProductManufacturerIDinteger nullable

The unique identifier of the product's manufacturer.

ProductNamestring nullable

The name of the product.

ProductCatalogNumberstring nullable

The catalog number assigned to the product.

ProductBarcodestring nullable

The barcode associated with the product.

ProductPackageQuantityinteger nullable

The quantity of product units per package.

ProductDescriptionstring nullable

A description of the product.

ProductVolumeTypeIDinteger nullable

The volume type identifier associated with the product.

DEXProductNamestring nullable

The name of the product in the DEX (Data Exchange) format.

ProductCostPricenumber double nullable

The cost price of the product.

ProductDefaultRetailPricenumber double nullable

The default retail price of the product.

ProductMinimumPickQTYinteger nullable

The minimum quantity of the product that can be picked.

ProductStatusinteger nullable

The status of the product, typically representing availability.

ProductCashPricenumber double nullable

The price of the product when paid with cash.

ProductCreditCardPricenumber double nullable

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

ProductPrepaidCardPricenumber double nullable

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

ProductExternalPrepaidCardPricenumber double nullable

The price of the product when paid with an external prepaid card.

ProductMemberTypePriceBitboolean nullable

Indicates if the product has member-type-specific pricing.

ProductPictureURLstring nullable

The URL of the product's picture.

CaloriesPer100gnumber double nullable

The number of calories per 100 grams of the product.

CaloriesPerServingnumber double nullable

The number of calories per serving of the product.

EANCodestring nullable

The European Article Number (EAN) code associated with the product.

ProductCreatedByinteger nullable

The identifier of the user who created the product entry.

ProductCreationDatestring date-time nullable

The date and time when the product was created.

ProductUpdatedByinteger nullable

The identifier of the user who last updated the product entry.

ProductLastUpdatedstring date-time nullable

The date and time when the product was last updated.

VatIdinteger nullable

The VAT (Value Added Tax) identifier associated with the product.

Response

The product was successfully created for the specified operator.

NayaxProductIDinteger nullable

The unique identifier for the product in the Nayax system.

ProductGroupIDinteger nullable

The unique identifier of the product group to which the product belongs.

ActorIDinteger nullable

The unique identifier of the actor associated with the product.

ProductManufacturerIDinteger nullable

The unique identifier of the product's manufacturer.

ProductNamestring nullable

The name of the product.

ProductCatalogNumberstring nullable

The catalog number assigned to the product.

ProductBarcodestring nullable

The barcode associated with the product.

ProductPackageQuantityinteger nullable

The quantity of product units per package.

ProductDescriptionstring nullable

A description of the product.

ProductVolumeTypeIDinteger nullable

The volume type identifier associated with the product.

DEXProductNamestring nullable

The name of the product in the DEX (Data Exchange) format.

ProductCostPricenumber double nullable

The cost price of the product.

ProductDefaultRetailPricenumber double nullable

The default retail price of the product.

ProductMinimumPickQTYinteger nullable

The minimum quantity of the product that can be picked.

ProductStatusinteger nullable

The status of the product, typically representing availability.

ProductCashPricenumber double nullable

The price of the product when paid with cash.

ProductCreditCardPricenumber double nullable

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

ProductPrepaidCardPricenumber double nullable

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

ProductExternalPrepaidCardPricenumber double nullable

The price of the product when paid with an external prepaid card.

ProductMemberTypePriceBitboolean nullable

Indicates if the product has member-type-specific pricing.

ProductPictureURLstring nullable

The URL of the product's picture.

CaloriesPer100gnumber double nullable

The number of calories per 100 grams of the product.

CaloriesPerServingnumber double nullable

The number of calories per serving of the product.

EANCodestring nullable

The European Article Number (EAN) code associated with the product.

ProductCreatedByinteger nullable

The identifier of the user who created the product entry.

ProductCreationDatestring date-time nullable

The date and time when the product was created.

ProductUpdatedByinteger nullable

The identifier of the user who last updated the product entry.

ProductLastUpdatedstring date-time nullable

The date and time when the product was last updated.

VatIdinteger nullable

The VAT (Value Added Tax) identifier associated with the product.

SequenceNumberinteger nullable

The sequence number of the product.

AgeVerificationEnableBitboolean nullable

Indicates whether age verification is required for this product.

DepositTypeIDinteger nullable

The type of container for deposit/return schemes. Can be one of the following values: Plastic bottle - 90001, Can - 90002, Reusable Glass bottle - 90003.

DepositFeenumber double nullable

Deposit amount for bottle/can return schemes (max 100.00).

DepositTaxnumber double nullable

Tax percentage applied to the deposit amount (0-100).

Refsobject nullable

A map of additional references related to the product.