Models
Cette page n'est disponible qu'en anglais.
The Channel connection object
Every field of the Channel connection object, with types, required flags and validation rules.
ChannelConnection
| Field | Type | Description |
|---|---|---|
id | string | e.g. conn_66f0a1 |
object | string | always channel_connection |
channel | string | e.g. ebay |
method | string | one of: oauth, credentials |
status | string | one of: pending, opened, needs_choice, connected, failed, expired |
choices | array · nullable | needs_choice only: the accounts / marketplaces the seller can connect. Send one value to POST /channel_connections/{id}/choose |
params | object | The non-secret params (shop, url, region). Credentials are never returned or stored |
connect_url | string | Only on creation, while pending. The single-use link to open in the merchant's browser. Uri |
return_url | string · nullable | |
channel_account_id | string · nullable | Set once connected |
error | object · nullable | |
error.code | string | e.g. channel_login_failed |
error.message | string | |
expires_at | string · nullable | OAuth link expiry (1 hour). ISO 8601 |
created_at | string | ISO 8601 |
reconnects_shop | string · nullable | Set when this connection brings back a disconnected account: the shop it had. The seller must log into that shop (another one fails with different_channel_account); use new_account: true to add a different shop. e.g. acme-vintage |
import_products | boolean | As asked on creation |
import_orders | boolean | As asked on creation |
import_operation_id | string · nullable | The product import started after connecting (import_products); null when none was asked or not yet connected. e.g. op_8fd2c1 |
completed_at | string · nullable | ISO 8601 |
RedirectUrl
| Field | Type | Description |
|---|---|---|
id | string | e.g. rdu_66f0a1 |
object | string | always redirect_url |
url | string | uri |
created_at | string | ISO 8601 |
inherited | boolean | Only inside a sub-account (Nembol-Account): true for the partner's URLs, which apply to every sub-account and are managed by the partner |
Request models
What you send when creating or updating. Fields not listed are ignored.
ChannelConnectionCreate
channel is required, except when channel_account_id is given (reconnect).
| Field | Type | Required | Description |
|---|---|---|---|
new_account | boolean | optional | A disconnected account keeps its place with the name of its last shop, so connecting that channel again first brings it back (the same shop, with its listings still linked; see reconnects_shop on the connection) with a NEW chac_ id: its listings carry the new id. Send true to connect a different shop in a new place instead. Default false |
import_products | boolean | optional | Import the channel's catalog into Nembol once the account is connected. Off by default through the API (your app owns the catalog); the dashboard always imports. When on, the import is a regular operation: its id is the connection's import_operation_id; follow it with GET /operations/{id} and undo it with POST /imports/{id}/undo. Only for channels that support imports (422 import_not_supported otherwise). Default false |
import_orders | boolean | optional | Also bring in the orders the shop already had before connecting (a one-time pull). Off by default through the API. New orders are always synced from the moment the account is connected. Default false |
channel_account_id | string | optional | Reconnect an existing channel account (for example after its login expired) instead of connecting a new one. The seller logs in again; the account keeps its id and every listing linked to it. If they log into a different shop or account, nothing is changed and the connection fails with different_channel_account. No free slot is needed. channel, when sent, must match the account's channel. e.g. chac_6aa12cab |
channel | string | optional | one of: ebay, etsy, shopify, woocommerce, tiktok, temu, amazon, gmc, fb_catalog, square, squarespace, faire, wix, facebook, pinterest, tumblr, kaufland, onbuy, prestashop, subito |
params | object | optional | Per channel. shopify: shop (the name before .myshopify.com); woocommerce: url (site address); tiktok: region (us, uk, de, it, fr, es, mx, ie; default us); temu: region (us, eu, global; default us); kaufland: client_key, secret_key; onbuy: consumer_key, secret_key, seller_id, seller_entity_id; prestashop: url, key (webservice key); subito: email, phone, zip, ragione_sociale; amazon: country (US, CA, MX, BR, UK, DE, FR, IT, ES, NL, SE, PL, TR, AE, IN, AU, JP, BE, ZA, EG, SA…) and optional marketplace (marketplace id; default: the country's own). Other channels take none |
return_url | string | optional | OAuth channels only. Must start with a registered redirect URL. Uri |
Dernière mise à jour le 18 octobre 2026
Besoin d'aide ?
Écrivez-nous et une personne vous répond, généralement sous un jour ouvré.