Create or Update Products

ProductCreateProductsResponse Products.CreateProducts(, )

POST/api/v2/public/products

Creates or updates products in the catalogue, matched on product number. This defines the product itself, such as description, barcodes, units and category. Per-store settings are handled by the store products endpoints.

ParametersExpand Collapse

ProductCreateProductsParams parameters

Boolean flush

Query param: When true, removes existing products before inserting.

IReadOnlyList<Body> body

Body param

required Boolean IsCounted

Whether the product is counted.

required string ProductName

Display name of the product.

minLength1

required string ProductNumber

Unique product number.

minLength1

Boolean? AllowDecimal

Whether decimal quantities are allowed.

IReadOnlyList<string>? AttentionCode

Attention codes applied to the product.

Double? AverageWeight

Average weight of the product.

formatdouble

string? Barcode

Primary barcode for the product.

IReadOnlyList<BarcodesArray>? BarcodesArray

Additional barcodes for the product.

string? Barcode

Barcode value.

string? BaseUnitName

Name of the base unit (e.g. piece, kg).

string? BrandCode

Brand code.

string? BrandDescription

Brand description.

Double CarrierItemQuantity

Quantity per carrier item.

formatdouble

string? CategoryCode

Category code the product belongs to.

string? Color

Color name.

string? ColorCode

Color code.

IReadOnlyList<string>? CountriesAllowed

Countries where the product is allowed.

IReadOnlyList<string>? CountriesNotAllowed

Countries where the product is excluded.

string? CountryCode

ISO country code; defaults to “NL”.

string? DefaultLocationTag

Default location tag for the product.

DateTimeOffset? DeprecationDate

Date the product is deprecated.

formatdate-time

Int? ExpirationMinRange

Minimum days remaining before expiration triggers an alert.

formatint32

IReadOnlyList<FreeField>? FreeFields

Custom free-field key/value pairs.

string? Key

Free-field key.

Int SortOrder

Sort order for display purposes.

formatint32

string? Value

Free-field value.

Int? GeneralLedgerAccountNumber

General ledger account number.

formatint32

string? ImageUrl

URL of the product image.

Int? Ioq

Initial order quantity.

formatint32

Boolean? IsActive

Whether the product is active.

Boolean? IsAdr

Whether the product is classified as ADR (hazardous goods).

Boolean? IsDeleted

Whether the product is marked deleted.

Boolean? IsEditMinMax

Whether min/max can be edited at store level.

Boolean? IsEditReplenishment

Whether replenishment values can be edited at store level.

Boolean? IsExpiration

Whether expiration tracking is enabled for the product.

Boolean? IsMarkdownAllowed

Whether markdown is allowed for the product.

Boolean? IsOrderManually

Whether the product is ordered manually.

Boolean? IsOrdering

Whether the product can be ordered.

Boolean? IsPromotion

Whether the product is currently in promotion.

Boolean? IsResetStoreStock

When true, resets store stock for the product.

Boolean? IsSet

Whether the product is a set/bundle.

Boolean? IsStock

Whether the product is stocked.

Boolean? IsStoreProduct

Whether the product is store-specific.

Boolean? IsTemplate

Whether the product is a template.

Boolean? IsTheft

Whether the product is theft-sensitive.

string? LedgerDimensionValue

Ledger dimension value used for VC exports.

string? MarginCategory

Margin category classification.

Double? Moq

Minimum order quantity.

formatdouble

Double? Price

Sale price.

formatdouble

Double PriceCompareMultiplier

Multiplier used for unit price comparison.

formatdouble

string? PriceCompareUnit

Unit used for price comparison (e.g. per kg).

string? PriceLines

Comma-separated price line identifiers.

string? ProductDescription

A description of the product.

string? ProductDetails

Free-form product details.

string? ProductReferenceNumber

External product reference number.

string? ProductStatus

Product life-cycle status.

string? ProductType

Product type classification.

string? ProductUrl

URL of the product detail page.

IReadOnlyList<string>? PromoStoresAllowed

Stores where the product is allowed for promotion.

IReadOnlyList<string>? PromoStoresNotAllowed

Stores where the product is excluded from promotion.

Double? PromotionPrice

Promotional price.

formatdouble

string? PromotionText

Promotion text shown on shelf labels.

string? PromotionWeek

Week identifier the promotion applies to.

Double? PurchasePrice

Purchase price from the supplier.

formatdouble

string? PurchaseUnitBarcode

Barcode of the purchase unit.

string? PurchaseUnitName

Name of the purchase unit.

string? PurchaseUnitProductNumber

Product number of the purchase unit.

Double? PurchaseUnitQuantity

Quantity in a purchase unit.

formatdouble

string? PurchbookFreeTxt

Free text used for purchase book/order exports.

string? ReferralProductNumber

Referral product number used as a substitute.

IReadOnlyList<SetProduct>? SetProducts

Products bundled within this set.

string? SetItemQuantity

Quantity of the bundled item.

string? SetProductNumber

Product number of the bundled item.

IReadOnlyList<ShelfLabel>? ShelfLabels

Shelf-label text fields for the product.

string? Shelflabel1

Shelf label slot 1.

string? Shelflabel2

Shelf label slot 2.

string? Shelflabel3

Shelf label slot 3.

string? Shelflabel4

Shelf label slot 4.

string? Shelflabel5

Shelf label slot 5.

string? Shelflabel6

Shelf label slot 6.

string? Size

Size descriptor.

string? SizeCode

Size code.

string? SmallestProductNumber

Product number of the smallest sub-unit.

Double? SmallestQuantity

Quantity of the smallest sub-unit.

formatdouble

string? StoreNumber

Store number when the product is store-specific.

IReadOnlyList<string>? StoresAllowed

Stores where the product is allowed.

IReadOnlyList<string>? StoresNotAllowed

Stores where the product is excluded.

string? SupplierName

Supplier name.

string? SupplierNumber

Supplier number.

string? SupplierProductNumber

Supplier’s product number.

IReadOnlyList<Unit>? Units

Units of measure (e.g. box, pallet) the product is sold in.

required string UnitBarcode

Barcode of the unit.

minLength1

required string UnitName

Name of the unit.

minLength1

required Double UnitQuantity

Quantity per unit.

formatdouble

string? VariantCode

Variant code.

string? VariantFamily

Variant family.

string? Volume

Volume / size descriptor.

ReturnsExpand Collapse

class ProductCreateProductsResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create or Update Products

ProductCreateProductsParams parameters = new();

var response = await client.Products.CreateProducts(parameters);

Console.WriteLine(response);

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}