Models

Questa pagina è disponibile solo in inglese.

The Listing object

Every field of the Listing object, with types, required flags and validation rules.

The Listing object

FieldTypeDescription
idstringOpaque: unique per product and channel account (two Shopify accounts give the same product two different listing ids). Never build or parse it. e.g. list_9ac2e
objectstringalways listing
product_idstring
channel_account_idstring
channelstringBase channel of the account (denormalized for convenience)
statusListingStatusNew values may be added; tolerate unknowns. One of: listed, imported, ongoing, error, delisted
id_on_channelstring · nullable
url_on_channelstring · nullableuri
sitestring · nullableeBay only. The marketplace site this listing lives on (e.g. US, Italy). Stamped at publish
overridesobjectThis channel's own texts; null = the product's (title, description). Imported listings start with the channel's texts
overrides.titlestring · nullable
overrides.descriptionstring · nullable
overrides.category_idstring · nullableNot available yet
contentobjectWhat the channel receives. The override where set, the product's text otherwise
content.titlestring · nullable
content.descriptionstring · nullable
attributesobjectChannel/category attributes (eBay item aspects, Etsy properties…). Not writable through the API yet: a write with attributes is refused with 422 validation_failed
variantsarray of ListingVariant
issuesarray of Issue
operation_idstring · nullableThe last API operation with a result on this listing (publish, resync, delist, stock or price push, product edit), in progress or settled: it keeps pointing at it after it completes. Read its outcome and per-channel error with GET /operations/{id}. null when the API never wrote to this listing (e.g. a listing created from the dashboard)
created_atstringWhen the listing was created (first publish or import on this account). ISO 8601
updated_atstringLast change of the listing. ISO 8601

Request models

What you send when creating or updating. Fields not listed are ignored.

ListingCreate

FieldTypeRequiredDescription
product_idstringrequired
channel_account_idstringrequired
sitestringoptionaleBay only. Target marketplace site for NEW listings; defaults to the account's configured site
overridesobjectoptionalNot available yet. Sending a non-empty object returns 422. Arrives in a later release
overrides.titlestringoptional
overrides.descriptionstringoptional
overrides.category_idstringoptional
attributesobjectoptionalNot available yet. A write with attributes is refused with 422 validation_failed

ListingUpdate

FieldTypeRequiredDescription
overridesobjectoptional
overrides.titlestring · nullableoptionalThis channel's own title; null = the product's. Max 1000 chars
overrides.descriptionstring · nullableoptionalThis channel's own description (HTML); null = the product's. Max 100000 chars
overrides.category_idstring · nullableoptionalNot available yet (422)
attributesobjectoptionalNot available yet (422)

Ultimo aggiornamento il 18 ottobre 2026

Serve aiuto?

Scrivici e ti risponde una persona, di solito entro un giorno lavorativo.

In questa pagina