Models

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 values; null = the product's (title, description, condition). Imported listings start with the channel's texts
overrides.titlestring · nullable
overrides.descriptionstring · nullable
overrides.conditionstring · nullableThis channel's condition; null = the product's. One of: new, new_other, refurbished, used_like_new, used_very_good, used_good, used_acceptable, for_parts
overrides.condition_notestring · nullable
overrides.category_idstring · nullableThe category the seller chose (GET /channel_accounts/{id}/categories), or the confirmed Amazon product type of a product Amazon has no page for. null = the channel picks it; content.category_id is the one it has
contentobjectWhat the channel receives. The override where set, the product's text otherwise
content.titlestring · nullable
content.descriptionstring · nullable
content.category_idstring · nullableThe listing's category: chosen, or picked by the channel at publish
content.category_pathstring · nullablee.g. Home & Garden > Major Appliances > Major Appliances Parts & Accessories > Dishwasher Parts
attributesobjectCategory attributes of this listing (eBay item specifics, Etsy and TikTok attributes, Amazon product type fields), as {"<field id>": value}: a string or number, an array for multi-value fields, or {"value": …, "unit": …} for measures. Ids, allowed values, units and which are required come from GET /channel_accounts/{id}/attribute_schema. Fields the product already holds (brand, MPN, color, size, material, weight, dimensions, MSRP) are filled from the product. e.g. [object Object]
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
overridesobjectoptionalThis channel's own values (null or omitted = the product's)
overrides.titlestringoptionalmax 1000 chars
overrides.descriptionstringoptionalmax 100000 chars
overrides.conditionstringoptionalone of: new, new_other, refurbished, used_like_new, used_very_good, used_good, used_acceptable, for_parts
overrides.condition_notestringoptionalmax 1000 chars
category_idstringoptionalThe channel category (GET /channel_accounts/{id}/categories): it wins over the one the channel picks from the title. On Amazon, for a product Amazon has no page for (no ASIN and no barcode match), the Amazon product type (GET /channel_accounts/{id}/amazon_product_types): Nembol then creates the product page
attributesobjectoptionalCategory attributes of this listing (eBay item specifics, Etsy and TikTok attributes, Amazon product type fields), as {"<field id>": value}: a string or number, an array for multi-value fields, or {"value": …, "unit": …} for measures. Ids, allowed values, units and which are required come from GET /channel_accounts/{id}/attribute_schema. Fields the product already holds (brand, MPN, color, size, material, weight, dimensions, MSRP) are filled from the product
variation_mapobjectoptionalAmazon, products with variants: what an option name is on Amazon, as {"<option name>": "<kind>"} with a kind from details.kinds of amazon_variation_unknown (e.g. {"Finish": "style"}). Only needed for names Nembol doesn't recognise; null forgets one

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.conditionstring · nullableoptionalThis channel's condition; null = the product's. One of: new, new_other, refurbished, used_like_new, used_very_good, used_good, used_acceptable, for_parts
overrides.condition_notestring · nullableoptionalmax 1000 chars
category_idstring · nullableoptionalThe channel category / Amazon product type (see ListingCreate). A live listing moves to it with the push; null lets the channel choose again
attributesobjectoptionalFields to set, same shape as on the listing; null clears a field. Fields not sent are kept
variation_mapobjectoptionalAmazon, products with variants (see ListingCreate)

Last updated on November 2, 2026

Need help?

Email us and a human replies, usually within one business day.

On this page