Models

The Listing object

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

The Listing object

FieldTypeDescription
idstringe.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.
overridesobjectPer-channel content overrides; unset fields fall back to the product.
overrides.titlestring · nullable
overrides.descriptionstring · nullable
overrides.category_idstring · nullable
attributesobjectChannel/category attributes (eBay item aspects, Etsy properties…). Open object in this spec; validated at write time against the category's attribute_schema.
variantsarray of ListingVariant
issuesarray of Issue
operation_idstring · nullableThe operation tracking the last write on this listing.
created_atstringISO 8601
updated_atstringISO 8601

Request models

What you send when creating or updating. Anything not listed is rejected.

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 — arrives with the attribute_schema discovery endpoints.

ListingUpdate

FieldTypeRequiredDescription
overridesobjectoptional
overrides.titlestring · nullableoptional
overrides.descriptionstring · nullableoptional
overrides.category_idstring · nullableoptional
attributesobjectoptional

Last updated on July 30, 2026

Need help?

The API is in private beta — email us and a human replies, usually within one business day.

On this page