Listing
Last updated
Was this helpful?
Last updated
Was this helpful?
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 .
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.
tenantArticleId: identifier for the product in the respective facility
title: name of the product that is also displayed in clients (e.g. in our app)
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 .
The price at which the item is sold in this facility.
Weight of the product that is used to calculate the shipping weight for an order.
A list of barcodes that allows identifying items via barcode scan.
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.
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.
modifier:Time span which is applied to the calculation base to calculate time point when stock should become unavailable. Use negative values to move the date backwards. 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 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.
Listings can be active or inactive. Deactivated listings are not considered for incoming orders.
A listing can only have a specified price in a single currency. There can only exist one listing for the same tenantArticleId in the same facility and thus, only one currency per facility per tenantArticleId. Any currency that is part of the standard can be configured.
Configuration to show the client how the items should be scanned during picking. For more information please refer to .
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 .
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 .
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 .
Stock Properties allow tracking of specific values on a set of items, a . 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 .
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 .
calculation base:Set field to EXPIRY, if stock should become unavailable before it expires. EXPIRY needs to be configured in the before it can be used here. Set field to CREATION if stock should become unavailable some time after it was created.
Custom Attributes can be used to carry information that might be of interest to connectors or services outside of fulfillmenttools. However, they do not have any influence on the behaviour of the fulfillmenttools platform. For more information please refer to .
ID of facility you want to get listing
all entities after given Id
number of facilities to show
25Array of tenantArticleIds
limit results to this scannableCode
ID of facility you want to delete all listings of
No content
ID of facility you want to get listing
tenantArticleId of listing you want to get
ID of facility you want to delete a listing of
tenant ID of the articles listing you want to delete
No content
ID of facility you want to get its listing
No content
ID of facility you want to patch a listing of
tenant ID of the articles listing you want to patch
The version of the document to be used in optimistic locking mechanisms.
42