Type specifications
Response from the API endpoint...
Product
Brand
string
Product brand
SKU *
string
Product SKU
Stock
Stock details
Price
Price details
Features
Product features details
ProductPrice
Price
decimal?
Price before taxes
PriceWithTaxes
decimal?
Price after taxes
Already include taxes value.
SuggestedRetailPrice
decimal?
Suggested retail price
SalesMargin
decimal?
Sales margin to apply to the product price or suggested retail price.
Cost
decimal?
Product cost (purchasing cost, manufacturing cost, etc).
B2BDiscountRate
decimal?
Extra discount rate for the product. (Only for Alephee B2B portals)
MeasurablePriceWithTaxes
Product measurable price with taxes.
This object is intended to replace the other price fields, using measurable price. It should only be used by those accounts that work with measurable products, such as supermarkets and other similar-type accounts.
DO NOT USE this object unless you are absolutely certain that your products use measurable quantities.
ProductStock
Quantity
integer?
Set the current product available stock.
Movement
integer?
Sets and executes a stock inventory movement on the current product’s stock.
Positive integer values ADD the movement quantity to the product stock.
Negative integer values SUBSTRACT the movement quantity to the product stock.
(Please note that the GET product method does not return this value.)
MinPublicationQuantity
integer?
Set the minimum stock to pause the marketplace’s publications (if any) that belongs to the product.
By default, Alephee pauses the product’s product listings when the stock value reach zero units.
Can only be used when accountID belongs to a seller or official store Alephee’s account type.
MaxPublicationQuantity
integer?
Set the maximum stock to set on the marketplace’s publication.
Can only be used when accountID belongs to a seller or official store Alephee’s account type
B2BQuantity
integer?
Set the current product available stock for the B2B portal.
(Only for Alephee B2B portals)
Alert
Stock alert details.
(Only for Alephee B2B portals)
Measurable quantity
ProductMeasurableQtyType?
Product measurable quantity.
This object is intended to replace the other stock fields, using measurable quantities. It should only be used by those accounts that work with measurable products, such as supermarkets and other similar-type accounts.
DO NOT USE this object unless you are absolutely certain that your products use measurable quantities.
PublishQuantity
Obsolete and deprecated. Do not use this attribute because it has no effect.
Regardless of whether this attribute appears in Swagger document, it should not be used.
ProductStockAlert
RedQty
integer?
Red Quantity
(Only for Alephee B2B portals)
YellowQty
integer?
Yellow Quantity
(Only for Alephee B2B portals)
ProductFeatures
Visibility
integer?
Sets the product visibility.
(Only for Alephee B2B portals)
Allowed values are:
0 = Product not visible.
1 = Product visible.
2 = Product visible, but not purchasing allowed.
ProductMeasurableQuantity
Quantity
decimal
The decimal numeric quantity
Unit
string
The measurement unit of the quantity. Available values are:
Mass units:
"kg", "g", "mg", "cg", "mcg", "t", "lb", "lbs", "oz"
Length units:
"m", "mi", "yd", "km", "hm", "dm", "cm", "mm", "ft", "in", "nm"
Pressure units:
"bar", "psi", "atm", "pa", "at"
ProductMeasurablePrice
Price
decimal
The decimal numeric quantity
Unit
string
The measurement unit of the quantity. Available values are:
Mass units:
"kg", "g", "mg", "cg", "mcg", "t", "lb", "lbs", "oz"
Length units:
"m", "mi", "yd", "km", "hm", "dm", "cm", "mm", "ft", "in", "nm"
Pressure units:
"bar", "psi", "atm", "pa", "at"
ActionResult
Quantities
ActionResultQuantitiesType
Quantity Totals
Items
Items result details
ActionResultQuantities
Total
integer
Total Products Processed
Ok
integer
Ok Products quantity
Error
integer
Products with errors quantity
Warning
integer
Products with warnings quantity
Info
integer
Products with information quantity
ItemResult
ItemNumber
integer
Item number
ValidationLevel
{
Id (integer),
Name(string)
}
Worst validation Level
99 = Ok,
2 = Info, 1 = Warning,
0 = Error
KeyField
string
Fixed: SKU
KeyValue
string
Product SKU
Messages
Validation Messages
ValidationMessage
Level
{
Id (integer), Name(string)
}
Severity Level:
99 = Ok,
2 = Info,
1 = Warning, 0 = Error
Code
integer
Unique error code
Message
string
Error description
ValidatedValue
string
Validated Value (ex: Price, Sky, Qty)
Last updated
Was this helpful?