API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Products

Creates or updates products in bulk.

ProductCreateProductsResponse Products.CreateProducts(ProductCreateProductsParams?parameters, CancellationTokencancellationToken = default)

POST/api/v2/public/products

Retrieves a paginated list of products.

ProductListProductsResponse Products.ListProducts(ProductListProductsParams?parameters, CancellationTokencancellationToken = default)

GET/api/v2/public/products

Deletes products by product numbers.

ProductDeleteProductsResponse Products.DeleteProducts(ProductDeleteProductsParams?parameters, CancellationTokencancellationToken = default)

DELETE/api/v2/public/products

Updates a product attribute value across all products matching the old value.

Products.UpdateProductAttributes(ProductUpdateProductAttributesParamsparameters, CancellationTokencancellationToken = default)

PUT/api/v2/public/products/attributes

Creates or updates product prices.

ProductCreatePricesResponse Products.CreatePrices(ProductCreatePricesParams?parameters, CancellationTokencancellationToken = default)

POST/api/v2/public/products/prices

Creates or updates discount prices for products.

ProductCreateDiscountPricesResponse Products.CreateDiscountPrices(ProductCreateDiscountPricesParams?parameters, CancellationTokencancellationToken = default)

POST/api/v2/public/products/discountprices

ModelsExpand Collapse

class ProductItem:

Full product details returned from the products GET endpoint, including units, barcodes, pricing, and store/country assignments.

required string Barcode

required string ProductName

Display name of the product.

required string ProductNumber

Unique product number.

Boolean? AllowDecimal

string? AttentionCode

Double? AverageWeight

formatdouble

string? BarcodesArray

string? BaseUnitName

string? BrandCode

string? BrandDescription

Double CarrierItemQuantity

formatdouble

string? CategoryCode

string? Color

string? ColorCode

IReadOnlyList<string>? CountriesAllowed

IReadOnlyList<string>? CountriesNotAllowed

string? CountryCode

DateTimeOffset? DeprecationDate

formatdate-time

Int EditMinMaxPercentage

formatint32

Int? ExpirationMinRange

formatint32

IReadOnlyList<FreeField>? FreeFields

string? Key

Int SortOrder

formatint32

string? Value

string? GeneralLedger

string? ImageUrl

Boolean? IsActive

Boolean? IsCounted

Boolean? IsEditMinMax

Boolean? IsEditReplenishment

Boolean? IsExpiration

Boolean? IsOrderManually

Boolean? IsPromotion

Boolean? IsSet

Boolean? IsStock

Boolean? IsStoreProduct

Boolean? IsTemplate

string? MarginCategory

Double? Moq

formatdouble

Double? OldPrice

formatdouble

Double? Price

formatdouble

Double PriceCompareMultiplier

formatdouble

string? PriceCompareUnit

string? PriceLines

string? ProductDetails

string? ProductType

string? ProductUrl

IReadOnlyList<string>? PromoStoresAllowed

IReadOnlyList<string>? PromoStoresNotAllowed

string? Promotion

string? PromotionWeek

Double? PurchasePrice

formatdouble

string? PurchaseUnitBarcode

string? PurchaseUnitName

string? PurchaseUnitProductNumber

Double? PurchaseUnitQuantity

formatdouble

string? ReferralProductID

Boolean? ResetStoreStock

IReadOnlyList<SetProduct>? SetProduct

string? SetItemQuantity

string? SetProductNumber

Boolean? ShelfLabel

Boolean? ShelfLabelBarcode

Int? ShelfLabelLayout

formatint32

Boolean? ShelfLabelPrice

Int ShelfLabelQuantity

formatint32

string? Size

string? SizeCode

string? SmallestProductNumber

Double? SmallestQuantity

formatdouble

Double? SpecialPrice

formatdouble

IReadOnlyList<string>? StoresAllowed

IReadOnlyList<string>? StoresNotAllowed

string? SupplierID

string? SupplierName

string? SupplierProductNumber

IReadOnlyList<Unit>? Units

string? UnitBarcode

string? UnitName

Double UnitQuantity

formatdouble

string? VariantCode

Double? VariantFactor

formatdouble

string? VariantFamily

string? Volume