Listing
Last updated
Last updated
A listing is an item or a commodity that is sold in a given 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 stocks.
Please go to the for more information on managing listings via API. The API documentation can be found here.
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 here for more information on stocks.
Listings can be active or inactive.
Deactivated listings are not considered for incoming orders.
Attributes can be used to 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 customization via attributes.
Configuration to show the client how the items should be scanned during picking. For more information please refer to scanning configuration.
Defines behaviour 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 How to make a listing Pre-/Backorderable.
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.
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 special needs. For more information please refer to Tags and Stickers Concept.
The unit in which the product is counted or measured. By default, the counting unit is pieces. However, other units like gram or custom units can be defined. For more information please refer to Measurement Units.
Stock Properties allow tracking of specific values on a set of items, a Stock. A common example for properties are expiry date or batch number. The listing defines which properties should be tracked for stocks that belong to this specific listing. Moreover, its 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 Stock Properties.
Often it is useful 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:
| Description | |
|---|---|
|
|
|
|
| String or |
IMPORTANT
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 you do not want to enforce any constraints, just set the stockProperties field to null/undefined. Be aware, that stockProperties: {} is a valid configuration and will ensure that no properties are set!
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 is is delivered to the customer.
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 listing. For more information please refer to Availability.
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 for an unlimited period of time.
Under legal, users can specify a hsCode. "HS" stands for "Harmonized system" and is a description and coding system used by authorities to classify a product. In our platform, it is used, e.g., when requesting a carrier label for sending a package.