Models
The Listing object
Every field of the Listing object, with types, required flags and validation rules.
The Listing object
| Field | Type | Description |
|---|---|---|
id | string | Opaque: 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 |
object | string | always listing |
product_id | string | |
channel_account_id | string | |
channel | string | Base channel of the account (denormalized for convenience) |
status | ListingStatus | New values may be added; tolerate unknowns. One of: listed, imported, ongoing, error, delisted |
id_on_channel | string · nullable | |
url_on_channel | string · nullable | uri |
site | string · nullable | eBay only. The marketplace site this listing lives on (e.g. US, Italy). Stamped at publish |
overrides | object | This channel's own values; null = the product's (title, description, condition). Imported listings start with the channel's texts |
overrides.title | string · nullable | |
overrides.description | string · nullable | |
overrides.condition | string · nullable | This 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_note | string · nullable | |
overrides.category_id | string · nullable | The 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 |
content | object | What the channel receives. The override where set, the product's text otherwise |
content.title | string · nullable | |
content.description | string · nullable | |
content.category_id | string · nullable | The listing's category: chosen, or picked by the channel at publish |
content.category_path | string · nullable | e.g. Home & Garden > Major Appliances > Major Appliances Parts & Accessories > Dishwasher Parts |
attributes | object | Category 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] |
variants | array of ListingVariant | |
issues | array of Issue | |
operation_id | string · nullable | The 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_at | string | When the listing was created (first publish or import on this account). ISO 8601 |
updated_at | string | Last change of the listing. ISO 8601 |
Request models
What you send when creating or updating. Fields not listed are ignored.
ListingCreate
| Field | Type | Required | Description |
|---|---|---|---|
product_id | string | required | |
channel_account_id | string | required | |
site | string | optional | eBay only. Target marketplace site for NEW listings; defaults to the account's configured site |
overrides | object | optional | This channel's own values (null or omitted = the product's) |
overrides.title | string | optional | max 1000 chars |
overrides.description | string | optional | max 100000 chars |
overrides.condition | string | optional | one of: new, new_other, refurbished, used_like_new, used_very_good, used_good, used_acceptable, for_parts |
overrides.condition_note | string | optional | max 1000 chars |
category_id | string | optional | The 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 |
attributes | object | optional | Category 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_map | object | optional | Amazon, 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
| Field | Type | Required | Description |
|---|---|---|---|
overrides | object | optional | |
overrides.title | string · nullable | optional | This channel's own title; null = the product's. Max 1000 chars |
overrides.description | string · nullable | optional | This channel's own description (HTML); null = the product's. Max 100000 chars |
overrides.condition | string · nullable | optional | This 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_note | string · nullable | optional | max 1000 chars |
category_id | string · nullable | optional | The channel category / Amazon product type (see ListingCreate). A live listing moves to it with the push; null lets the channel choose again |
attributes | object | optional | Fields to set, same shape as on the listing; null clears a field. Fields not sent are kept |
variation_map | object | optional | Amazon, products with variants (see ListingCreate) |
Last updated on November 2, 2026
Need help?
Email us and a human replies, usually within one business day.