Listing Object

Description

Represents a listing (inventory variant) of an item with pricing, stock, and options.

Declaration

type Listing {
    _id: ID!
    id: Float!
    createdBy: UserReference
    status: String!
    prices: ListingPrice!
    comments: String
    privateComments: String
    location: String
    discogsId: Float
    taxDefinition: String
    preventDiscogsListing: Boolean
    readOnly: Boolean
    onePerCustomer: Boolean
    stock: ListingStock!
    options: [ListingOption!]!
    supplierCode: String
    sku: String
    barcode: String
    posted: Date
    available: Date
    preOrder: Boolean
    categories: [String!]!
    logs: [LogEntry]
    archived: Boolean
    secondHand: Boolean
}

Fields

Name	Type	Description
_id	ID!	Internal database identifier.
id	Float!	Numeric identifier for the listing.
createdBy	UserReference	User who created the listing.
status	String!	Status of the listing. Valid values include "active", "inactive", "sold", or "archived".
prices	ListingPrice!	Pricing information for the listing.
comments	String	Public comments or notes about the listing.
privateComments	String	Private comments visible only to staff.
location	String	Storage location of the item.
discogsId	Float	External identifier from the marketplace system.
taxDefinition	String	Tax definition identifier applied to this listing.
preventDiscogsListing	Boolean	Whether to prevent this listing from being listed on the marketplace system.
readOnly	Boolean	Whether the listing is read-only and cannot be modified.
onePerCustomer	Boolean	Whether only one item per customer is allowed for this listing.
stock	ListingStock!	Stock quantity information.
options	[ListingOption!]!	Product option variants for this listing.
supplierCode	String	Supplier code for the item.
sku	String	Stock keeping unit (SKU) identifier.
barcode	String	Barcode identifier for the item.
posted	Date	Date when the listing was posted or published.
available	Date	Date when the item becomes available for purchase.
preOrder	Boolean	Whether this is a pre-order listing.
categories	[String!]!	Categories this listing belongs to.
logs ⚠️	[LogEntry]	Historical log entries for the listing. ⚠️ Deprecated: No longer supported
archived	Boolean	Whether the listing is archived.
secondHand	Boolean	Whether this is a second-hand item.