Listing

Listing (transactable) returned by the deprecated listings query. Deprecated, use Record instead

type Listing implements ListingCustomAttributeInterface, ListingsMetadata, RelationOnDemandInterface, RemoteModelInterface {
  created_at: JSONDate
  creator: UserListing
  creator_id: ID
  custom_address(name: String!): ListingAddress
  custom_addresses(name: String): [ListingAddress!]
  custom_attachment(name: String!): ListingsPrivateFile
  custom_attachments(name: String): [ListingsPrivateFile!]
  custom_image(name: String!): ListingImage
  custom_images(name: String): [ListingImage!]
  customizations(
    name: String
    properties: [QueryCustomAttribute]
    user_id: ID
  ): [ListingsCustomization!]
  deleted_at: JSONDate
  external_id: ID
  id: ID!
  model(
    foreign_property: String = "id"
    join_on_property: String
    model_name: String
  ): ListingsCustomization
  models(
    foreign_property: String!
    join_on_property: String!
    model_name: [String]
  ): [ListingsCustomization!]
  name: String
  properties: HashObject
  property(name: String!): String
  property_array(name: String!): [String!]
  property_json(name: String!): JSONPayload
  related_model(
    foreign_property: String = "id"
    join_on_property: String
    model_schema_name: String
  ): ListingsCustomization
  related_models(
    foreign_property: String!
    join_on_property: String!
    model_schema_name: [String]
  ): [ListingsCustomization!]
  related_user(
    foreign_property: String = "id"
    join_on_property: String = "user_id"
  ): User
  remote_model(endpoint: Endpoint!, join_on_property: String!): Customization
  slug: String!
  sort_score: [Int]
  type: String
  updated_at: JSONDate
  user(
    foreign_property: String = "id"
    join_on_property: String = "user_id"
  ): User
}

Fields

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

creator (UserListing)

User who created the listing; only loaded when listing: { has_creator: true } is set in the query arguments

creator_id (ID)

Id of the user who created the listing

custom_address (ListingAddress)

Address with the given name; e.g. address: custom_address(name: "office_address")

• name (String)

Name of the address property

custom_addresses (ListingAddress)

All addresses, optionally only those with the given name; e.g. home: custom_addresses(name: "home")

• name (String)

Name of the address property to return addresses of

custom_attachment (ListingsPrivateFile)

Attachment with the given name; e.g. sales_report: custom_attachment(name: "sales_report")

• name (String)

Name of the attachment property

custom_attachments (ListingsPrivateFile)

All attachments, optionally only those with the given name

• name (String)

Name of the attachment property to return attachments of

custom_image (ListingImage)

Image with the given name; e.g. header: custom_image(name: "header")

• name (String)

Name of the image property

custom_images (ListingImage)

All images, optionally only those with the given name; e.g. cat_images: custom_images(name: "cat")

• name (String)

Name of the image property to return images of

customizations (ListingsCustomization)

Customizations attached to the listing

• name (String)

Only customizations of this model schema

• properties (QueryCustomAttribute)

Only customizations matching these property conditions

• user_id (ID)

Only customizations owned by this user

deleted_at (JSONDate)

Timestamp of when the object was soft deleted, populated by the delete action.
It is also possible to set it manually via update. To undelete, change it back
to an empty value; note that associated objects need to be undeleted manually as well.

external_id (ID)

Identifier of the object in an external system. Used mainly for import/export,
when a third party service is the source of truth

id (ID)

Unique identifier of the object

model (ListingsCustomization)

Returns the related model. Deprecated, use related_model

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_name (String)

Name of the model schema (table) of the related models

models (ListingsCustomization)

Returns related models. Deprecated, use related_models

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_name (String)

Name of the model schema (table) of the related models

name (String)

Name of the listing

properties (HashObject)

All properties of the object

property (String)

Value of the property with the given name, as a String; e.g. hair_color: property(name: "hair_color")

• name (String)

Name of the property

property_array (String)

Value of the Array property with the given name, as an Array (in contrast to
property, which returns a String); e.g. todo_list: property_array(name: "todo_list")

• name (String)

Name of the property

property_json (JSONPayload)

Value of the property with the given name, as JSON (in contrast to property,
which returns a String); e.g. todo_list: property_json(name: "todo_list")

• name (String)

Name of the property

related_model (ListingsCustomization)

Returns the model whose foreign_property equals the value of join_on_property
of this object (belongs-to relation). Legacy relation, use related_record of Record instead

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_schema_name (String)

Name of the model schema (table) of the related models

related_models (ListingsCustomization)

Returns models whose foreign_property equals the value of join_on_property of
this object (has-many relation), at most 10000 at once. Legacy relation, use
related_records of Record instead

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_schema_name (String)

Name of the model schema (table) of the related models

related_user (User)

Returns the user whose foreign_property equals the value of join_on_property
of this object; by default the user whose id is in user_id

• foreign_property (String)

Name of the user attribute that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object holding the user id

remote_model (Customization)

Returns an object loaded from the remote endpoint by the id stored in join_on_property. Deprecated, use remote_records

• endpoint (Endpoint)

Remote endpoint returning the resources for the given ids as JSON

• join_on_property (String)

Name of the property of this object holding the id (or array of ids) to request

slug (String)

URL-friendly identifier of the listing

sort_score (Int)

When sorting by distance, the distance to the reference point. Deprecated

type (String)

Name of the transactable type of the listing

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

user (User)

Returns the related user. Deprecated, use related_user

• foreign_property (String)

Name of the user attribute that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object holding the user id

Interfaces

ListingCustomAttributeInterface

Property and attachment accessors of objects returned by deprecated search queries. Deprecated

ListingsMetadata

Search metadata of results returned by deprecated search queries. Deprecated

RelationOnDemandInterface

Deprecated relations of legacy objects to models and users

RemoteModelInterface

Deprecated relation to an object loaded over HTTP from a remote endpoint