Listing
Last updated
Last updated
A listing is an item or a commodity that is sold in a facility. It holds information on the product such as price, barcodes or attributes. A listing does not represent the actual stock, i.e., the (available) quantity of a product in a facility. All information specific to individual pieces of a product is kept in .
Please note the difference between listings and .
While a listing holds master data for a product within a facility such as title, barcode, or price, a stock refers to one or more items in a facility with the same attributes. Stocks can exist without listings and the other way around. However, we advise to always create listings for stocks so that the various stocks are assigned to the corresponding product and product information can be displayed in the clients. Go for more information on stocks.
Listings can be active or inactive.
Deactivated listings are not considered for incoming orders.
Attributes store listing-specific information such as product category or description. Moreover, they can be used to customize processes related to listings, such as the picking sequence. For more information, please refer to .
Configuration to show the client how the items should be scanned during picking. For more information, please refer to .
If a listing is already flagged with outOfStockBehaviour = "BACKORDER" and has anavailabilityTimeFrameconfigured, then orders containing that listing are accepted but only assigned a specific facility when the date defined in the availabilityTimeFrame is reached.
If one product should be tracked in different units (for example, as bulk by weight and also by prepackaged quantity), two listings with different tenantArticleIds need to be created, e.g., xyz-123-bulk" and "xyz-123-packaged". Since each product is kept in just one measurement unit, operations like adding or moving stock do not need to validate or convert units between stocks.
Often, it is helpful to limit and enforce which properties are tracked for which type of product. You can configure this using the stockProperties field on Listings. This field does not contain key-value pairs of property values but rather StockPropertyDefinitions. Each defines the following:
inputType
DATE or TEXT. The input type controls how values of this property should be treated by clients (i.e. show a date picker instead of a text field).
required
boolean. Creating a stock without providing a value for a required property will be forbidden and fail.
defaultValue
String or {{NOW}}which will be interpolated to current timestamp.
Constraints, validations as well as default values are ONLY applied on creation of stocks.
This means that existing stocks may still not have properties, even if required, or have properties which are - by a newer ruleset - not allowed.
If no constraints should be enforced, the stockProperties field can be set to null/undefined. In that case it is ensured that no properties are set.
In the listing it can be specified until when the corresponding stock should be available. The availableUntil value is set upon stock creation if configured in the listing.
modifier:The time span is applied to the calculation base to calculate when stock should become unavailable. Use negative values to move the date backward. Example: "-P30D" places the "availableUntil" value 30 days before the calculated date.
StockAvailableUntil defaults to the expiry date, i.e., if there is no stockAvailableUntil configured on the listing, the stockAvailableUntil of a stock will be its expiry date.
An undefined stockAvailableUntil on stocks (e.g., no stockAvailableUntil and no expiry is configured) means the stock will be available unlimitedly.
Under legal, users can specify a hsCode. "HS" stands for "Harmonized system" and is a description and coding system authorities use to classify a product. In our platform, it is used, e.g., when requesting a carrier label for sending a package.
A listing can belong to one to many categories. The categoryRef on the listing allows different listings to be assigned to the same category.
Defines behavior if customer places an order for a product that is currently out of stock or unavailable for immediate shipment. For more information please refer to .
Tags consist of a Tag-Reference plus allowed values for each Tag. They can be used to map very individual processes and to customize entities according to particular needs. For more information, please refer to .
Measurement units specify the unit in which the product is counted or measured. They can be set using the measurementUnitKey field. The default counting unit is pieces. However, other units, such as gram, liters, or custom units, can be defined. For more information on creating new units and their localizations, please refer to .
Stock Properties allow tracking specific values on a set of items, a . A typical example of properties is the expiry date or batch number. The listing defines which properties should be tracked for stocks associated with this specific listing. Moreover, it is configurable in the listing whether it is mandatory to track stock properties, e.g., during goods receipt, and if the value is expected to be a text or date. For more information, please refer to .
For more information please refer to .
The availableUntil field defines until when a stock is included in the stock availability, which is, e.g., used to communicate available stock to shop systems. For customer orders, the availability check ensures that stock has not exceeded its availableUntil value until it is delivered to the customer. For more information, please refer to .
For more information please refer to .
calculation base: Specifies the base date for the calculation of availableUntil. Set the field to EXPIRY if the stock should become unavailable before it expires. EXPIRY must be configured in the before it can be used here. Set the field to CREATION if the stock should become unavailable sometime after it was created.
More information can be found under .