Version 2 of ChannelDock's API. Our API's are divided per user type: Fulfillment centers and Sellers. If you use the wrong sub set of API's you will receive a error message saying so.
\nChannelDock can POST event notifications to your HTTPS endpoint so you do not need to poll API v2. Event names and JSON payloads are the same for sellers and fulfillment centers; seller and FC accounts each configure their own URLs and see their own delivery logs.
\nFull reference (seller vs FC routing, X-Channeldock-Signature verification, retries): open the Webhooks folder; each event has its own subfolder with payload details and an example delivery.
To ensure a reliable and fair usage experience for all users, our API implements comprehensive rate limiting and access restriction mechanisms. The following provides an overview of these features, detailing how they work, the associated headers, and best practices for interacting with our API effectively.
\nTo maintain optimal performance and prevent abuse, each API client is subject to an hourly call limit. This limit defines the maximum number of API requests you can make within a rolling one-hour window.
\nDefault Limit: Each API key is allowed up to 1,000 requests per hour.
\nCustom Limits: Depending on your subscription tier or specific agreements, your hourly call limit (hourly_call_limit) may vary. Please refer to your account details or contact support for more information.
\nNote: The call count resets every hour from the time of the first request in the current window.
\nEvery response from our API includes specific headers that inform you about your current rate limit status. Monitoring these headers allows you to manage your API usage proactively.
\nX-RateLimit-Limit
\nDescription: The maximum number of API calls allowed within the current hour.
\nExample: X-RateLimit-Limit: 1000
\nX-RateLimit-Remaining
\nDescription: The number of API calls you have left in the current hour.
\nExample: X-RateLimit-Remaining: 750
\nX-RateLimit-Reset
\nDescription: The UNIX timestamp indicating when the current rate limit window resets.
\nExample: X-RateLimit-Reset: 1615125600
\nIf you exceed your hourly API call limit, the API will respond with a 429 Too Many Requests status code, along with relevant rate limiting headers.
\nStatus Code: 429 Too Many Requests
\nResponse Headers:
\nX-RateLimit-Limit: Your maximum allowed requests per hour.
\nX-RateLimit-Remaining: 0 (indicating no remaining requests).
\nX-RateLimit-Reset: The UNIX timestamp when the rate limit resets.
\nError Response Body:
\n{\n \"response\": \"error\",\n \"status\": \"Rate limit exceeded\",\n \"message\": \"API call limit exceeded. Please try again later.\"\n}\n\nTo ensure smooth and uninterrupted access to our API, consider the following best practices:
\nMonitor Rate Limiting Headers:
\nImplement Retry Logic:
\nOptimize API Calls:
\nHandle Access Restrictions Gracefully:
\nStay Informed:
\nQ1: How is the X-RateLimit-Reset timestamp calculated?
\nQ2: Can I increase my hourly call limit?
\nQ3: What happens if I ignore the rate limiting headers and continue making requests?
\nQ4: Are there different rate limits for different API endpoints?
\nQ5: How does the access restriction affect API usage during peak hours?
\nIllustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
order.createdFired when a new order is stored in ChannelDock.
\nevent: order.createdpayload: A single order object (not wrapped in an orders array), aligned with Get Orders / Search order in this collection (addresses, order_products, bundle child lines when applicable).Seller webhooks for the order’s seller_id. Center webhooks for each center_id on order lines with fulfillment assigned.
Open Webhook delivery for the full JSON payload (Example tab). See With signature for a delivery that carries the X-Channeldock-Signature header.
Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
order.updatedFired when an order or order line is updated (for example quantity, address, or line fields).
\nevent: order.updatedpayload: Full current order object, same shape as order.created and Get Orders.Same routing as other order events: seller by seller_id; centers on relevant order lines.
Open Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"15b48da9-e40b-464e-9f8c-2b325b7e31a8"},{"name":"order.status.changed","item":[{"name":"Webhook delivery","id":"aa8dd2be-1a28-479c-b2e2-3ca3673076ed","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"order.status.changed\",\n \"payload\": {\n \"id\": 88210,\n \"order_status\": \"shipment\",\n \"order_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
order.status.changedFired when order_status changes on an order (for example from order to shipment).
event: order.status.changedpayload: Full order object including the new order_status, aligned with Get Orders.Same routing as other order events.
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"aa6729cc-f55a-4b06-a2d6-ec2677706e1a"},{"name":"order.deleted","item":[{"name":"Webhook delivery","id":"90ff32f7-195b-4639-adac-8cee769590bd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"order.deleted\",\n \"payload\": {\n \"id\": 88210,\n \"order_id\": \"WC-88210\",\n \"order_status\": \"trash\",\n \"order_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
order.deletedFired when an order is removed from ChannelDock.
\nevent: order.deletedpayload: Order object at deletion time, same general shape as Get Orders (use internal id and order_id to reconcile in your system).Same routing as other order events.
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"b1b52341-01d2-4a72-9f83-d2713cfbab0a"},{"name":"order_product.cancelled","item":[{"name":"Webhook delivery","id":"2f4d6a46-3484-4b8c-87c3-5938fd0a4ffb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"order_product.cancelled\",\n \"payload\": {\n \"id\": 88210,\n \"cancelled_order_product_id\": 91202,\n \"order_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
order_product.cancelledFired when an order line’s cancellation_request is set to cancelled (1).
event: order_product.cancelledpayload: Full order object (same as order.updated), plus:cancelled_order_product_id — internal id of the order line that was cancelled.Center webhooks match the center_id on the cancelled line when fulfillment is assigned.
Open Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"1431d8da-592b-42e6-bd11-9be8084a115c"},{"name":"shipment.created","item":[{"name":"Webhook delivery","id":"c569f777-d482-4bf2-94a2-d3d211cdaaa5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"shipment.created\",\n \"payload\": {\n \"id\": 7701,\n \"track_and_trace\": \"3SBOL00112233\",\n \"order_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
shipment.createdFired when a shipping label is created.
\nevent: shipment.createdpayload: Shipment object aligned with Get Shipments (track_and_trace, carrier_code, order_products, etc.).Seller webhooks for the order’s seller. Center webhooks for the center_id on the shipment label.
Open Webhook delivery in this folder for the full JSON payload (Example tab).
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"041bc037-7e9e-445a-9fa5-fdfb1f917466"},{"name":"stock.updated","item":[{"name":"Webhook delivery","id":"527c8b9c-4518-4667-9d78-0d7e58c6b934","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"stock.updated\",\n \"payload\": {\n \"id\": 25851,\n \"sku\": \"UPW-BAR-52\",\n \"stock\": 84\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
stock.updatedFired when product stock changes (seller inventory or FC stock paths that update the product).
\nevent: stock.updatedpayload: Product stock fields aligned with Get products / inventory (stock, available_stock, total_fbc_stock, tags, child_products for bundles, etc.).Seller webhooks for the product’s seller_id. Center webhooks for FCs linked to that seller.
Open Webhook delivery in this folder for the full JSON payload (Example tab).
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"90b5521a-53a9-461d-b7a9-580953989863"},{"name":"return.created","item":[{"name":"Webhook delivery","id":"1f50de1c-d769-41f9-8137-62a5f14585dd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"return.created\",\n \"payload\": {\n \"id\": 9301,\n \"is_handled\": 0,\n \"return_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
return.createdFired when a return is registered in ChannelDock.
\nevent: return.createdpayload: Return object with return_products (and nested order_product per line), aligned with Get returns.Seller webhooks for the return’s seller. Center webhooks for linked fulfillment centers.
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"b90683cd-96b5-4db7-9338-f27d09f380a9"},{"name":"return.handled","item":[{"name":"Webhook delivery","id":"ff9f016c-f97d-494b-8a91-7406ef2f9f08","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"return.handled\",\n \"payload\": {\n \"id\": 9301,\n \"is_handled\": 1,\n \"return_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
return.handledFired when a return is handled (processed) in ChannelDock.
\nevent: return.handledpayload: Return object including handling fields (for example is_handled, handled_date) and return_products, aligned with Get returns.Same routing as return.created.
Open Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"1027ff47-260c-4727-bada-abc09e752fae"},{"name":"return.product.updated","item":[{"name":"Webhook delivery","id":"f51ab934-bd6b-4006-afd2-5f22b74dd1a5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"User-Agent","value":"ChannelDock-Webhook/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"return.product.updated\",\n \"payload\": {\n \"id\": 9301,\n \"return_products\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example/webhooks/channeldock","description":"Illustrative outbound request ChannelDock sends to your webhook URL when this event fires.
\nReplace the URL with your HTTPS endpoint. Respond with HTTP 2xx within 5 seconds.
\nThe Example tab shows a full JSON body. With a webhook secret configured, ChannelDock signs the delivery\nwith the X-Channeldock-Signature header — HMAC-SHA256 of the raw body. Verify that header; the\ntop-level signature field in the body is deprecated. See the Webhooks folder description.
return.product.updatedFired when a return line (return product) is updated.
event: return.product.updatedpayload: Parent return object with return_products reflecting the update, aligned with Get returns.Same routing as other return events.
\nOpen Webhook delivery in this folder for the full JSON payload (Example tab).
\n","_postman_id":"5c2f60fa-0518-4149-8938-6753acc7fafb"}],"id":"8c4f5d70-fa05-4464-813e-85327b18c19c","description":"ChannelDock sends outbound HTTP POST requests to URLs you configure when events occur in your account. Webhooks are not part of API v2 request/response flows — there are no REST endpoints to create or manage webhooks. Configure them in the portal under Settings → API & Webhooks (paid plans).
\nStep-by-step setup: Setup webhooks in ChannelDock
\nEach event subfolder contains a Webhook delivery request with a full JSON Example tab (and order.created also shows a With signature example).
Sellers and fulfillment centers (FCs) use the same event names and same JSON payload shapes. What differs is who owns the webhook and which deliveries match it.
\nRouting:
\nseller_id matches the entity’s seller.center_id matches fulfillment context: order lines for order events, shipment label center for shipment.created, linked FCs for stock and returns.One event can deliver to both seller and one or more center webhooks if each configured the event.
\nEnvelope:
\n{\n \"event\": \"order.created\",\n \"payload\": { },\n \"signature\": \"legacy-hex-hmac-sha256\"\n}\nThe signature field inside the body is deprecated. It is still sent so existing integrations keep working, but new integrations should ignore it and verify the X-Channeldock-Signature header instead. See Legacy signature field.
2^attempt minutes (2, 4, 8, 16).Your webhook URL has to be publicly reachable, and the delivery carries no other proof of origin — no API key, no credential. So anything that reaches that URL looks like a genuine ChannelDock delivery to your endpoint: a URL leaked through a log file, a proxy or a support ticket, or an earlier delivery someone captured and sent again. Act on the body without checking and a forged stock.updated sets your stock to zero, or a forged order.updated marks an order as shipped in your ERP.
The signature is that missing proof of origin. Only you and ChannelDock know the secret, so only the two of you can produce a value that matches the body you are looking at.
\nSet a webhook secret on the webhook in the portal, and every delivery for it carries:
\nX-Channeldock-Signature: sha256=8b415f2c0cd241a21109e007942b6ce43cbfcf97f7b2d7829084258c0ae0a66f\nThe value is HMAC-SHA256( raw request body, your secret ), hex encoded, prefixed with sha256=. Compute the same thing on your side and compare. With no secret set, the header is absent.
php://input (PHP), $request->getContent() (Laravel), request.get_data() (Flask), request.body (Django), request.raw_post (Rails), or express.json({ verify: (req, res, buf) => { req.rawBody = buf } }) (Express).X-Channeldock-Signature and strip the sha256= prefix. Look the header up case-insensitively — over HTTP/2 it arrives as x-channeldock-signature.HMAC-SHA256(raw body, your webhook secret), hex encoded.hash_equals, crypto.timingSafeEqual, hmac.compare_digest). On a mismatch, return 401 and ignore the body. Only parse the JSON once this succeeds.HMAC covers bytes, not the meaning of the JSON. So hash the body exactly as it arrived, and never parse it and serialise it again to get something to hash.
\nTwo languages can produce JSON that means the same thing but is not the same text: PHP writes c\\/o where Node and Python write c/o, Node writes é where PHP and Python write \\u00e9. Each variant parses to identical data and produces a completely different HMAC. Hashing the original bytes sidesteps all of it.
Do not strip the signature field before hashing either — those bytes are part of the body we signed.
signature field (deprecated)Before the header existed, the body carried a top-level signature field, computed over the JSON without that field and then inserted into it:
signature = HMAC-SHA256( json_encode({ \"event\": \"...\", \"payload\": { ... } }), secret )
It is still sent, unchanged, so integrations that verify it keep working. It is deprecated because verifying it means re-encoding the JSON byte for byte the way PHP does — including PHP writing / as \\/ — which is impractical outside PHP.
The two values are always different, because they cover different bytes. Never compare one against the other.
\nX-Channeldock-Signature when a secret is set, before you act on the body.Test auth endpoint
\n","urlObject":{"path":["portal","api","v2",""],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"7907ffe3-7eab-4160-a2a2-f6dee9ea6d0d","name":"Home endpoint","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"API v2 auth is valid, good luck integrating the ChannelDock API!\"\n}"}],"_postman_id":"c5a67e2e-0747-40a5-ad58-30407c0f7e1b"}],"id":"de098cab-d5b7-44ab-82fb-970a91c40294","description":"Use this endpoint to check if your authentication works properly.
\n","_postman_id":"de098cab-d5b7-44ab-82fb-970a91c40294"},{"name":"Products","item":[{"name":"Get products","id":"83b3768b-9088-40f9-8f36-1b98f81c0b54","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/inventory?page=1","description":"Get all main products with stock levels and other product attributes.
\nThis request's return results are paginated. The API returns 50 items per page.
\nis_flagged (optional): true/false or 1/0. Same product flag as in the portal product list. Omit to return all products.
Filter by product tag with tag_id or tag_title (exact title, case-insensitive). Each product includes tags (title strings) and product_tags (id, title, color).
archived (optional): true/false or 1/0. Same archive setting as in the portal product list. Omit to return all products; the archived field is always included in each product (1 or 0). Use archived=true to list only archived products.
sort_attr may be archived (with sort_dir ASC or DESC).
optional
\n","type":"text/plain"},"key":"id","value":"17334"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"ean","value":"8719326583631"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sku","value":"8719326583631"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"title","value":"Koffiebonen"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"supplier_id","value":"13"},{"disabled":true,"description":{"content":"optional: true/false or 1/0 to list only flagged or unflagged products
\n","type":"text/plain"},"key":"is_flagged","value":"true"},{"disabled":true,"description":{"content":"optional, only products with this seller tag
\n","type":"text/plain"},"key":"tag_id","value":"12"},{"disabled":true,"description":{"content":"optional, exact tag title (case-insensitive)
\n","type":"text/plain"},"key":"tag_title","value":"kitesurf"},{"disabled":true,"description":{"content":"optional: true/false or 1/0 to list only archived or unarchived products
\n","type":"text/plain"},"key":"archived","value":"true"},{"disabled":true,"description":{"content":"optional (id | ean | sku | stock | stocking_date | supplier_id | updated_at | archived)
\n","type":"text/plain"},"key":"sort_attr","value":"stocking_date"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional, includes stock location data
\n","type":"text/plain"},"key":"include_stock_location_data","value":"true"},{"disabled":true,"description":{"content":"optional, datetime UTC, to be used with sort_attr = stocking_date
\n","type":"text/plain"},"key":"start_date","value":"2024-08-13 14:22:26"},{"disabled":true,"description":{"content":"optional, datetime UTC, to be used with sort_attr = stocking_date
\n","type":"text/plain"},"key":"end_date","value":"2024-08-27 00:00:00"}],"variable":[]}},"response":[{"id":"3a99de10-cf0d-412a-ba23-809a363fcd4a","name":"Get products","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/inventory?page=1&sort_attr=updated_at&sort_dir=DESC","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","inventory"],"query":[{"key":"page","value":"1"},{"key":"id","value":"17334","description":"optional","disabled":true},{"key":"ean","value":"8719326583631","description":"optional","disabled":true},{"key":"sku","value":"8719326583631","description":"optional","disabled":true},{"key":"title","value":"Koffiebonen","description":"optional","disabled":true},{"key":"supplier_id","value":"13","description":"optional","disabled":true},{"key":"is_flagged","value":"true","description":"optional: true/false or 1/0 to list only flagged or unflagged products","disabled":true},{"key":"archived","value":"true","description":"optional: true/false or 1/0 to list only archived or unarchived products","disabled":true},{"key":"sort_attr","value":"updated_at","description":"optional (id | ean | sku | stock | stocking_date | supplier_id | updated_at | archived)"},{"key":"sort_dir","value":"DESC","description":"optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"products_count\": 5,\n \"products\": [\n {\n \"id\": 25851,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"stock\": 84,\n \"stocking_date\": \"2026-05-12 09:00:00\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"img_url\": \"https://cdn.upwind.example.com/products/kitesurf-bar-pro-52.jpg\",\n \"x_size\": 60.0,\n \"y_size\": 12.0,\n \"z_size\": 8.0,\n \"price\": 299.95,\n \"weight\": 1.8,\n \"product_reference\": \"UPW-REF-001\",\n \"supplier_id\": 42,\n \"is_bundle_product\": 0,\n \"is_flagged\": 1,\n \"archived\": 0,\n \"updated_at\": \"2026-06-12 14:32:18\",\n \"sold_per_day\": 1.4,\n \"purchase_price\": 145.0,\n \"minimal_supplier_order_quantity\": 10,\n \"replenishment_time\": 21,\n \"stock_advice_iron_stock\": 30,\n \"units_per_box\": 1,\n \"total_lvb_stock\": 0,\n \"total_fba_stock\": 0,\n \"require_serial_number\": 0,\n \"tags\": [\n \"kitesurf\",\n \"control-bar\",\n \"watersports\"\n ],\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\",\n \"child_products\": [],\n \"available_stock\": 84,\n \"total_fbc_stock\": 12\n },\n {\n \"id\": 25852,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"stock\": 42,\n \"stocking_date\": \"2026-04-28 11:15:00\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"img_url\": \"https://cdn.upwind.example.com/products/wetsuit-predator-5-4-m.jpg\",\n \"x_size\": 35.0,\n \"y_size\": 25.0,\n \"z_size\": 6.0,\n \"price\": 189.95,\n \"weight\": 1.4,\n \"product_reference\": \"UPW-REF-002\",\n \"supplier_id\": 7,\n \"is_bundle_product\": 0,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"updated_at\": \"2026-06-10 08:21:44\",\n \"sold_per_day\": 0.8,\n \"purchase_price\": 92.0,\n \"minimal_supplier_order_quantity\": 5,\n \"replenishment_time\": 30,\n \"stock_advice_iron_stock\": 15,\n \"units_per_box\": 1,\n \"total_lvb_stock\": 0,\n \"total_fba_stock\": 0,\n \"require_serial_number\": 0,\n \"tags\": [\n \"wetsuit\",\n \"neoprene\",\n \"watersports\"\n ],\n \"country_of_origin\": \"TH\",\n \"product_classification\": \"6110309100\",\n \"child_products\": [],\n \"available_stock\": 42,\n \"total_fbc_stock\": 8\n },\n {\n \"id\": 25853,\n \"ean\": \"8719326583655\",\n \"sku\": \"UPW-BRD-134\",\n \"stock\": 16,\n \"stocking_date\": \"2026-05-02 16:40:00\",\n \"title\": \"Kiteboard Surge 134cm\",\n \"img_url\": \"https://cdn.upwind.example.com/products/kiteboard-surge-134.jpg\",\n \"x_size\": 134.0,\n \"y_size\": 41.0,\n \"z_size\": 4.0,\n \"price\": 549.0,\n \"weight\": 2.6,\n \"product_reference\": \"UPW-REF-003\",\n \"supplier_id\": 42,\n \"is_bundle_product\": 0,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"updated_at\": \"2026-06-08 12:05:31\",\n \"sold_per_day\": 0.3,\n \"purchase_price\": 280.0,\n \"minimal_supplier_order_quantity\": 4,\n \"replenishment_time\": 28,\n \"stock_advice_iron_stock\": 8,\n \"units_per_box\": 1,\n \"total_lvb_stock\": 0,\n \"total_fba_stock\": 0,\n \"require_serial_number\": 1,\n \"tags\": [\n \"kiteboard\",\n \"twintip\",\n \"watersports\"\n ],\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\",\n \"child_products\": [],\n \"available_stock\": 16,\n \"total_fbc_stock\": 2\n },\n {\n \"id\": 25854,\n \"ean\": \"8719326583662\",\n \"sku\": \"UPW-FIN-G10\",\n \"stock\": 240,\n \"stocking_date\": \"2026-03-18 10:22:00\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"img_url\": \"https://cdn.upwind.example.com/products/carbon-fin-set-g10.jpg\",\n \"x_size\": 14.0,\n \"y_size\": 8.0,\n \"z_size\": 3.0,\n \"price\": 79.95,\n \"weight\": 0.3,\n \"product_reference\": \"UPW-REF-004\",\n \"supplier_id\": 42,\n \"is_bundle_product\": 0,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"updated_at\": \"2026-06-13 09:14:02\",\n \"sold_per_day\": 2.1,\n \"purchase_price\": 32.0,\n \"minimal_supplier_order_quantity\": 25,\n \"replenishment_time\": 14,\n \"stock_advice_iron_stock\": 50,\n \"units_per_box\": 5,\n \"total_lvb_stock\": 0,\n \"total_fba_stock\": 0,\n \"require_serial_number\": 0,\n \"tags\": [\n \"accessories\",\n \"fins\"\n ],\n \"country_of_origin\": \"DE\",\n \"product_classification\": \"9506290000\",\n \"child_products\": [],\n \"available_stock\": 240,\n \"total_fbc_stock\": 0\n },\n {\n \"id\": 25855,\n \"ean\": \"8719326583679\",\n \"sku\": \"UPW-DRY-30L\",\n \"stock\": 156,\n \"stocking_date\": \"2026-05-20 13:45:00\",\n \"title\": \"Waterproof Dry Bag 30L Aqua\",\n \"img_url\": \"https://cdn.upwind.example.com/products/dry-bag-30l-aqua.jpg\",\n \"x_size\": 65.0,\n \"y_size\": 35.0,\n \"z_size\": 35.0,\n \"price\": 34.95,\n \"weight\": 0.6,\n \"product_reference\": \"UPW-REF-005\",\n \"supplier_id\": 13,\n \"is_bundle_product\": 1,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"updated_at\": \"2026-06-11 15:48:09\",\n \"sold_per_day\": 3.4,\n \"purchase_price\": 12.0,\n \"minimal_supplier_order_quantity\": 50,\n \"replenishment_time\": 10,\n \"stock_advice_iron_stock\": 100,\n \"units_per_box\": 10,\n \"total_lvb_stock\": 0,\n \"total_fba_stock\": 0,\n \"require_serial_number\": 0,\n \"tags\": [\n \"accessories\",\n \"dry-bag\"\n ],\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"4202929190\",\n \"child_products\": [\n {\n \"id\": 25855,\n \"title\": \"Waterproof Dry Bag 30L Aqua\",\n \"sku\": \"UPW-DRY-30L\",\n \"ean\": \"8719326583679\",\n \"weight\": 0.6,\n \"price\": 34.95,\n \"purchase_price\": 12.0,\n \"quantity\": 1,\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"4202929190\"\n },\n {\n \"id\": 25854,\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"sku\": \"UPW-FIN-G10\",\n \"ean\": \"8719326583662\",\n \"weight\": 0.3,\n \"price\": 79.95,\n \"purchase_price\": 32.0,\n \"quantity\": 1,\n \"country_of_origin\": \"DE\",\n \"product_classification\": \"9506290000\"\n }\n ],\n \"available_stock\": 156,\n \"total_fbc_stock\": 24\n }\n ]\n}"}],"_postman_id":"83b3768b-9088-40f9-8f36-1b98f81c0b54"},{"name":"Update a product","id":"bd411e98-31a9-4c20-80fa-cfe7c48457e2","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 25856,\n \"price\": 39.00,\n \"attributes\": {\n \"lenght\": \"4cm\",\n \"width\": \"5cm\"\n },\n \"pim_images\": {\n \"1\": \"https://media.s-bol.com/Y7YGgJ7rAKpp/550x817.jpg\",\n \"2\": \"https://media.s-bol.com/gpPy0RMrxAl3/550x550.jpg\",\n \"3\": \"https://media.s-bol.com/qQpvNm33Z8BG/500x840.jpg\"\n },\n \"description\": \"This is a fake product description!\",\n \"tags\": [\"kitesurf\", \"outlet\"],\n \"is_flagged\": true,\n \"archived\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/inventory","description":"Change stock level and product attributes by product_id. Or replace \"product_id\" for \"sku\" to update (multiple) products based on SKU value.
\nThe attributes and pim_images object is optional and only used for the PIM inside of ChannelDock.
\nProduct fields allowed to update:
\ncorrected_stock (also backwards-compatible via active_stock)
\ntitle
\nx_size
\ny_size
\nz_size
\nweight
\nimg_url
\nean
\nproduct_reference
\nprice
\npurchase_price
\npim_images (PIM module related)
\nattributes (PIM module related)
\ndescription (PIM module related)
\ntags (array of strings, optional). Unknown titles are automatically created (scoped to your seller account). Full replacement: any tags currently on the product that are not in this array are removed. Omit the tags field entirely to leave existing tags untouched; send \"tags\": [] to remove all tags from the product.
is_flagged (boolean, optional). Same product flag as in the portal product list (true/false or 1/0). Omit to leave the current flag unchanged.
archived (boolean, optional). Same archive setting as in the portal product list (true/false or 1/0). Omit to leave the current archive state unchanged.
Use this endpoint to update multiple products in a single request. Each product can be identified by either product_id or sku. You can update fields such as stock, price, archived, and optionally include attributes, pim_images, or a description for use within the ChannelDock PIM. Only the fields you provide will be updated—omitted fields remain unchanged. If both product_id and sku are present, product_id takes precedence. This endpoint is ideal for bulk updates across your catalog, including stock synchronization, price changes, and optional PIM enhancements.
\nLimit: Maximum 1000 products per request.
\n","urlObject":{"path":["portal","api","v2","seller","inventory"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"07164f21-7688-4dcd-8945-757c0e60c5d0","name":"Bulk update products","originalRequest":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"updates\": [\n {\n \"product_id\": 26482,\n \"price\": 39.00\n },\n {\n \"product_id\": 91827,\n \"price\": 24.95\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Processed 3 product updates\",\n \"updates\": [\n {\n \"product_id\": 25851,\n \"status\": \"success\",\n \"updated_fields\": {\n \"price\": \"299.95\"\n },\n \"updated_attributes\": {\n \"length\": \"60 cm\",\n \"width\": \"12 cm\"\n }\n },\n {\n \"product_id\": 25852,\n \"status\": \"success\",\n \"updated_fields\": {\n \"price\": \"189.95\"\n },\n \"updated_attributes\": {\n \"length\": \"35 cm\",\n \"width\": \"25 cm\"\n }\n },\n {\n \"product_id\": 25854,\n \"status\": \"success\",\n \"updated_fields\": {\n \"price\": \"79.95\"\n },\n \"updated_attributes\": {}\n }\n ]\n}"}],"_postman_id":"0a5cdf82-32d0-4cea-9145-1465bf5086ec"},{"name":"Create a product","id":"a033a3d4-aa05-4f74-873d-7977c66d7aed","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Upwind kitesurf bindingen\",\n \"img_url\": \"http://www.upwind.nl/images/upwind-bindingen\",\n \"ean\": \"87123456789\",\n \"sku\": \"upwind-sku\",\n \"product_reference\": \"upwind-product-reference\",\n \"x_size\": 10,\n \"y_size\": 20,\n \"z_size\": 20,\n \"weight\": 3,\n \"tags\": [\"kitesurf\", \"outlet\"],\n \"is_flagged\": true,\n \"archived\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/inventory","description":"This endpoint allows you to add products for a seller in the portal. The HTTP POST request should be sent to https://channeldock.com/portal/api/v2/seller/inventory.
title (string, required): The title of the product.
img_url (string, optional): The URL of the product image.
ean (string, required): The EAN (European Article Number) of the product.
sku (string, optional): The Stock Keeping Unit (SKU) of the product.
product_reference (string, optional): The reference code of the product.
x_size (float, optional): The size of the product in the x-direction in cm.
y_size (float, optional): The size of the product in the y-direction in cm.
z_size (float, optional): The size of the product in the z-direction in cm.
weight (float, optional): The weight of the product in kg's.
tags (array of strings, optional): Tag titles to assign to the product. Unknown titles are automatically created (scoped to your seller account). Omit this field entirely to leave tags untouched; send an empty array [] to remove all tags from the product.
is_flagged (boolean, optional): Same product flag as in the portal product list (true/false or 1/0). Defaults to not flagged when omitted.
archived (boolean, optional): Same archive setting as in the portal product list (true/false or 1/0). Defaults to not archived when omitted.
response (string): Indicates the status of the request, can be \"success\" or \"error\".message (string): A message providing information about the result of the request.product (object): Contains details of the newly created product, including its title, image URL, EAN, SKU, product reference, dimensions, weight, and (if tags was sent) the resulting tags array.{\n \"response\": \"success\",\n \"message\": \"Created new product ID: 39\",\n \"product\": {\n \"title\": \"Upwind kitesurf bindingen\",\n \"img_url\": \"http://www.upwind.nl/images/upwind-bindingen\",\n \"ean\": \"87123456789\",\n \"sku\": \"upwind-sku\",\n \"product_reference\": \"upwind-product-reference\",\n \"x_size\": 10,\n \"y_size\": 20,\n \"z_size\": 20,\n \"weight\": 3,\n \"tags\": [\"kitesurf\", \"outlet\"],\n \"is_flagged\": 1,\n \"archived\": 0\n }\n}\n\nThis endpoint allows you to delete a product for a seller. Send a DELETE request to https://channeldock.com/portal/api/v2/seller/inventory with the product_id in the request body.
product_id (integer, required): The ChannelDock product ID.response (string): Indicates the status of the request, can be \"success\" or \"error\".message (string): A message providing information about the result of the request.List bundle products for this seller, including child products and quantities.
\nOptional filters: product_id, ean, sku (parent product).
optional (parent product id)
\n","type":"text/plain"},"key":"product_id","value":"25860"},{"disabled":true,"description":{"content":"optional (parent EAN)
\n","type":"text/plain"},"key":"ean","value":"8719326583700"},{"disabled":true,"description":{"content":"optional (parent SKU)
\n","type":"text/plain"},"key":"sku","value":"UPW-BUNDLE-STARTER"}],"variable":[]}},"response":[{"id":"4ce316c2-84f1-4501-b002-451b017e1f45","name":"Get bundles","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/bundles","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","bundles"],"query":[{"key":"product_id","value":"25860","description":"optional (parent product id)","disabled":true},{"key":"ean","value":"8719326583700","description":"optional (parent EAN)","disabled":true},{"key":"sku","value":"UPW-BUNDLE-STARTER","description":"optional (parent SKU)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"bundles_count\": 1,\n \"bundles\": [\n {\n \"parent_product_id\": 25860,\n \"parent_ean\": \"8719326583700\",\n \"parent_sku\": \"UPW-BUNDLE-STARTER\",\n \"parent_title\": \"Upwind starter bundle\",\n \"stock\": 12,\n \"child_products\": [\n {\n \"bundle_row_id\": 901,\n \"child_product_id\": 25851,\n \"child_ean\": \"8719326583631\",\n \"child_sku\": \"UPW-BAR-52\",\n \"child_title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"quantity\": 1\n },\n {\n \"bundle_row_id\": 902,\n \"child_product_id\": 25856,\n \"child_ean\": \"87123456789\",\n \"child_sku\": \"UPW-HRN-COMP\",\n \"child_title\": \"Upwind Kitesurf Harness Comp\",\n \"quantity\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"b6a75889-74da-4063-af5c-27eeeb0fc22b"},{"name":"Create bundle","id":"6fa9b1d6-5b85-4f26-aec4-e7bb687435d0","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"parent_product_id\": 25860,\n \"children\": [\n { \"child_product_id\": 25851, \"quantity\": 1 },\n { \"child_product_id\": 25856, \"quantity\": 1 }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/bundles","description":"Create a bundle from an existing parent product and add children.
\nRequired JSON: parent_product_id, children (array of {child_product_id, quantity}). Quantity defaults to 1.
The parent must belong to this seller. If it is not already a bundle, available stock must be 0 and it must not be a child of another bundle. If it is already a bundle, children are added.
\nPartial child failures are returned in errors; successful links in added_children.
Add and/or remove children on an existing bundle.
\nRequired: parent_product_id. Optional: add_children (same shape as create), remove_children (array of child product ids).
Convert a bundle back to a regular product. Removes all children, sets stock to 0 (including center stock rows).
\nRequired JSON: parent_product_id.
Create and manage product bundles (a parent SKU made of one or more child products with quantities).
\nThe parent must exist as a catalog product. Converting a regular product to a bundle requires available stock 0. Bundle stock is derived from children.
\nEnable Bundles (GET, POST, PUT, DELETE) on your API key in ChannelDock settings.
\n","_postman_id":"4242d521-d54e-4d17-ba9b-e71092d6878f"},{"name":"Product tags","item":[{"name":"Get product tags","id":"42d6923d-1f38-4588-8c4e-1385bc5f3851","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/product-tags?page=1","description":"List product tags for this seller. Paginated: 50 per page, 1-based page (defaults to 1).
Optional: search or q (title contains), tag_id (returns that tag only, no pagination).
optional (default 1, 50 tags per page)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional (title contains; alias q)
\n","type":"text/plain"},"key":"search","value":"kitesurf"},{"disabled":true,"description":{"content":"optional (single tag)
\n","type":"text/plain"},"key":"tag_id","value":"12"}],"variable":[]}},"response":[{"id":"60ac02c5-973e-4ce3-9219-bd7b0481de0a","name":"Get product tags","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/product-tags?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","product-tags"],"query":[{"key":"page","value":"1","description":"optional (default 1, 50 tags per page)"},{"key":"search","value":"kitesurf","description":"optional (title contains; alias q)","disabled":true},{"key":"tag_id","value":"12","description":"optional (single tag)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"product_tags_count\": 2,\n \"total_matching\": 2,\n \"page\": 1,\n \"product_tags\": [\n { \"id\": 12, \"title\": \"kitesurf\", \"color\": \"#0066ff\", \"product_count\": 18 },\n { \"id\": 13, \"title\": \"outlet\", \"color\": \"#ff5500\", \"product_count\": 4 }\n ]\n}"}],"_postman_id":"42d6923d-1f38-4588-8c4e-1385bc5f3851"},{"name":"Create product tag","id":"36b3bc23-7411-44b4-a221-9ea22f51d1ed","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"title\": \"outlet\",\n \"color\": \"#ff5500\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/product-tags","description":"Create a product tag.
\nRequired: title. Optional: color as #rgb or #rrggbb (default #000). Title must be unique for this seller (case-insensitive).
Update a tag’s title and/or color.
\nRequired: tag_id (alias id). Optional: title, color.
Delete a tag and unlink it from all products.
\nRequired JSON: tag_id (alias id).
Attach a tag to one or more catalog products.
\nIdentify the tag with tag_id, or tag_title / title. Identify products with product_id, product_ids (max 500), ean, or sku.
Detach a tag from one or more catalog products.
\nSame identification fields as attach. HTTP POST or DELETE on /seller/product-tags/detach.
Manage product tags for the seller catalog (tags scoped to seller_id).
List/create/update/delete tags on /seller/product-tags. Attach or detach tags on products via /seller/product-tags/attach and /seller/product-tags/detach.
You can also assign tags by title on POST/PUT /seller/inventory (tags string array). Inventory GET accepts tag_id or tag_title filters.
Enable Product Tags, Product Tags Attach, and Product Tags Detach on your API key.
\n","_postman_id":"a11e4906-3d32-4529-a3ae-1588aab2568a"},{"name":"Channels","item":[{"name":"Get connected channels","id":"6a2dfea2-f7e9-4b51-ada7-3c1b2abb601c","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/channels","description":"List this seller’s connected integrations. Optional query: api_id, type (sales, fulfillment, …), channel (name or ref; also accepts search).
Returns up to 50 connections. pim_listing_supported is true when the connection is a sales channel that can host a PIM listing. Use api_id together with marketplace_id from GET /seller/pim/marketplaces on POST /seller/listings.
Does not require pim_module. Channel credentials / extra settings are not returned on this endpoint.
optional (sales, fulfillment, …)
\n","type":"text/plain"},"key":"type","value":"sales"},{"disabled":true,"description":{"content":"optional (channel name or ref)
\n","type":"text/plain"},"key":"channel","value":"kaufland"},{"disabled":true,"description":{"content":"optional (single connection)
\n","type":"text/plain"},"key":"api_id","value":"42"}],"variable":[]}},"response":[{"id":"de073a91-c94a-4dd8-bdce-3d0f19b168a3","name":"Get connected channels","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/channels","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","channels"],"query":[{"key":"type","value":"sales","description":"optional (sales, fulfillment, …)","disabled":true},{"key":"channel","value":"kaufland","description":"optional (channel name or ref)","disabled":true},{"key":"api_id","value":"42","description":"optional (single connection)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"count\": 2,\n \"channels\": [\n {\n \"id\": 42,\n \"api_id\": 42,\n \"description\": \"Bol.com NL\",\n \"type\": \"sales\",\n \"status\": \"active\",\n \"channel\": \"Bol.com\",\n \"channel_ref\": \"bolcom\",\n \"marketplace_id\": 5,\n \"pim_listing_supported\": true,\n \"import_orders\": 1,\n \"seller_id\": 1184,\n \"portal_url\": \"/portal/public/mychannels\"\n },\n {\n \"id\": 88,\n \"api_id\": 88,\n \"description\": \"Amazon.nl\",\n \"type\": \"sales\",\n \"status\": \"active\",\n \"channel\": \"Amazon\",\n \"channel_ref\": \"amazon\",\n \"marketplace_id\": 2,\n \"pim_listing_supported\": true,\n \"import_orders\": 1,\n \"seller_id\": 1184,\n \"portal_url\": \"/portal/public/mychannels\"\n }\n ],\n \"hint\": \"Use api_id + marketplace_id on POST /seller/listings when pim_listing_supported is true. If the named shop is missing, the seller must connect it under My Channels.\",\n \"portal_url\": \"/portal/public/mychannels\"\n}"}],"_postman_id":"6a2dfea2-f7e9-4b51-ada7-3c1b2abb601c"}],"id":"f7f57675-1256-4c34-b329-9541e5ae1543","description":"List connected sales-channel integrations for the seller account (GET /seller/channels).
Does not require pim_module. Use this to confirm a shop is connected before creating PIM listings. For listing create you still need the marketplace_id + api_id pair from GET /seller/pim/marketplaces.
Enable Connected channels (GET) on your API key in ChannelDock settings.
\n","_postman_id":"f7f57675-1256-4c34-b329-9541e5ae1543"},{"name":"PIM listings","item":[{"name":"Get PIM marketplaces","id":"a124051b-4d66-4426-a944-6a67f402bf02","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/pim/marketplaces","description":"List connected sales-channel APIs that can host a listing, plus a synthetic ChannelDock source row (marketplace_id: 0, api_id: 0).
Use the returned marketplace_id + api_id pair on POST /seller/listings. Language / Mirakl shop differences can map one channel to different marketplace ids — always take the pair from this endpoint.
Search leaf marketplace categories. Only leaf ids can be sent as marketplace_category_id on PUT /seller/listings.
marketplace_id is required and must be a channel marketplace (not 0). Omit q to get a sample of up to 50 leaf categories; pass q to search title / translated title.
required — channel marketplace id from GET /seller/pim/marketplaces
\n","type":"text/plain"},"key":"marketplace_id","value":"5"},{"description":{"content":"optional search string
\n","type":"text/plain"},"key":"q","value":"kitesurf"}],"variable":[]}},"response":[{"id":"cbb57906-e89c-462b-bdec-287bf1789545","name":"Get PIM categories","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/pim/categories?marketplace_id=5&q=kitesurf","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","pim","categories"],"query":[{"key":"marketplace_id","value":"5","description":"required — channel marketplace id from GET /seller/pim/marketplaces"},{"key":"q","value":"kitesurf","description":"optional search string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"categories\": [\n {\n \"id\": 18420,\n \"label\": \"Sport & outdoor → Watersport → Kitesurfen\"\n },\n {\n \"id\": 18421,\n \"label\": \"Sport & outdoor → Watersport → Kitesurfaccessoires\"\n }\n ]\n}"}],"_postman_id":"17864aa9-6fdb-4170-b05b-37d62c0942c3"},{"name":"Get PIM browse nodes","id":"2110a009-c8c6-4596-825e-3af534d1af83","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/pim/browse-nodes?marketplace_id=2&q=electronics","description":"Search Amazon (and similar) browse nodes for a marketplace. Optional marketplace_category_id narrows results to nodes linked to that category.
required — Amazon marketplace id
\n","type":"text/plain"},"key":"marketplace_id","value":"2"},{"description":{"content":"optional search string
\n","type":"text/plain"},"key":"q","value":"electronics"},{"disabled":true,"description":{"content":"optional — restrict to one category
\n","type":"text/plain"},"key":"marketplace_category_id","value":"10"}],"variable":[]}},"response":[{"id":"1db6bad4-640d-4d54-996a-9dec1336016a","name":"Get PIM browse nodes","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/pim/browse-nodes?marketplace_id=2&q=electronics","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","pim","browse-nodes"],"query":[{"key":"marketplace_id","value":"2","description":"required — Amazon marketplace id"},{"key":"q","value":"electronics","description":"optional search string"},{"key":"marketplace_category_id","value":"10","description":"optional — restrict to one category","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"browse_nodes\": [\n {\n \"id\": 3310,\n \"marketplace_category_id\": 10,\n \"label\": \"Kitesurfing (Sports → Water Sports → Kitesurfing)\"\n }\n ]\n}"}],"_postman_id":"2110a009-c8c6-4596-825e-3af534d1af83"},{"name":"Get PIM brands","id":"1c41e2de-b363-4400-8c8a-2c554c9ac66c","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/pim/brands?marketplace_id=5&q=upwind","description":"Search marketplace brands (Otto / Octopia and similar). marketplace_id is required. Prefix-match on q; omit q for a random sample of up to 50 brands.
required
\n","type":"text/plain"},"key":"marketplace_id","value":"5"},{"description":{"content":"optional prefix search
\n","type":"text/plain"},"key":"q","value":"upwind"}],"variable":[]}},"response":[{"id":"ef0b7a05-f0b0-44c5-9457-df9427be349d","name":"Get PIM brands","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/pim/brands?marketplace_id=5&q=upwind","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","pim","brands"],"query":[{"key":"marketplace_id","value":"5","description":"required"},{"key":"q","value":"upwind","description":"optional prefix search"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"brands\": [\n {\n \"id\": 712,\n \"label\": \"Upwind\"\n }\n ]\n}"}],"_postman_id":"1c41e2de-b363-4400-8c8a-2c554c9ac66c"},{"name":"Get PIM asset types","id":"cd0cfdc2-0e7c-45c8-9ba1-42ef6d926d23","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/pim/asset-types?marketplace_id=5","description":"List image / asset slots for a marketplace. Use marketplace_id=0 for native ChannelDock slots (main_asset_id). Channel listings use marketplace_asset_id.
required — use 0 for native ChannelDock slots
\n","type":"text/plain"},"key":"marketplace_id","value":"5"}],"variable":[]}},"response":[{"id":"8456b412-c6c2-4fce-a8ee-c27cc925d6b7","name":"Get PIM asset types","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/pim/asset-types?marketplace_id=5","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","pim","asset-types"],"query":[{"key":"marketplace_id","value":"5","description":"required — use 0 for native ChannelDock slots"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"asset_types\": [\n {\n \"marketplace_asset_id\": 12,\n \"main_asset_id\": 0,\n \"title\": \"Main image\",\n \"reference\": \"FRONT\"\n },\n {\n \"marketplace_asset_id\": 13,\n \"main_asset_id\": 0,\n \"title\": \"Extra image 1\",\n \"reference\": \"IMAGE1\"\n }\n ]\n}"}],"_postman_id":"cd0cfdc2-0e7c-45c8-9ba1-42ef6d926d23"},{"name":"Get PIM attribute schema","id":"1a144d27-77ac-4493-a9a1-0b5c8e592726","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/pim/attribute-schema?marketplace_id=5&marketplace_category_id=18420","description":"Attribute definitions for a marketplace leaf category. Assign the category with PUT /seller/listings first, then use marketplace_attribute_id values here on POST /seller/listings/attributes.
required
\n","type":"text/plain"},"key":"marketplace_id","value":"5"},{"description":{"content":"required — leaf category id
\n","type":"text/plain"},"key":"marketplace_category_id","value":"18420"}],"variable":[]}},"response":[{"id":"cbd5dce4-3d6c-442c-b2bf-06af3fcc8bfa","name":"Get PIM attribute schema","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/pim/attribute-schema?marketplace_id=5&marketplace_category_id=18420","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","pim","attribute-schema"],"query":[{"key":"marketplace_id","value":"5","description":"required"},{"key":"marketplace_category_id","value":"18420","description":"required — leaf category id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attributes\": [\n {\n \"marketplace_attribute_id\": 881,\n \"reference\": \"Colour\",\n \"title\": \"Kleur\",\n \"type\": \"select\",\n \"required\": true,\n \"multi_value\": false,\n \"free_value\": false,\n \"available_values\": [\n \"Zwart\",\n \"Wit\",\n \"Blauw\"\n ],\n \"available_units\": [],\n \"available_types\": [],\n \"requirement_conditions\": []\n }\n ]\n}"}],"_postman_id":"1a144d27-77ac-4493-a9a1-0b5c8e592726"},{"name":"Get listings","id":"84f0ad5c-77d5-48c3-aa1d-1d354ae2ee09","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/listings?page=1","description":"List marketplace listings for the seller. Results are paginated (50 per page). page is required and 1-based.
Optional include is a comma-separated list: assets, attributes, validation.
required, 1-based, 50 listings per page
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional — filter by listing id
\n","type":"text/plain"},"key":"listing_id","value":"90001"},{"disabled":true,"description":{"content":"optional — filter by master product id
\n","type":"text/plain"},"key":"product_id","value":"453386"},{"disabled":true,"description":{"content":"optional — filter by product EAN
\n","type":"text/plain"},"key":"ean","value":"8719326583631"},{"disabled":true,"description":{"content":"optional — filter by product SKU
\n","type":"text/plain"},"key":"sku","value":"1001001"},{"disabled":true,"description":{"content":"optional — use 0 for the source listing
\n","type":"text/plain"},"key":"marketplace_id","value":"5"},{"disabled":true,"description":{"content":"optional — filter by API connection
\n","type":"text/plain"},"key":"api_id","value":"42"},{"disabled":true,"description":{"content":"optional — filter by listing status
\n","type":"text/plain"},"key":"status","value":"inactive"},{"disabled":true,"description":{"content":"optional — assets, attributes, validation
\n","type":"text/plain"},"key":"include","value":"assets,attributes"}],"variable":[]}},"response":[{"id":"408a2b69-dde6-4e14-ae01-23837680b360","name":"Get listings","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/listings?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","listings"],"query":[{"key":"page","value":"1","description":"required, 1-based, 50 listings per page"},{"key":"listing_id","value":"90001","description":"optional — filter by listing id","disabled":true},{"key":"product_id","value":"453386","description":"optional — filter by master product id","disabled":true},{"key":"ean","value":"8719326583631","description":"optional — filter by product EAN","disabled":true},{"key":"sku","value":"1001001","description":"optional — filter by product SKU","disabled":true},{"key":"marketplace_id","value":"5","description":"optional — use 0 for the source listing","disabled":true},{"key":"api_id","value":"42","description":"optional — filter by API connection","disabled":true},{"key":"status","value":"inactive","description":"optional — filter by listing status","disabled":true},{"key":"include","value":"assets,attributes","description":"optional — assets, attributes, validation","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"listings_count\": 2,\n \"page\": 1,\n \"listings\": [\n {\n \"id\": 90000,\n \"product_id\": 453386,\n \"ean\": \"8719326583631\",\n \"sku\": \"1001001\",\n \"marketplace_id\": 0,\n \"marketplace_name\": \"ChannelDock\",\n \"api_id\": 0,\n \"title\": \"Upwind kitesurf bindingen\",\n \"description\": \"High-performance kitesurf bindings.\",\n \"marketplace_category_id\": 0,\n \"category\": null,\n \"marketplace_browse_node_id\": 0,\n \"marketplace_brand_id\": 0,\n \"price\": null,\n \"currency\": \"EUR\",\n \"status\": \"inactive\",\n \"active\": false,\n \"content_percentage\": 72,\n \"listing_score\": 68,\n \"error_attributes_json\": null\n },\n {\n \"id\": 90001,\n \"product_id\": 453386,\n \"ean\": \"8719326583631\",\n \"sku\": \"1001001\",\n \"marketplace_id\": 5,\n \"marketplace_name\": \"Bol.com NL\",\n \"api_id\": 42,\n \"title\": \"Upwind kitesurf bindingen\",\n \"description\": \"High-performance kitesurf bindings.\",\n \"marketplace_category_id\": 18420,\n \"category\": {\n \"id\": 18420,\n \"label\": \"Sport & outdoor → Watersport → Kitesurfen\"\n },\n \"marketplace_browse_node_id\": 0,\n \"marketplace_brand_id\": 0,\n \"price\": \"129.95\",\n \"currency\": \"EUR\",\n \"status\": \"inactive\",\n \"active\": false,\n \"content_percentage\": 72,\n \"listing_score\": 68,\n \"error_attributes_json\": null\n }\n ]\n}"}],"_postman_id":"84f0ad5c-77d5-48c3-aa1d-1d354ae2ee09"},{"name":"Create listing","id":"73923148-c949-42a2-8541-e4b1d380e253","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"ean\": \"8719326583631\",\n \"marketplace_id\": 5,\n \"api_id\": 42,\n \"copy_from_source\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings","description":"Create a listing for an existing master product. Identify the product with product_id, ean, or sku.
marketplace_id (required): 0 for the ChannelDock source listing, or a channel id from GET /seller/pim/marketplaces.api_id (required when marketplace_id > 0): sales-channel connection that matches that marketplace.copy_from_source (optional, default true): copies mapped native assets/attributes/category onto a new channel listing. When fetch_from_channel is true, copy only runs if the channel fetch fails (same as the PIM UI).fetch_from_channel (optional, default false, alias fetch_marketplace_content): download the live listing after create. Not allowed on marketplace_id = 0.marketplace_fetch_identifier (optional, alias fetch_identifier): Bol and most channels use an 8–14 digit EAN. Amazon accepts a 10-character ASIN or an EAN. Omit to use the master product EAN.A failed fetch does not roll back the listing; fetch_error / fetch_error_code explain why. Create does not run AI title/description optimization.
Same as Create listing, with fetch_from_channel: true. ChannelDock downloads title, description, assets, attributes, and category from the live sales channel after the row is created (same as the PIM “fetch marketplace data” checkbox).
On success the listing is returned even if fetch fails (fetched: false plus fetch_error). When fetch fails and copy_from_source is true, mapped native content is copied as a fallback.
Update listing content. Body must include listing_id plus at least one of: title, description, price, marketplace_category_id (leaf only; 0 clears), marketplace_browse_node_id, marketplace_brand_id.
Channel listings are marked changed on content updates. If validation fails after the save, the response is error_code: validation_failed with an errors string array (and the updated listing is still returned).
Delete a listing and its assets/attributes. Body: {\"listing_id\": 123, \"force\": false}.
Deleting the native source listing (marketplace_id = 0) is blocked while channel listings still exist, unless force is true.
List image / file assets attached to a listing.
\n","urlObject":{"path":["portal","api","v2","seller","listings","assets"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"listing_id","value":"90001"}],"variable":[]}},"response":[{"id":"ea57a986-64cd-4ef3-b825-413eef980a95","name":"Get listing assets","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/listings/assets?listing_id=90001","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","listings","assets"],"query":[{"key":"listing_id","value":"90001","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"assets\": [\n {\n \"id\": 501,\n \"file_url\": \"https://channeldock-assets.s3.eu-central-1.amazonaws.com/453386/main.jpg\",\n \"file_name\": \"main.jpg\",\n \"file_type\": \"image/jpeg\",\n \"marketplace_asset_id\": 12,\n \"main_asset_id\": 0\n }\n ]\n}"}],"_postman_id":"b127c32a-712f-499b-abd3-076fbc43f397"},{"name":"Add listing asset","id":"9531e13f-471b-4b24-bc5b-1f9ee9e097f7","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"listing_id\": 90001,\n \"url\": \"https://cdn.example.com/products/main.jpg\",\n \"marketplace_asset_id\": 12\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/assets","description":"Upload an asset onto a listing. Send listing_id plus either:
url — ChannelDock downloads the remote file, orbase64_content + filename — inline uploadOptional marketplace_asset_id (channel listings) or main_asset_id (native listings) sets the slot type. Get ids from GET /seller/pim/asset-types.
Change the slot type of an existing asset. Body: asset_id plus marketplace_asset_id (channel) or main_asset_id (native).
Remove an asset from a listing and delete the stored file.
\n","urlObject":{"path":["portal","api","v2","seller","listings","assets"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"58c23338-72dd-4cd6-bf24-f6028d58476a","name":"Delete listing asset","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"asset_id\": 501\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/assets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"asset_id\": 501\n}"}],"_postman_id":"e13bcb97-b570-46a9-879f-53da3d161e69"},{"name":"Get listing attributes","id":"d22d2559-b621-48bd-ac29-66b1bd00f326","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/listings/attributes?listing_id=90001","description":"List attribute rows on a listing (channel attributes and native main attributes).
\n","urlObject":{"path":["portal","api","v2","seller","listings","attributes"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"listing_id","value":"90001"}],"variable":[]}},"response":[{"id":"c1dc287b-c3d9-466b-8c4a-69d4b0ccab02","name":"Get listing attributes","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/listings/attributes?listing_id=90001","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","listings","attributes"],"query":[{"key":"listing_id","value":"90001","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attributes\": [\n {\n \"id\": 55,\n \"title\": \"Kleur\",\n \"marketplace_attribute_id\": 881,\n \"value\": \"Zwart\",\n \"unit\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"d22d2559-b621-48bd-ac29-66b1bd00f326"},{"name":"Add listing attribute","id":"856b427f-8616-4332-befa-37174efeaba2","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"listing_id\": 90001,\n \"marketplace_attribute_id\": 881,\n \"value\": \"Zwart\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/attributes","description":"Add an attribute value to a listing.
\nlisting_id + marketplace_attribute_id + value (ids from GET /seller/pim/attribute-schema). Optional unit / type.listing_id + title + value.JSON arrays are accepted for multi-value attributes.
\n","urlObject":{"path":["portal","api","v2","seller","listings","attributes"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"428d9697-fef6-480d-960d-dcbc0429cd65","name":"Add channel attribute","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"listing_id\": 90001,\n \"marketplace_attribute_id\": 881,\n \"value\": \"Zwart\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attribute\": {\n \"id\": 55,\n \"title\": \"Kleur\",\n \"marketplace_attribute_id\": 881,\n \"value\": \"Zwart\",\n \"unit\": \"\",\n \"type\": \"\"\n }\n}"},{"id":"35ca2d83-54d4-43b9-96df-0fbba5de049f","name":"Add native attribute","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"listing_id\": 90000,\n \"title\": \"Color\",\n \"value\": \"Black\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attribute\": {\n \"id\": 56,\n \"title\": \"Color\",\n \"marketplace_attribute_id\": 0,\n \"value\": \"Black\",\n \"unit\": \"\",\n \"type\": \"\"\n }\n}"}],"_postman_id":"856b427f-8616-4332-befa-37174efeaba2"},{"name":"Update listing attribute","id":"30ea724c-fa59-4007-8a2b-5c199c6d0abb","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": 55,\n \"value\": \"Blauw\",\n \"unit\": \"\",\n \"type\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/listings/attributes","description":"Update an attribute row by its id (from GET attributes). Optional unit and type. An empty value deletes the row and returns {\"deleted\": true}.
Delete an attribute row by its id.
Run channel validation (category, title, description, assets, attributes) without publishing. Native listings (marketplace_id = 0) are skipped (skipped: true).
Failures return HTTP 200 with error_code: validation_failed and an errors string array (never HTML).
Publish or unpublish a channel listing. Body: {\"listing_id\": 123, \"active\": true}.
When active is true: validates, sets the listing active, and pushes content to the connected sales channel (Bol, Amazon, Shopify, WooCommerce, eBay, Kaufland, Otto, Mirakl, Octopia, …). When active is false: unpublishes (active = 0) without calling the channel.
Native listings cannot be published (error_code: native_listing_cannot_publish).
Set active: false to unpublish. ChannelDock clears the local active flag and does not call the sales channel.
Re-download listing content from the connected sales channel into an existing listing. Same action as the PIM “Download content from marketplace” button.
\nOptional marketplace_fetch_identifier (alias fetch_identifier) overrides the product EAN / Amazon ASIN. Success returns the listing with assets and attributes included.
Failures use error_code: channel_fetch_failed (offer missing, bad credentials, identifier mismatch) or channel_fetch_unsupported. Native listings return native_listing_cannot_fetch.
Create and manage PIM marketplace listings (marketplace_products). Requires pim_module on the seller account. Without it, every endpoint in this folder returns HTTP 403 with error_code: pim_module_disabled.
The ChannelDock source listing uses marketplace_id = 0 and api_id = 0. Channel listings need a connected sales api_id from GET /seller/pim/marketplaces.
Typical flow:
\nPOST /seller/inventory — create the master product (EAN + title)GET /seller/channels (optional) — confirm the shop is connected, then GET /seller/pim/marketplaces — pick marketplace_id + api_idPOST /seller/listings — create the channel listing. Set fetch_from_channel: true to download title, description, assets, attributes, and category from the live sales channel (same as the PIM “fetch marketplace data” checkbox). Optional marketplace_fetch_identifier overrides the EAN, or an Amazon ASIN.GET /seller/pim/categories → PUT /seller/listings with a leaf category (and browse node / brand if required)GET /seller/pim/attribute-schema → POST / PUT /seller/listings/attributesPOST /seller/listings/assets + PUT asset types from GET /seller/pim/asset-typesPOST /seller/listings/validate → fix errors → POST /seller/listings/publish with {\"active\": true}Error bodies always include response: \"error\", a machine-readable error_code, a message, and usually a hint plus the relevant ids. Validation failures use error_code: \"validation_failed\" and an errors string array (never HTML). Listing create does not run AI title/description optimization.
Grant API key permissions for each endpoint in Settings → API (Connected channels, PIM Listings, assets, attributes, validate, publish, fetch, PIM lookups, and PIM Variant Groups).
\n","_postman_id":"d64761a4-536b-4c0b-84f4-3b6f1a0f4b39"},{"name":"PIM variant groups","item":[{"name":"Get variant groups","id":"77690674-82cc-4da7-8633-bf3c314498e2","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/variant-groups?page=1","description":"List variant groups (50 per page). page defaults to 1.
Optional: variant_group_id; or product_id / ean / sku to load the group for that product; search matches family name.
optional (default 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"variant_group_id","value":"44"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"product_id","value":"25852"},{"disabled":true,"description":{"content":"optional (family name)
\n","type":"text/plain"},"key":"search","value":"Wetsuit"}],"variable":[]}},"response":[{"id":"bcf1424a-30f0-457f-a870-b4485775b090","name":"Get variant groups","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/variant-groups?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","variant-groups"],"query":[{"key":"page","value":"1","description":"optional (default 1)"},{"key":"variant_group_id","value":"44","description":"optional","disabled":true},{"key":"product_id","value":"25852","description":"optional","disabled":true},{"key":"search","value":"Wetsuit","description":"optional (family name)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"variant_groups_count\": 1,\n \"page\": 1,\n \"variant_groups\": [\n {\n \"id\": 44,\n \"variant_group_id\": 44,\n \"name\": \"Wetsuit_Predator_5/4\",\n \"parent_product_id\": 25852,\n \"parent_product\": {\n \"id\": 25852,\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"img_url\": \"https://cdn.upwind.example.com/products/wetsuit-predator-5-4-m.jpg\"\n },\n \"member_count\": 2,\n \"members\": [\n {\n \"id\": 25852,\n \"product_id\": 25852,\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"img_url\": \"https://cdn.upwind.example.com/products/wetsuit-predator-5-4-m.jpg\",\n \"is_parent\": true\n },\n {\n \"id\": 25853,\n \"product_id\": 25853,\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size L\",\n \"ean\": \"8719326583655\",\n \"sku\": \"UPW-WET-L\",\n \"img_url\": \"https://cdn.upwind.example.com/products/wetsuit-predator-5-4-l.jpg\",\n \"is_parent\": false\n }\n ],\n \"variant_attributes\": [\n { \"id\": 8, \"title\": \"Size\" }\n ],\n \"portal_url\": \"/portal/public/pim/content?getProduct=25852\"\n }\n ]\n}"}],"_postman_id":"77690674-82cc-4da7-8633-bf3c314498e2"},{"name":"Create variant group","id":"876279c8-8450-40ab-a8d5-341cf89bc25b","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Wetsuit Predator 5/4\",\n \"product_ids\": [25852, 25853],\n \"parent_product_id\": 25852,\n \"variant_attribute_ids\": [8]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/variant-groups","description":"Create a variant group.
\nRequired: name (aliases variant_group_name, product_family_reference) and at least two members via product_ids (aliases variant_ids, members) or eans / skus.
Optional: parent_product_id / parent_ean / parent_sku (defaults to the first member). Optional variant_attribute_ids from GET /seller/variant-groups/attributes.
Replace members, name, parent, and variant attributes of a group.
\nRequired: variant_group_id (alias id). Sending an empty product_ids list deletes the group.
Delete a variant group and unlink all members.
\nRequired: variant_group_id, or a product_id / ean / sku that belongs to the group.
Remove one catalog product from its variant group.
\nIdentify the product with product_id, ean, or sku. HTTP POST or DELETE on /seller/variant-groups/unlink.
If fewer than two products would remain, the group is deleted and the last member is unlinked too.
\n","urlObject":{"path":["portal","api","v2","seller","variant-groups","unlink"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"8af157d0-fc62-4332-b600-2c280d0ab7f0","name":"Unlink product from variant group","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 25853\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/variant-groups/unlink"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"unlinked\": true,\n \"group_deleted\": false,\n \"product_id\": 25853,\n \"variant_group_id\": 44,\n \"removed_group_name\": \"Wetsuit_Predator_5/4\"\n}"}],"_postman_id":"5cab8c0b-5d12-493b-a33c-4afa63050449"},{"name":"Get variant attributes","id":"e30dd30c-5436-45d6-a30d-f295757ab27b","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/variant-groups/attributes?q=size","description":"Search native PIM attributes (MainAttributes) to use as variant axes (colour, size, …).
Optional q or search. Returns up to 25 rows. Pass the ids as variant_attribute_ids on create/update group.
optional (title contains; alias search)
\n","type":"text/plain"},"key":"q","value":"size"}],"variable":[]}},"response":[{"id":"868ffe8d-9bdc-4d7d-880d-a9e241c857ba","name":"Get variant attributes","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/variant-groups/attributes?q=size","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","variant-groups","attributes"],"query":[{"key":"q","value":"size","description":"optional (title contains; alias search)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"count\": 1,\n \"variant_attributes\": [\n { \"id\": 8, \"title\": \"Size\" }\n ],\n \"hint\": \"Pass these ids as variant_attribute_ids on POST/PUT /seller/variant-groups (axes such as colour or size).\"\n}"}],"_postman_id":"e30dd30c-5436-45d6-a30d-f295757ab27b"}],"id":"dc89bfc1-de14-4a61-b82e-9fbe65233863","description":"Group catalog products that are the same family (colour / size SKUs) for PIM content.
\nRequires pim_module. Without it these endpoints return HTTP 403 with error_code: pim_module_disabled.
A group needs a name and at least two catalog products. Spaces in name are stored as underscores. Lookup variant axes with GET /seller/variant-groups/attributes.
Enable PIM Variant Groups, PIM Variant Unlink, and PIM Variant Attributes on your API key.
\n","_postman_id":"dc89bfc1-de14-4a61-b82e-9fbe65233863"},{"name":"Orders","item":[{"name":"Get Orders","id":"022109df-1ee0-4733-aa11-a743cc098557","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/orders?page=1","description":"Retrieve paginated orders for the authenticated seller, including order lines, bundle child items, product tags, optional raw channel payload, and optional traceability data.
\nThis endpoint only returns orders belonging to the current seller (seller_id is taken from the authenticated context).
\npage (required, integer)
\n1-based page number.
\nIf omitted, the API responds with 400 and \"No page specified.\".
\npage_size (optional, integer)
\nNumber of orders per page.
\nMust be between 1 and 100.
\nIf omitted, the API uses its internal default page size.
\nAll filters are optional unless stated otherwise.
\nchannel_id (optional, string; supports comma-separated list)
\nExample: channel_id=1,2,5
\nValues are sanitized, split on commas and cast to integers.
\nMaximum of 50 IDs; more will return 400 with \"Maximum 50 channel IDs allowed\".
\nFilters orders where channel_id is in the provided list.
\napi_id (optional, string; supports comma-separated list)
\nExample: api_id=1001,1002,2000
\nValues are sanitized, split on commas and cast to integers.
\nEmpty values are removed; 0 is allowed.
\nMaximum of 50 IDs; more will return 400 with \"Maximum 50 API IDs allowed\".
\nFilters orders where api_id is in the provided list.
\nid (optional, integer)
\nChannelDock Order ID.
\norder_id (optional, string)
\nRemote channel order ID.
\nseq_order_id (optional, string / int)
\nSequential order ID within ChannelDock.
\nseq_order_id_is_not (optional, string / int)
\nExcludes orders with this seq_order_id.
\nprice_total (optional, numeric/string)
\nExact match on price_total.
\nEach of these filters does an exact match:
\nshipping_first_name
\nshipping_last_name
\nshipping_company
\nshipping_street
\nshipping_house_number
\nshipping_house_number_ext
\nshipping_region
\nshipping_country_code
\nshipping_city
\nshipping_email
\norder_date (optional, date Y-m-d)
\nExact date match on order_date (date only).
\nstart_date (optional, date or datetime)
\nFilters order_date >= start_date.
\nend_date (optional, date or datetime)
\nFilters order_date <= end_date.
\nIf passed as date only (Y-m-d), it is treated as Y-m-d 23:59:59.
\nship_on_date (optional, date or datetime)
\nExact match on ship_on_date.
\nship_on_date_from (optional, date or datetime)
\nFilters ship_on_date >= ship_on_date_from.
\nIf passed as date only (Y-m-d), it is treated as Y-m-d 00:00:00.
\nship_on_date_to (optional, date or datetime)
\nFilters ship_on_date <= ship_on_date_to.
\nIf passed as date only (Y-m-d), it is treated as Y-m-d 23:59:59.
\nYou can filter orders by their last update timestamp:
\nupdated_at (optional, date Y-m-d)
\nExact date match on updated_at (date only).
\nupdated_at_from (optional, date or datetime)
\nFilters updated_at >= updated_at_from.
\nIf passed as date only (Y-m-d), it is treated as Y-m-d 00:00:00.
\nupdated_at_to (optional, date or datetime)
\nFilters updated_at <= updated_at_to.
\nIf passed as date only (Y-m-d), it is treated as Y-m-d 23:59:59.
\nYou can filter orders by their sync_date using:
\nsync_date_from (optional, date or datetime)
\nReturns orders with sync_date >= sync_date_from.
\nAccepts 'Y-m-d' (treated as 00:00:00) or 'Y-m-d H:i:s'.
\nsync_date_to (optional, date or datetime)
\nReturns orders with sync_date <= sync_date_to.
\nAccepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\nPreferred over updated_at filters for polling since sync_date only changes on order create or explicit sync, not on internal batch reassignments.
\norder_status (optional, string)
\nIf omitted (and id is not set): the default filter is order_status IN (\"order\",\"backorder\").
\norder_status=ALL: no status filter is applied; all statuses are returned.
\nAny other value: exact match filter on order_status (e.g. shipped, cancelled, …).
\ninclude_raw_order_data (optional, \"true\"/\"false\")
\nWhen \"true\", includes raw_order_data per order with the original raw payload from the sales channel (if available).
\ninclude_serial_numbers (optional, \"true\"/\"false\")
\nWhen \"true\", enables traceability data on order lines (serial numbers, batches, expiration dates).
\n(Kept for backward compatibility, internally treated as enabling traceability).
\ninclude_traceability_data (optional, \"true\"/\"false\")
\nWhen \"true\", also enables traceability data.
\nIn both cases, each order line may contain serial_numbers and traceability_data.
\nshipping_address_accurate (optional, 0, 1, or ALL)
\nIf omitted: only orders where shipping_address_accurate = 1 are returned.
\nshipping_address_accurate=ALL: no filter is applied (both accurate and inaccurate).
\nAny other value: cast to boolean and filter accordingly.
\nEach order in the response includes shipping_address_accurate (0 = address needs review, 1 = OK).
\nsort_attr (optional, string)
\nAllowed values:
\nid, order_id, order_date, ship_on_date, order_status, sync_date, updated_at.
\nAny other value: falls back to id.
\nsort_dir (optional, string)
\nSort direction: asc or desc (case-insensitive).
\nDefaults to DESC if not explicitly asc.
\nWhen both sort_attr and sort_dir are present, results are sorted accordingly.
\nFor sort_attr=order_id, an optimized index (order_id_x_seller_id) is used internally.
\ninclude_shipping_label_addresses (optional, string — comma-separated carrier slugs)
\n Example: include_shipping_label_addresses=postnl,sendcloud,generic
When provided, each order in the response will include a shipping_label_addresses object keyed by carrier slug. Each entry contains the sanitized address as stored in the shipping label for that carrier.
Supported slugs: generic, bolcom, myparcel, dpdnl, dhlnl, dhlde, internetmarke, ampere, amperev2, postnl, gls, bpost, sendcloud, wuunder, shipcloud, shipstation, sendy, sendwise, parcelpro, qls, shipit, gls_shipit, ups, hermes, monta, easyship, amazon_easyship, landmark, trunkrs, asendia, fedex
\nUnsupported slugs are silently ignored.
\n PII / privacy: If api_pii_enabled = 0 for the seller, the shipping_label_addresses field is redacted (not returned).
Backward compatibility: The existing flat shipping_* fields on the order are unchanged.
Response field structure (shipping_label_addresses):
Each key is a carrier slug. Each value is an object with:
\nExample response snippet:
\n{\n \"shipping_label_addresses\": {\n \"postnl\": {\n \"first_name\": \"Jan\",\n \"last_name\": \"de Vries\",\n \"full_name\": \"Jan de Vries\",\n \"street\": \"Hoofdstraat\",\n \"house_number\": \"12\",\n \"house_number_ext\": \"A\",\n \"house_number_full\": \"12A\",\n \"address_line1\": \"Hoofdstraat 12\",\n \"address_line2\": \"A\",\n \"postal_code\": \"1234AB\",\n \"city\": \"Amsterdam\",\n \"region\": null,\n \"country_code\": \"NL\",\n \"email\": \"jan@example.com\",\n \"phone\": \"+31612345678\",\n \"is_complete\": true,\n \"warnings\": []\n },\n \"sendcloud\": {\n \"first_name\": \"Jan\",\n \"last_name\": \"de Vries\",\n \"full_name\": \"Jan de Vries\",\n \"street\": \"Hoofdstraat\",\n \"house_number\": \"12\",\n \"house_number_ext\": \"A\",\n \"house_number_full\": \"12A\",\n \"address_line1\": \"Hoofdstraat 12\",\n \"address_line2\": \"A\",\n \"postal_code\": \"1234AB\",\n \"city\": \"Amsterdam\",\n \"region\": null,\n \"country_code\": \"NL\",\n \"email\": \"jan@example.com\",\n \"phone\": \"+31612345678\",\n \"is_complete\": true,\n \"warnings\": []\n }\n }\n}\noptional. Default when omitted: order, backorder. Use ALL for no filter. Valid: order, shipment, return, pending, on-hold, backorder, cancelled, refunded, failed, trash
\n","type":"text/plain"},"key":"order_status","value":"ALL"},{"disabled":true,"description":{"content":"optional: remote order id of the webshop / marketplace
\n","type":"text/plain"},"key":"order_id","value":"1747"},{"disabled":true,"description":{"content":"optional: country code of order
\n","type":"text/plain"},"key":"shipping_country_code","value":"NL"},{"disabled":true,"description":{"content":"optional ( id | default: order_date | sync_date | updated_at )
\n","type":"text/plain"},"key":"sort_attr","value":"sync_date"},{"disabled":true,"description":{"content":"optional ( DESC | default: ASC )
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional: filter on address validation ( default: 1 | 0 | 'ALL')
\n","type":"text/plain"},"key":"shipping_address_accurate","value":"0"},{"disabled":true,"description":{"content":"optional: filter orders with order_date >= this value. Accepts 'Y-m-d' or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"start_date","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with order_date <= this value. Accepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"end_date","value":"2023-11-19"},{"description":{"content":"required: 1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional: number of orders per page. Must be between 1 and 100.
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional: when true, includes raw_order_data per order with the original raw payload from the sales channel.
\n","type":"text/plain"},"key":"include_raw_order_data","value":"true"},{"disabled":true,"description":{"content":"optional: filter orders with ship_on_date >= this value. Accepts 'Y-m-d' (treated as 00:00:00) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"ship_on_date_from","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with ship_on_date <= this value. Accepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"ship_on_date_to","value":"2024-12-09"},{"disabled":true,"description":{"content":"optional: when true, includes traceability_data (serial numbers, batch IDs, expiration dates) for each order line.
\n","type":"text/plain"},"key":"include_traceability_data","value":"true"},{"disabled":true,"description":{"content":"optional ( int )
\n","type":"text/plain"},"key":"batch_id","value":"1"},{"disabled":true,"description":{"content":"optional: filter orders with sync_date >= this value. Accepts 'Y-m-d' (e.g. 2024-06-09, treated as 00:00:00) or 'Y-m-d H:i:s' (e.g. 2024-06-09 12:30:00). Preferred over updated_at_from for polling since sync_date only changes on order create or explicit sync, not on internal batch reassignments.
\n","type":"text/plain"},"key":"sync_date_from","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with sync_date <= this value. Accepts 'Y-m-d' (e.g. 2024-06-10, treated as 23:59:59) or 'Y-m-d H:i:s' (e.g. 2024-06-10 12:30:00).
\n","type":"text/plain"},"key":"sync_date_to","value":"2024-06-10"},{"disabled":true,"description":{"content":"optional: exact date match on updated_at (Y-m-d).
\n","type":"text/plain"},"key":"updated_at","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with updated_at >= this value. Accepts 'Y-m-d' (treated as 00:00:00) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"updated_at_from","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with updated_at <= this value. Accepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"updated_at_to","value":"2024-06-10"},{"disabled":true,"description":{"content":"optional: comma-separated list of carrier slugs. When provided, each order in the response will include a shipping_label_addresses object keyed by carrier slug. Supported slugs: generic, bolcom, myparcel, dpdnl, dhlnl, dhlde, internetmarke, ampere, amperev2, postnl, gls, bpost, sendcloud, wuunder, shipcloud, shipstation, sendy, sendwise, parcelpro, qls, shipit, gls_shipit, ups, hermes, monta, easyship, amazon_easyship, landmark, trunkrs, asendia, fedex. Unsupported slugs are silently ignored. Requires api_pii_enabled=1; if PII is disabled the field is redacted.
\n","type":"text/plain"},"key":"include_shipping_label_addresses","value":"postnl,sendcloud,generic"}],"variable":[]}},"response":[{"id":"e52d1bf5-d1bb-4847-ae0d-4ad899f86978","name":"Get Orders","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/orders?page=1&order_id=19246&sort_attr=order_date&sort_dir=DESC&page_size=50","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","orders"],"query":[{"key":"page","value":"1"},{"key":"id","value":"34779","description":"optional","disabled":true},{"key":"order_status","value":"order","description":"optional. Default when omitted: order, backorder. Use ALL for no filter. Valid: order, shipment, return, pending, on-hold, backorder, cancelled, refunded, failed, trash","disabled":true},{"key":"order_id","value":"19246","description":"optional (remote order id)"},{"key":"shipping_country_code","value":"FR","description":"optional","disabled":true},{"key":"sort_attr","value":"order_date","description":"optional"},{"key":"sort_dir","value":"DESC","description":"optional"},{"key":"page_size","value":"50"},{"key":"include_traceability_data","value":"false","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"orders_count\": 2,\n \"orders\": [\n {\n \"id\": 88210,\n \"seller_id\": 1,\n \"api_id\": 0,\n \"order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"price_currency\": \"EUR\",\n \"price_total\": 466.8,\n \"discount_total\": 0,\n \"vat_number\": \"\",\n \"payment_id\": \"pi_3PqAB12FCdEfGhI\",\n \"channel_name\": \"WooCommerce\",\n \"channel_id\": 8,\n \"billing_address1\": \"Duivendrechtsekade 40A\",\n \"billing_address_supplement\": \"\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_city\": \"Amsterdam\",\n \"billing_company\": \"ChannelDock B.V.\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"lars@upwind.example.com\",\n \"billing_first_name\": \"Lars\",\n \"billing_middle_name\": \"van\",\n \"billing_last_name\": \"Schaick\",\n \"billing_region\": \"Noord-Holland\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_zip_code\": \"1080 AH\",\n \"shipping_address1\": \"Duivendrechtsekade 40A\",\n \"shipping_first_name\": \"Lars\",\n \"shipping_last_name\": \"van Schaick\",\n \"shipping_company\": \"ChannelDock B.V.\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080 AH\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_email\": \"lars@upwind.example.com\",\n \"shipping_phone_number\": \"+31 6 1234 5678\",\n \"order_date\": \"2026-06-13 09:24:11\",\n \"ship_on_date\": \"2026-06-14\",\n \"total_weight\": 2.4,\n \"order_status\": \"order\",\n \"extra_comment\": \"Customer asked for delivery before the weekend.\",\n \"shipping_address_accurate\": 1,\n \"is_b2b\": 0,\n \"po_number\": null,\n \"pallet_count\": 0,\n \"order_products\": [\n {\n \"id\": 91201,\n \"api_id\": 0,\n \"seller_id\": 1,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-1\",\n \"ean\": \"8719326583631\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"price\": 299.95,\n \"quantity\": 1,\n \"delivery_period\": null,\n \"reference_code\": null,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 6.95,\n \"product\": {\n \"id\": 25851,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"kitesurf\",\n \"control-bar\"\n ],\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\"\n }\n },\n {\n \"id\": 91202,\n \"api_id\": 0,\n \"seller_id\": 1,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-2\",\n \"ean\": \"8719326583662\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"price\": 79.95,\n \"quantity\": 2,\n \"delivery_period\": null,\n \"reference_code\": null,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 0,\n \"product\": {\n \"id\": 25854,\n \"ean\": \"8719326583662\",\n \"sku\": \"UPW-FIN-G10\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"accessories\",\n \"fins\"\n ],\n \"country_of_origin\": \"DE\",\n \"product_classification\": \"9506290000\"\n }\n }\n ]\n },\n {\n \"id\": 88211,\n \"seller_id\": 1,\n \"api_id\": 2450,\n \"order_id\": \"BOL-19877\",\n \"seq_order_id\": \"UPW-2026-00416\",\n \"price_currency\": \"EUR\",\n \"price_total\": 194.9,\n \"discount_total\": 0,\n \"channel_name\": \"Bol.com\",\n \"channel_id\": 1,\n \"shipping_first_name\": \"Pierre\",\n \"shipping_last_name\": \"Dubois\",\n \"shipping_company\": \"\",\n \"shipping_street\": \"Rue de la République\",\n \"shipping_house_number\": \"84\",\n \"shipping_house_number_ext\": \"\",\n \"shipping_zip_code\": \"75011\",\n \"shipping_region\": \"Île-de-France\",\n \"shipping_country_code\": \"FR\",\n \"shipping_city\": \"Paris\",\n \"shipping_email\": \"pierre.dubois@example.fr\",\n \"shipping_phone_number\": \"+33 1 42 99 88 77\",\n \"billing_first_name\": \"Pierre\",\n \"billing_last_name\": \"Dubois\",\n \"billing_country_code\": \"FR\",\n \"billing_city\": \"Paris\",\n \"billing_zip_code\": \"75011\",\n \"billing_street\": \"Rue de la République\",\n \"billing_house_number\": \"84\",\n \"billing_email\": \"pierre.dubois@example.fr\",\n \"order_date\": \"2026-06-11 16:48:02\",\n \"ship_on_date\": \"2026-06-12\",\n \"total_weight\": 1.4,\n \"order_status\": \"shipment\",\n \"extra_comment\": \"\",\n \"shipping_address_accurate\": 1,\n \"is_b2b\": 0,\n \"po_number\": null,\n \"pallet_count\": 0,\n \"order_products\": [\n {\n \"id\": 91215,\n \"api_id\": 2450,\n \"seller_id\": 1,\n \"order_id\": 88211,\n \"orderItemId\": \"BOL-88211-1\",\n \"ean\": \"8719326583648\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"price\": 189.95,\n \"quantity\": 1,\n \"delivery_period\": \"2026-06-16 18:00:00\",\n \"reference_code\": null,\n \"is_shipped\": 1,\n \"cancellation_request\": 0,\n \"shipment_label_id\": 7701,\n \"fulfillment_status\": \"shipped\",\n \"shipping_costs\": 4.95,\n \"product\": {\n \"id\": 25852,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"wetsuit\",\n \"neoprene\"\n ],\n \"country_of_origin\": \"TH\",\n \"product_classification\": \"6110309100\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"022109df-1ee0-4733-aa11-a743cc098557"},{"name":"Create manual order","id":"4ba44ad1-ad13-4f64-b3fc-3f152837e925","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"B-32333\",\n \"seq_order_id\": \"CD-ORDER-2024-001\",\n \"order_status\": \"order\",\n \"order_date\": \"2024-01-15 10:30:00\",\n \"ship_on_date\": \"2024-01-16 09:00:00\",\n \"delivery_date\": \"2024-01-17\",\n \"extra_comment\": \"A manual order created by ChannelDock API.\",\n \n \"price_total\": 125.50,\n \"price_currency\": \"EUR\",\n \n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Smith\",\n \"shipping_company\": \"ChannelDock BV\",\n \"shipping_address1\": \"Duivendrechtsekade 40A\",\n \"shipping_address2\": \"2nd floor\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_phone_number\": \"+31612345678\",\n \"shipping_email\": \"demo_customer@channeldock.com\",\n \"shipping_service\": \"standard\",\n\n \"billing_first_name\": \"Nicky\",\n \"billing_last_name\": \"Smith\", \n \"billing_company\": \"ChannelDock BV\",\n \"billing_address1\": \"Duivendrechtsekade 40A\",\n \"billing_address2\": \"2nd floor\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_zip_code\": \"1080AH\",\n \"billing_city\": \"Amsterdam\",\n \"billing_region\": \"Noord-Holland\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"demo_customer@channeldock.com\",\n \n \"order_products\": [\n {\n \"ean\": \"8719326583631\",\n \"quantity\": 10,\n \"price\": 75.00,\n \"order_item_id\": 1\n },\n {\n \"ean\": \"8719326583648\",\n \"quantity\": 5\n }\n ]\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders","description":"This POST request can be used to create (manual) orders in ChannelDock. These orders have the same characteristics as orders which are created from the ChannelDock UI ('New order' page). Orders created via this endpoint cannot be linked to an existing sales connection, that's why we call them 'manual orders'.
\nCreates a new order for the authenticated seller. The order is automatically associated with the seller account based on the authentication token.
\norder_products (array) - List of products in the order. Each product must contain:
\nean (string) - Product EAN code
\nquantity (integer) - Quantity of the product (minimum 1)
\norder_id (string/integer) - External order identifier. If not provided or set to 0, the ChannelDock order ID will be used as the order_id.
\nseq_order_id (string, max 255 characters) - Sequential order identifier for tracking. Must be unique per seller.
\norder_status (string) - Order status. Defaults to \"order\". Valid values: \"order\", \"shipment\", \"return\", \"pending\", \"on-hold\", \"backorder\", \"cancelled\", \"refunded\", \"failed\", \"trash\".
\norder_date (string) - Order creation date/time in format \"Y-m-d H:i:s\". Defaults to current date/time if not provided.
\nship_on_date (string) - Date when the order should be shipped in format \"Y-m-d H:i:s\" or \"Y-m-d\". Defaults to current date/time if not provided.
\ndelivery_date (string) - Expected delivery date in format \"Y-m-d\". If provided, ship_on_date will be automatically set to delivery_date minus 1 day.
\nprice_total (float) - Total order price. If not provided, the total will be calculated from the sum of order products (using custom prices if provided, otherwise product prices × quantities).
\nprice_currency (string, max 3 characters) - Currency code (e.g., \"EUR\", \"USD\", \"GBP\"). Automatically converted to uppercase and truncated to 3 characters. Defaults to \"EUR\" if not provided.
\nshipping_first_name (string) - Recipient's first name
\nshipping_last_name (string) - Recipient's last name
\nshipping_company (string) - Company name
\nshipping_street (string) - Street name
\nshipping_house_number (string) - House number
\nshipping_house_number_ext (string) - House number extension (e.g., \"A\", \"B\")
\nshipping_address1 (string) - Full address line 1. If not provided, will be constructed from street, house number, and extension.
\nshipping_address2 (string) - Address line 2 (e.g., apartment, floor)
\nshipping_zip_code (string) - Postal/ZIP code
\nshipping_city (string) - City name
\nshipping_region (string) - State/Province/Region
\nshipping_country_code (string) - ISO country code (e.g., \"NL\", \"US\", \"GB\")
\nshipping_email (string) - Shipping email address
\nshipping_phone_number (string) - Contact phone number
\nshipping_service (string|array) - Shipping service identifier. If provided as an array, it will be stored as JSON.
\nAll billing fields are optional. If not provided, they will default to the corresponding shipping address values.
\nbilling_first_name (string) - Billing contact first name
\nbilling_last_name (string) - Billing contact last name
\nbilling_middle_name (string) - Billing contact middle name
\nbilling_company (string) - Billing company name
\nbilling_street (string) - Billing street name
\nbilling_house_number (string) - Billing house number
\nbilling_house_number_ext (string) - Billing house number extension
\nbilling_address1 (string) - Billing address line 1. If not provided, will be constructed from street, house number, and extension.
\nbilling_address2 (string) - Billing address line 2
\nbilling_address_supplement (string) - Additional billing address information
\nbilling_zip_code (string) - Billing postal/ZIP code
\nbilling_city (string) - Billing city
\nbilling_region (string) - Billing state/Province/Region
\nbilling_country_code (string) - Billing ISO country code
\nbilling_email (string) - Billing email address
\nEach product in the order_products array can include:
\nean (string, required) - Product EAN code
\nquantity (integer, required) - Product quantity (minimum 1)
\nprice (float, optional) - Custom price for this line item. If not provided, the price will be calculated as product_price × quantity from the product catalog.
\norder_item_id (integer, optional) - External order item identifier
\nIf shipping_street and shipping_house_number are not provided, the system will automatically parse shipping_address1 and shipping_address2 using AddressDock to extract street, house number, and extension. The same applies to billing addresses.
\nThe API checks for duplicate orders based on:
\nseq_order_id - If provided and an order with the same seq_order_id exists for this seller, the request will be rejected.
\norder_id - If provided and an order with the same order_id exists for this seller (and channel_id is 17), the request will be rejected.
\nDe parameter unrecognized_product_policy bepaalt hoe het systeem omgaat met orderregels die niet herkend worden. Ondersteunde waarden zijn:
\nallow (standaard)
\nDe order wordt aangemaakt, ook als er onbekende regels zijn.
\nResultaat: partial_success + order_products_failed
\nGedrag:
\nSeller: er wordt een placeholder-regel aangemaakt zonder gekoppeld product
\nCenter: onbekende regels worden overgeslagen
\nreject_order
\nDe volledige order wordt afgewezen zodra er één onbekende regel is.
\nhold_order
\nDe order wordt aangemaakt, maar op on-hold gezet als er onbekende regels zijn.
\nBelangrijk:
\nAls geen enkele orderregel herkend wordt, faalt de aanvraag altijd met een HTTP 400, ongeacht de gekozen policy.
\nOn success, returns:{
\"response\": \"success\",
\"message\": \"Created new order: {order_id}\",
\"order_id\": {order_id}
}
On error, returns appropriate error messages with HTTP status codes (400 for validation errors, etc.).
\n","urlObject":{"path":["portal","api","v2","seller","orders"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"20f7035b-3cd0-4f0a-9906-a38e712cd18f","name":"Created (success)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"B-32333\",\n \"extra_comment\": \"A manual order created by ChannelDock API.\",\n \n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Smith\",\n \"shipping_company\": \"ChannelDock BV\",\n \"shipping_address1\": \"Duivendrechtsekade 40A\",\n \"shipping_address2\": \"2nd floor\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_phone_number\": \"+31612345678\",\n \"shipping_email\": \"+31612345678\",\n\n \"billing_first_name\": \"Nicky\",\n \"billing_last_name\": \"Smith\", \n \"billing_company\": \"ChannelDock BV\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_zip_code\": \"1080AH\",\n \"billing_city\": \"Amsterdam\",\n \"billing_region\": \"Noord-Holland\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"billing@channeldock.com\",\n \"order_products\": [\n {\n \"ean\": \"8719326583631\",\n \"quantity\": 10,\n \"order_item_id\": 12345678\n },\n {\n \"ean\": \"8719326583648\",\n \"quantity\": 5,\n \"order_item_id\": 234567890\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Created new order: 88212\",\n \"order_id\": 88212\n}"},{"id":"a660a327-ee3e-4809-a5c5-c562a1ae37c9","name":"Created with unrecognized lines (partial_success)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"seq_order_id\": \"SHOP-ORDER-7721\",\n \"order_status\": \"order\",\n \"first_name\": \"Jan\",\n \"last_name\": \"Jansen\",\n \"email\": \"jan@example.com\",\n \"shipping_street\": \"Stationsstraat\",\n \"shipping_house_number\": \"5\",\n \"shipping_city\": \"Utrecht\",\n \"shipping_zip_code\": \"3511\",\n \"shipping_country_code\": \"NL\",\n \"order_products\": [\n { \"ean\": \"8711111111111\", \"quantity\": 1 },\n { \"ean\": \"UNKNOWN-EAN-XYZ\", \"quantity\": 3, \"price\": 12.0 }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"partial_success\",\n \"message\": \"Created new order: 88213. One or more lines are not linked to a catalog product (unrecognized EAN).\",\n \"order_id\": 88213,\n \"order_products_failed\": [\n {\n \"ean\": \"9990000000001\",\n \"message\": \"Product not recognized: no product with this EAN in the seller catalog. Order line was still created without a linked product.\"\n }\n ]\n}"},{"id":"faa35587-2b7b-4066-aa63-d5841c3be888","name":"Rejected — no order products recognized","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"seq_order_id\": \"SHOP-88422-ALL-BAD\",\n \"order_status\": \"order\",\n \"price_total\": 45.0,\n \"price_currency\": \"EUR\",\n \"first_name\": \"Test\",\n \"last_name\": \"Customer\",\n \"email\": \"test@example.com\",\n \"shipping_street\": \"Teststraat\",\n \"shipping_house_number\": \"1\",\n \"shipping_city\": \"Rotterdam\",\n \"shipping_zip_code\": \"3011AA\",\n \"shipping_country_code\": \"NL\",\n \"order_products\": [\n { \"ean\": \"9991111111111\", \"quantity\": 2 },\n { \"ean\": \"9992222222222\", \"quantity\": 1, \"price\": 15.0 }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"error\",\n \"message\": \"Order rejected: none of the given EANs match a product in the seller catalog.\",\n \"order_products_failed\": [\n {\n \"ean\": \"9990000000001\",\n \"message\": \"Product not recognized: no product with this EAN in the seller catalog.\"\n },\n {\n \"ean\": \"9990000000002\",\n \"message\": \"Product not recognized: no product with this EAN in the seller catalog.\"\n }\n ]\n}"}],"_postman_id":"4ba44ad1-ad13-4f64-b3fc-3f152837e925"},{"name":"Update an order","id":"280dacf3-fcb4-4ed9-87e0-c43fbaf9962a","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": \"3918588\",\n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Kouffeld\",\n \"shipping_company\": \"ChannelDock\",\n \"shipping_email\": \"nicky@gmail.com\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_country_code\": \"NL\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"41\",\n \"shipping_house_number_ext\": \"\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_address_accurate\": 1,\n \"extra_comment\": \"A manual order created by ChannelDock API.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders","description":"Update one or more fields on an existing order belonging to the authenticated seller.
\nSend only the fields you want to change. The response includes an updated_fields object with the values that were applied.
\nshipping_address_accurate (optional, 0 or 1)
\nMarks whether the shipping address is considered valid for fulfillment.
\nUse 1 after correcting shipping fields via the API so the order can proceed to fulfillment.
\nbilling_address1, billing_address2, billing_address_supplement, billing_city, billing_company, billing_country_code, billing_email, billing_first_name, billing_last_name, billing_middle_name, billing_house_number, billing_house_number_ext, billing_region, billing_street, billing_zip_code
\npo_number, customer_reference, payment_terms, requested_delivery_date, shipment_type, pallet_count
\n","urlObject":{"path":["portal","api","v2","seller","orders"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"f88c7417-1b86-4767-a518-efcf7f49597b","name":"Update an order","originalRequest":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": \"3918588\",\n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Kouffeld\",\n \"shipping_company\": \"ChannelDock\",\n \"shipping_email\": \"nicky@gmail.com\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_country_code\": \"NL\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_address_accurate\": 1,\n \"extra_comment\": \"A manual order created by ChannelDock API.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Updated order: 88210\",\n \"updated_fields\": {\n \"shipping_first_name\": \"Lars\",\n \"shipping_last_name\": \"van Schaick\",\n \"shipping_company\": \"ChannelDock B.V.\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080 AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_country_code\": \"NL\",\n \"shipping_email\": \"lars@upwind.example.com\",\n \"extra_comment\": \"Updated via ChannelDock API.\"\n }\n}"}],"_postman_id":"280dacf3-fcb4-4ed9-87e0-c43fbaf9962a"},{"name":"Delete an order","id":"ad2b6ef1-1e88-4745-89fa-6293763fa6f5","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": \"1133\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders","description":"This DELETE request can be used to delete an order. Requires the ChannelDock order id in the request body. Cannot delete orders that are already shipped or synced to a fulfillment center.
\n","urlObject":{"path":["portal","api","v2","seller","orders"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"5d4f4759-7c94-455f-ac04-435918303fce","name":"Delete an order","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": \"3918588\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Deleted order: 88210\"\n}"}],"_postman_id":"ad2b6ef1-1e88-4745-89fa-6293763fa6f5"},{"name":"Delete an order product","id":"f79aaa01-c0c7-48e7-9f20-374287117f01","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"order_product_id\": 67890\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders/{id}/remove-order-product","description":"Use this endpoint to remove a single order line (order_product) from an existing order.
What it does
\nRemoves one order product line from the specified order
\nRecalculates/finalizes the order after deletion
\nWrites an order log entry
\nReturns success/error JSON
\nSearch for an order by order number. Supports GET and POST. Searches by ChannelDock order id, remote order_id, or seq_order_id. Used by integrations such as Returnless. Request body: order_number (required).
\n","urlObject":{"path":["portal","api","v2","seller","searchorder"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"94d38ac7-a69c-4c34-ad97-4f77d85aa2e4","name":"Order found","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"WC-88210\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/searchorder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"order_number\": \"WC-88210\",\n \"order_date\": \"2026-06-13T09:24:11+00:00\",\n \"order_id\": \"88210\",\n \"status\": \"order\",\n \"customer\": {\n \"id\": \"88210\",\n \"name\": \"Lars van Schaick\",\n \"email\": \"lars@upwind.example.com\",\n \"address\": {\n \"country_code\": \"NL\",\n \"telephone\": \"+31 6 1234 5678\",\n \"street\": \"Duivendrechtsekade\",\n \"house_number\": \"40\",\n \"suffix\": \"A\",\n \"city\": \"Amsterdam\",\n \"postal_code\": \"1080 AH\",\n \"state\": \"Noord-Holland\"\n }\n },\n \"sales_order_items\": [\n {\n \"sales_order_item_id\": \"91201\",\n \"item_price\": 29995,\n \"product_id\": \"25851\",\n \"name\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"sku\": \"UPW-BAR-52\",\n \"quantity\": 1,\n \"barcode\": \"8719326583631\",\n \"weight\": 1800,\n \"height\": 0.08,\n \"length\": 0.6,\n \"width\": 0.12,\n \"image_src\": \"https://cdn.upwind.example.com/products/kitesurf-bar-pro-52.jpg\"\n }\n ]\n}"},{"id":"0e72e182-891e-4eba-9b8c-bb99c7aa59c0","name":"No order found","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"UNKNOWN-12345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/searchorder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"no_order_found\"\n}"}],"_postman_id":"b9a579ca-955a-4e5a-9e19-53cdb3261982"},{"name":"Add order product","id":"6d367eb5-0429-47aa-bb02-e42afd81e151","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 12345,\n \"quantity\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/orders/{{order_id}}/add-product","description":"Adds a product line to an existing order. Use this when you need to add extra items to one of your orders.
\nRequirements:
\nThe order must belong to your seller account
\nThe product must exist in your product catalog
\nCreate an order log entry on a specific order. Use the internal ChannelDock order id (orders.id), not the marketplace order reference.
Enable Order Logs with POST on your API key in ChannelDock settings.
\ninfo. Max 255 characters. Common values: info, updated, update, created, error, label, cancelled, changed.Logged via API by {user first name last name}.HTTP 201 — Returns order_id and the created order_log row.
order_id or title, or field too long.required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"key":"id","value":"6526"},{"disabled":true,"description":{"content":"registered | distribution | delivered | return
\n","type":"text/plain"},"key":"status","value":"registered"},{"disabled":true,"description":{"content":"ChannelDock order id
\n","type":"text/plain"},"key":"order_id","value":"1838"},{"disabled":true,"description":{"content":"max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"id | default: created_at | order_id
\n","type":"text/plain"},"key":"sort_attr","value":"created_at"},{"disabled":true,"description":{"content":"DESC | default: ASC
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"start_date","value":"2022-07-28 02:03:22"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"end_date","value":"2022-08-28 06:03:33"},{"disabled":true,"key":"include_pdf_label","value":"true"}],"variable":[]}},"response":[{"id":"3fe0f02a-9d80-4e6b-bd03-2d019606a7f2","name":"Get Shipments","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/shipment?page=1&sort_attr=created_at&sort_dir=DESC","host":["https://channeldock.com"],"path":["portal","api","v2","seller","shipment"],"query":[{"key":"page","value":"1","description":"required"},{"key":"id","value":"5110","disabled":true},{"key":"status","value":"registered","description":"registered | distribution | delivered | return","disabled":true},{"key":"order_id","value":"1838","description":"ChannelDock order id","disabled":true},{"key":"sort_attr","value":"created_at","description":"id | default: created_at | order_id"},{"key":"sort_dir","value":"DESC","description":"DESC | default: ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"shipments_count\": 2,\n \"shipments\": [\n {\n \"id\": 7701,\n \"shipment_method_id\": 9504,\n \"api_id\": 0,\n \"order_id\": 88210,\n \"remote_order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"status\": \"registered\",\n \"remote_label_id\": \"PNL-3SBOL00112233\",\n \"price\": 6.95,\n \"shipment_method\": \"PostNL Pakket NL\",\n \"carrier_code\": \"postnl\",\n \"track_and_trace\": \"3SBOL00112233\",\n \"track_and_trace_url\": \"https://postnl.nl/tracktrace/?B=3SBOL00112233&P=1080AH&D=NL&T=C\",\n \"track_and_traces\": [\n \"3SBOL00112233\"\n ],\n \"shipment_date\": \"2026-06-14\",\n \"order_date\": \"2026-06-13\",\n \"created_at\": \"2026-06-14 08:12:30\",\n \"extra_comment\": \"\",\n \"number_of_labels\": 1,\n \"order_products\": [\n {\n \"id\": 91201,\n \"api_id\": 0,\n \"seller_id\": 1,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-1\",\n \"ean\": \"8719326583631\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"price\": 299.95,\n \"quantity\": 1,\n \"delivery_period\": null,\n \"reference_code\": null,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 6.95,\n \"product\": {\n \"id\": 25851,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"kitesurf\",\n \"control-bar\"\n ]\n }\n },\n {\n \"id\": 91202,\n \"api_id\": 0,\n \"seller_id\": 1,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-2\",\n \"ean\": \"8719326583662\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"price\": 79.95,\n \"quantity\": 2,\n \"delivery_period\": null,\n \"reference_code\": null,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 0,\n \"product\": {\n \"id\": 25854,\n \"ean\": \"8719326583662\",\n \"sku\": \"UPW-FIN-G10\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"accessories\",\n \"fins\"\n ]\n }\n }\n ]\n },\n {\n \"id\": 7702,\n \"shipment_method_id\": 9505,\n \"api_id\": 2450,\n \"order_id\": 88211,\n \"remote_order_id\": \"BOL-19877\",\n \"seq_order_id\": \"UPW-2026-00416\",\n \"status\": \"processed\",\n \"remote_label_id\": \"DHL-JD0123456789\",\n \"price\": 11.5,\n \"shipment_method\": \"DHL Express NL → FR\",\n \"carrier_code\": \"dhl\",\n \"track_and_trace\": \"JD0123456789\",\n \"track_and_trace_url\": \"https://www.dhl.com/nl-en/home/tracking.html?tracking-id=JD0123456789\",\n \"track_and_traces\": [\n \"JD0123456789\"\n ],\n \"shipment_date\": \"2026-06-12\",\n \"order_date\": \"2026-06-11\",\n \"created_at\": \"2026-06-12 11:04:17\",\n \"extra_comment\": \"\",\n \"number_of_labels\": 1,\n \"order_products\": [\n {\n \"id\": 91215,\n \"api_id\": 2450,\n \"seller_id\": 1,\n \"order_id\": 88211,\n \"orderItemId\": \"BOL-88211-1\",\n \"ean\": \"8719326583648\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"price\": 189.95,\n \"quantity\": 1,\n \"delivery_period\": \"2026-06-16 18:00:00\",\n \"reference_code\": null,\n \"is_shipped\": 1,\n \"cancellation_request\": 0,\n \"shipment_label_id\": 7701,\n \"fulfillment_status\": \"shipped\",\n \"shipping_costs\": 4.95,\n \"product\": {\n \"id\": 25852,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"child_from_bundle\": false,\n \"tags\": [\n \"wetsuit\",\n \"neoprene\"\n ]\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"8c832d61-821a-4fff-85f3-c72eb9f9e41c"},{"name":"Create shipment","id":"866c8f6e-7c3b-43fc-bd84-3ddf5507d172","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"1735\",\n \"track_and_trace\": \"00340434626112039686\",\n \"track_and_trace_url\": \"https://www.channeldock.com\",\n \"carrier\": \"DHL\",\n \"price\": 5.25,\n \"order_products\": [ { \"id\": 6166828 } ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/seller/shipment","description":"Orders can be handled (processed to shipments) by sending ChannelDock the order_id, track_and_trace, carrier and id's of the order products. ChannelDock will then automatically handle the order at the sales channel where it originated from.
\nUsing this endpoint, we expect that you generate the shipping label in your own warehouse management system. Using the 'POST - Generate shipping label' endpoint you can have ChannelDock generate the shipping label for you.
\nThe order_products object is optional. If you omit this object, ChannelDock will ship all the order products.
\nOptionally you can also send a track_and_trace_2 field with the payload if for example the order product is too big to ship with one label. We do not support the track and trace of a third, fourth etc. label. Most sales channel wil only accept 1 track and trace anyway
\n","urlObject":{"path":["portal","api","v2","seller","shipment"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"60ed4fea-b763-486f-b77d-ea92d2c25927","name":"Create shipment (with one tracking code)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"3150051\",\n \"track_and_trace\": \"3SYTYM0003251\",\n \"track_and_trace_url\": \"https://tracking.postnl.nl?id=3SYTYM0003251\",\n \"carrier\": \"TNT\",\n \"price\": 5.25,\n \"order_products\": [ { \"id\": 2683 } ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/seller/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": [\n \"CD order ID: 88210 -> New label 7701: success\"\n ]\n}"},{"id":"e9d3e410-fa85-48ac-8fae-3828dc421ac7","name":"Create shipment (with multiple tracking codes)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"3150051\",\n \"track_and_traces\": [\n \"3SYTYM0003251\",\n \"3SYTYM0003252\",\n \"3SYTYM0003253\"\n ],\n \"track_and_trace_url\": \"https://tracking.postnl.nl?id=3SYTYM0003251\",\n \"carrier\": \"TNT\",\n \"price\": 5.25,\n \"order_products\": [\n { \"id\": 3406535 }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/seller/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": [\n \"CD order ID: 88211 -> New label 7702 (with 2 tracking codes): success\"\n ]\n}"}],"_postman_id":"866c8f6e-7c3b-43fc-bd84-3ddf5507d172"},{"name":"Generate shipping label","id":"5e73ac1d-1eb0-4ddd-bdb5-78c0083ac7d2","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"7470\",\n \"order_products\": [ { \"id\": 9104 } ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/seller/label","description":"Use this endpoint to generate shipping labels via ChannelDock. To select the appropriate label, apply the shipping rules set within ChannelDock.
\nThe order_products object is optional and can be used for partial shipments. If omitted, all products associated with the order ID will be shipped.
\nThe label will be returned in base64 encoded format. To retrieve the label again later, use the GET shipments endpoint with the include_pdf_label=true parameter.
\n","urlObject":{"path":["portal","api","v2","seller","label"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"a40efc1c-06ec-4f76-947f-f1a34f66cec1","name":"Generate shipping label","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"7470\",\n \"order_products\": [ { \"id\": 9104 } ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/seller/label"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"errors\": [],\n \"shipments\": [\n {\n \"status\": \"success\",\n \"order_id\": 88210,\n \"shipment_label_id\": 7701,\n \"base64_label_pdf\": \"JVBERi0xLjcKJeLjz9MKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCi4uLi4gKHRydW5jYXRlZCBmb3IgYnJldml0eSkgLi4uLgoKJSVFT0YK\"\n }\n ]\n}"}],"_postman_id":"5e73ac1d-1eb0-4ddd-bdb5-78c0083ac7d2"}],"id":"b2624369-521e-452c-9136-c94807356ab2","description":"Fetch shipment data from ChannelDock, process orders and or create shipping labels.
\n","_postman_id":"b2624369-521e-452c-9136-c94807356ab2"},{"name":"Shipment methods","item":[{"name":"Create / Update custom shipment method","id":"ef45169d-8c34-45dd-b60f-d58b61e8e1ed","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCarrier - Package large express\",\n \"remote_carrier_id\": \"my_carrier_id\",\n \"logo_url\": \"https://example.com/logo-700x300.png\",\n \"carrier_code\": \"mycarrier\",\n \"min_weight\": 0,\n \"max_weight\": 23,\n \"max_x\": 150,\n \"max_y\": 150,\n \"max_z\": 150,\n \"mailbox_size\": 0,\n \"callback_request\": {\n \"method\": \"POST\",\n \"url\": \"https://yourdomain.com/api/shipment_endpoint\",\n \"headers\": {\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer YOUR_CARRIER_API_TOKEN\"\n }\n },\n \"shipment_method_countries\": [\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"NL\",\n \"price\": 3.2\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"BE\",\n \"price\": 4.8\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"DE\",\n \"price\": 5.6\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"FR\",\n \"price\": 15\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"US\",\n \"price\": 39.50\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"IT\",\n \"price\": 22.50\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/shipmentmethods","description":"This endpoint allows you to create or update a shipment method for a custom carrier integration. If a shipment method with the same remote_carrier_id already exists for the seller, it will be updated. Otherwise, a new one will be created.
\nThe shipment method defines core logistics parameters such as weight and dimension limits, callback behavior, and available shipping routes per country.
\nFind additional info here: Help center
\nThe request must include all required fields listed below.
\nThe callback_request should be a valid JSON object including a url, method, and headers.
\nA logo_url must be provided, pointing to a PNG image of size 700x300 pixels.
\nThe shipment_method_countries field must contain at least one country mapping with a price.
\nname – Name of the shipment method (displayed to the user)
\nremote_carrier_id – Your unique ID for recognizing this shipment method
\ncarrier_code – Lowercase identifier for the carrier/platform
\nmin_weight, max_weight – Weight limits in kg
\nmax_x, max_y, max_z – Dimensions in cm
\nmailbox_size – Set to 1 if it fits through the mailbox (optional)
\nlogo_url – PNG image (700x300px) representing the carrier
\ncallback_request – Contains:
\nurl – Endpoint for label creation
\nmethod – HTTP method (e.g., POST)
\nheaders – Object with any required headers (e.g., API key)
\nshipment_method_countries – Array of country pairs and prices
\nIf a shipment method with the same remote_carrier_id exists, it will be updated.
\nOtherwise, a new shipment method will be created.
\nCountry-specific shipping rules are updated or created based on shipment_method_countries.
\nTest auth endpoint
\n","urlObject":{"path":["portal","api","v2","seller","carriers"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"bdd2c04d-09f1-4633-b5f1-9a3f82981019","name":"List all carriers","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://channeldock.com/portal/api/v2/seller/carriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"carriers\": {\n \"postnl\": \"PostNL\",\n \"dhl\": \"DHL\",\n \"dpd\": \"DPD\",\n \"ups\": \"United Parcel Service (UPS)\",\n \"fedex\": \"FedEx\",\n \"gls\": \"GLS\",\n \"dhl_express\": \"DHL Express\",\n \"bol_dhl_for_you\": \"Bol DHL ForYou (VVB)\",\n \"bol_bpost\": \"Bol Bpost (VVB)\",\n \"amazon_logistics\": \"Amazon Logistics\",\n \"chronopost\": \"Chronopost\",\n \"colissimo\": \"Colissimo\",\n \"hermes\": \"Hermes\",\n \"royal_mail\": \"Royal Mail\",\n \"canada_post\": \"Canada Post\",\n \"tnt\": \"TNT\",\n \"manual\": \"Manual / custom carrier\"\n }\n}"}],"_postman_id":"e53f0329-fa70-4382-ac72-9f44a58c1c84"}],"id":"4756c77c-1d51-480f-a12c-9367bd428074","_postman_id":"4756c77c-1d51-480f-a12c-9367bd428074","description":""},{"name":"Stock locations","item":[{"name":"Get stock locations","id":"4817450c-a855-4f9a-8d90-13c999d71f1a","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/stocklocations?id=0&stock_section_id=0&product_id=0&sort_attr=stock&sort_dir=ASC","description":"This endpoint retrieves a paginated list of stock locations for the current seller.
\nBy default only the seller's own warehouse is returned. Pass center_locations=true to return only stock locations at connected fulfillment centers (not own-warehouse locations). Optionally pass center_id to return only that one connected center. A center_id that is not connected, or a center that has disabled viewing stock locations for this seller, returns 403. POST, PUT and DELETE still only apply to the seller's own warehouse.
\nOptional filters include id, stock_section_id, product_id, center_locations, center_id, and has_expiration. Results can be sorted by attributes like id, stock_section_id, product_id, stock, and expiration_date in ascending or descending order.
\nEach stock location includes key details (id, center_id, stock_section_id, product_id, expiration_date, batch_id, etc.) and associated product information (e.g., ean, sku, title, dimensions, and weight) if linked to a product.
\nBy default this endpoint only returns stock locations that already have a product assigned. Stock sections (shelves) that exist but currently hold no product are NOT included unless you pass include_empty=true. When include_empty=true, the response adds an empty_stock_sections_count and empty_stock_sections array listing those empty shelves — the existing stock_locations array is unchanged.
\nPagination is supported, with customizable page numbers and page size.
\n","urlObject":{"path":["portal","api","v2","seller","stocklocations"],"host":["https://channeldock.com"],"query":[{"description":{"content":"Optional: The ID of the stock location
\n","type":"text/plain"},"key":"id","value":"0"},{"description":{"content":"Optional: The ID of the stock section
\n","type":"text/plain"},"key":"stock_section_id","value":"0"},{"description":{"content":"Optional: The ID of the product
\n","type":"text/plain"},"key":"product_id","value":"0"},{"disabled":true,"description":{"content":"Optional (default false): when true, return only stock locations at connected fulfillment centers (own warehouse is not included). Returns 403 if the fulfillment center has disabled viewing stock locations for this seller
\n","type":"text/plain"},"key":"center_locations","value":"true"},{"disabled":true,"description":{"content":"Optional: return only locations of this connected fulfillment center. Also switches the response to center locations (own warehouse is not included)
\n","type":"text/plain"},"key":"center_id","value":"12"},{"disabled":true,"description":{"content":"Optional: true = only locations with a THT/expiration date and stock > 0
\n","type":"text/plain"},"key":"has_expiration","value":"true"},{"description":{"content":"Optional: ( id | stock_section_id | product_id | stock | expiration_date )
\n","type":"text/plain"},"key":"sort_attr","value":"stock"},{"description":{"content":"( ASC | DESC )\nRequired when sort_attr is filled in
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"Optional (default false): when true, also returns empty stock sections (shelves with no product) in a separate empty_stock_sections array. Only applies to the seller's own warehouse (not with center_locations=true or center_id).
\n","type":"text/plain"},"key":"include_empty","value":"true"}],"variable":[]}},"response":[{"id":"6da2cf4f-20b5-4aaf-996f-c9be37d79742","name":"Get stock locations","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/stocklocations?id=0&stock_section_id=0&product_id=0&sort_attr=stock&sort_dir=ASC","host":["https://channeldock.com"],"path":["portal","api","v2","seller","stocklocations"],"query":[{"key":"id","value":"0","description":"Optional: The ID of the stock location"},{"key":"stock_section_id","value":"0","description":"Optional: The ID of the stock section"},{"key":"product_id","value":"0","description":"Optional: The ID of the product"},{"key":"center_locations","value":"true","description":"Optional (default false): when true, return only stock locations at connected fulfillment centers (own warehouse is not included). Returns 403 if the fulfillment center has disabled viewing stock locations for this seller","disabled":true},{"key":"center_id","value":"12","description":"Optional: return only locations of this connected fulfillment center. Also switches the response to center locations (own warehouse is not included)","disabled":true},{"key":"has_expiration","value":"true","description":"Optional: true = only locations with a THT/expiration date and stock > 0","disabled":true},{"key":"sort_attr","value":"stock","description":"Optional: ( id | stock_section_id | product_id | stock | expiration_date )"},{"key":"sort_dir","value":"ASC","description":"( ASC | DESC )\nRequired when sort_attr is filled in"},{"key":"include_empty","value":"true","description":"Optional (default false): when true, also returns empty stock sections (shelves with no product) in a separate empty_stock_sections array. Only applies to the seller's own warehouse (not with center_locations=true or center_id).","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"stock_locations_count\": 3,\n \"stock_locations\": [\n {\n \"id\": 113,\n \"center_id\": 0,\n \"stock_section_id\": 2715,\n \"product_id\": 0,\n \"stock\": 0,\n \"include_in_stock_sync\": 1,\n \"expiration_date\": null,\n \"batch_id\": null,\n \"product\": null,\n \"stock_section\": {\n \"id\": 2715,\n \"description\": \"Pallet rack A\",\n \"extra_description\": \"Bulk storage – inbound staging\",\n \"reference\": \"PR-A\",\n \"pick_location\": 0,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Amsterdam DC\"\n }\n },\n {\n \"id\": 114,\n \"center_id\": 0,\n \"stock_section_id\": 2716,\n \"product_id\": 25851,\n \"stock\": 48,\n \"include_in_stock_sync\": 1,\n \"expiration_date\": null,\n \"batch_id\": null,\n \"product\": {\n \"id\": 25851,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\"\n },\n \"stock_section\": {\n \"id\": 2716,\n \"description\": \"Pick zone B - Shelf 12\",\n \"extra_description\": \"Ground floor\",\n \"reference\": \"B-12\",\n \"pick_location\": 1,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Amsterdam DC\"\n }\n },\n {\n \"id\": 115,\n \"center_id\": 0,\n \"stock_section_id\": 2717,\n \"product_id\": 25852,\n \"stock\": 36,\n \"include_in_stock_sync\": 1,\n \"expiration_date\": null,\n \"batch_id\": null,\n \"product\": {\n \"id\": 25852,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\"\n },\n \"stock_section\": {\n \"id\": 2717,\n \"description\": \"Pick zone B - Shelf 13\",\n \"extra_description\": \"Ground floor\",\n \"reference\": \"B-13\",\n \"pick_location\": 1,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Amsterdam DC\"\n }\n }\n ]\n}"}],"_postman_id":"4817450c-a855-4f9a-8d90-13c999d71f1a"},{"name":"Create stock location","id":"a60ce2e5-c8f7-4787-985a-ef7187e8e402","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock\": 10,\n \"product_id\": 74,\n \"stock_section_id\": 11579\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations","urlObject":{"path":["portal","api","v2","seller","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"2200fd9d-d40f-4ca0-922a-14f61942275c","name":"Create stock location based on stock section description","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_description\": \"A.1.C.23\",\n \"product_id\": 31,\n \"stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location created!\",\n \"stock_location_id\": 116\n}"},{"id":"336cbe8b-a3c1-4c13-b11c-da8b540d4534","name":"Create stock location based on stock_section_id","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_id\": 11,\n \"product_id\": 31,\n \"stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location created!\",\n \"stock_location_id\": 117\n}"}],"_postman_id":"a60ce2e5-c8f7-4787-985a-ef7187e8e402"},{"name":"Update stock location","id":"5e496f0e-d227-43b5-87f9-20936712bd0d","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 327,\n \"stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations","urlObject":{"path":["portal","api","v2","seller","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"a58fe535-b945-4dad-bdcf-97678dd1626f","name":"Update stock location","originalRequest":{"method":"PUT","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 11,\n \"product_id\": 31,\n \"stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location updated!\"\n}"}],"_postman_id":"5e496f0e-d227-43b5-87f9-20936712bd0d"},{"name":"Delete stock location","id":"ec7d6c41-9c5f-47bd-a69b-ccd2179f717f","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 327\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations","urlObject":{"path":["portal","api","v2","seller","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"d084b991-11a1-4681-83a0-3cec73448489","name":"Delete stock location","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 321\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location deleted!\"\n}"}],"_postman_id":"ec7d6c41-9c5f-47bd-a69b-ccd2179f717f"}],"id":"3bd391e4-0519-4132-9ab0-951a6bba5b25","description":"For more advance stock management, users can use stock locations in ChannelDock. This means mapping out your warehouse structure assinging products to one or multiple stock locations.
\nUsing the GET /products endpoint, you can retrieve stock location data per product. Make sure to include the GET parameter 'include_stock_location_data'.
\nUse this stock locations endpoint to add, update or delete products from a specific stock location in your own warehouse. GET returns own-warehouse locations by default. Pass center_locations=true to return only locations at connected fulfillment centers (when that center has enabled viewing FC stock locations for this seller), and optionally center_id to pick one center. POST, PUT and DELETE stay limited to your own warehouse.
\nEach product at a stock location has a stock_location_id that you can use to update or delete the product from that location. When adding a product to a stock location, you need to include a stock_section_id. Based on this stock_section_id ChannelDock knows where the product location is within your warehouse.
\n","_postman_id":"3bd391e4-0519-4132-9ab0-951a6bba5b25"},{"name":"Warehouses","item":[{"name":"Get warehouses","id":"05a9e8ff-7d04-435f-928f-219330fa1251","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/warehouses","description":"Get a list of all warehouses (physical buildings/locations) for the current seller.
\nid: 0 (\"Default warehouse\") is always included first — it's not a real warehouse record, it's the same sentinel the portal UI has always shown, kept here so every warehouse_id value valid elsewhere in the API (including 0) is actually discoverable.
Real warehouses are sorted by priority (warehouses with priority = 0 last), then description — same order as the portal UI.
\n","urlObject":{"path":["portal","api","v2","seller","warehouses"],"host":["https://channeldock.com"],"query":[{"disabled":true,"description":{"content":"Optional: filter on a specific warehouse
\n","type":"text/plain"},"key":"id","value":"1"}],"variable":[]}},"response":[{"id":"2a41c621-bb9f-41bb-b839-43bff06ce211","name":"Get warehouses","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/warehouses","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","warehouses"],"query":[{"key":"id","value":"1","description":"Optional: filter on a specific warehouse","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"warehouses_count\": 2,\n \"warehouses\": [\n {\n \"id\": 0,\n \"description\": \"Default warehouse\",\n \"allow_orders\": true,\n \"priority\": 0,\n \"packing_bins_total\": 0\n },\n {\n \"id\": 1,\n \"description\": \"Main Warehouse\",\n \"allow_orders\": true,\n \"priority\": 0,\n \"packing_bins_total\": 4\n }\n ]\n}"}],"_postman_id":"05a9e8ff-7d04-435f-928f-219330fa1251"}],"id":"dbc6572d-a7ff-4464-8924-88fa615b92be","description":"A warehouse is a physical building/location. Stock sections belong to a warehouse via warehouse_id. Use this endpoint to look up which warehouses (and IDs) exist before creating or filtering stock sections.
\n","_postman_id":"dbc6572d-a7ff-4464-8924-88fa615b92be"},{"name":"Stock sections","item":[{"name":"Get stock sections","id":"2dc73739-c5f4-4d9d-befc-c03d3903b83f","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/stocksections?page=1","description":"This endpoint retrieves a paginated list of stock sections (physical locations/shelves) for the current seller.
\nOptional filters include id, parent_section_id, warehouse_id, and location_type. Results can be sorted by id, description, parent_section_id, or warehouse_id, in ascending or descending order.
\nEach stock section includes stock_locations_count and total_stock, which tell you whether a DELETE would be blocked (blocked when total_stock > 0) — check this before attempting a delete instead of guessing.
\n","urlObject":{"path":["portal","api","v2","seller","stocksections"],"host":["https://channeldock.com"],"query":[{"description":{"content":"Optional: page number (50 per page)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Optional: filter on a specific section
\n","type":"text/plain"},"key":"id","value":"4821"},{"disabled":true,"description":{"content":"Optional: filter on sections nested under a given parent
\n","type":"text/plain"},"key":"parent_section_id","value":"0"},{"disabled":true,"description":{"content":"Optional: filter on warehouse
\n","type":"text/plain"},"key":"warehouse_id","value":"1"},{"disabled":true,"description":{"content":"Optional: storage or pick
\n","type":"text/plain"},"key":"location_type","value":"pick"},{"disabled":true,"description":{"content":"Optional: ( id | description | parent_section_id | warehouse_id )
\n","type":"text/plain"},"key":"sort_attr","value":"description"},{"disabled":true,"description":{"content":"Optional: ( ASC | DESC )
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"}],"variable":[]}},"response":[{"id":"d61ce6f9-3326-4f20-8341-bc3a12ea1ae8","name":"Get stock sections","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/stocksections?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","stocksections"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"stock_sections_count\": 1,\n \"stock_sections\": [\n {\n \"id\": 4821,\n \"description\": \"A1-01\",\n \"extra_description\": null,\n \"reference\": null,\n \"parent_section_id\": 12,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Main Warehouse\",\n \"location_type\": \"storage\",\n \"stock_locations_count\": 2,\n \"total_stock\": 14\n }\n ]\n}"}],"_postman_id":"2dc73739-c5f4-4d9d-befc-c03d3903b83f"},{"name":"Create stock section","id":"1d6c24a3-aecd-48e1-b506-36ecfa52cbbe","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"description\": \"A1-01\",\n \"warehouse_id\": 1,\n \"parent_section_id\": 12,\n \"location_type\": \"pick\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocksections","description":"Create a new stock section (physical location/shelf).
\ndescription (string, required)
\nSection name. Must be unique per seller.
\nwarehouse_id (integer, optional)
\nWarehouse this section belongs to. Defaults to 0 (\"Default warehouse\"). Look up valid IDs via GET /warehouses — non-zero values must resolve to an existing warehouse for this seller, otherwise the API returns a 404.
\nparent_section_id (integer, optional)
\nParent section ID, for nested locations. Defaults to 0 (top-level/root). A root section organizes the warehouse tree and cannot hold stock locations directly — check GET /stocksections?parent_section_id=0 first, since only one root per warehouse is shown in the portal UI's navigator.
\nextra_description (string, optional)
\nFree-text notes.
\nreference (string, optional)
\nYour own reference/code for this section.
\nlocation_type (string, optional)
\nstorage or pick. Defaults to storage. Returns a 422 for any other value.
\nFails with a 409 if a section with the same description already exists for this seller.
\n","urlObject":{"path":["portal","api","v2","seller","stocksections"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"eba47841-95b4-4e6d-8702-ac6635e4e813","name":"Create stock section","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"description\": \"A1-01\",\n \"warehouse_id\": 1,\n \"parent_section_id\": 12,\n \"location_type\": \"pick\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocksections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock section created!\",\n \"stock_section_id\": 4821\n}"}],"_postman_id":"1d6c24a3-aecd-48e1-b506-36ecfa52cbbe"},{"name":"Delete stock section","id":"80fb24bf-734b-42f8-bc3e-2a6b4c37bd32","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_id\": 4821\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocksections","description":"Delete a stock section (physical location/shelf).
\nstock_section_id (integer, required)
\nSection to delete.
\nFails with a 409 if the section still holds stock — set the stock of every location in that section to 0 first (via PUT /stocklocations), then retry. Any child sections nested under the deleted section are re-parented to its parent (not deleted). Stock locations left with 0 stock under the deleted section are removed along with it.
\n","urlObject":{"path":["portal","api","v2","seller","stocksections"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"4ea82aea-2123-4a45-8446-4b40fff97008","name":"Delete stock section","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_id\": 4821\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/stocksections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock section deleted!\"\n}"}],"_postman_id":"80fb24bf-734b-42f8-bc3e-2a6b4c37bd32"}],"id":"9c121139-19f2-43f9-8e57-18135f6c2220","description":"A stock section is a physical location itself (a shelf/rack, e.g. \"A1-01\"), organized in a hierarchy under a warehouse. This is distinct from stock locations, which manage the stock of a product placed at a section — stock locations can already create/delete a product's presence at a section, but not the section itself. Use this endpoint to create or remove the location.
\nTo look up valid warehouse_id values before creating a section, use GET /warehouses.
\n","_postman_id":"9c121139-19f2-43f9-8e57-18135f6c2220"},{"name":"Deliveries","item":[{"name":"Get delivery","id":"406da57f-9de9-4d0a-b66c-8dc3232f80b2","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/delivery?page=1","description":"Get all pending deliveries. Deliveries can be purchase orders from a supplier (inbound), or replenishment orders for a fulfillment center (outbound).
\n","urlObject":{"path":["portal","api","v2","seller","delivery"],"host":["https://channeldock.com"],"query":[{"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional ( id | default: order_date | sync_date | updated_at )
\n","type":"text/plain"},"key":"id","value":"218"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"status","value":"stocked"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"supplier_id","value":"13"},{"disabled":true,"description":{"content":"optional ( id | default: order_date | sync_date | updated_at )
\n","type":"text/plain"},"key":"sort_attr","value":"delivery_date"},{"disabled":true,"description":{"content":"optional ( ASC | default: DESC )
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional ( inbound | outbound | bol_outbound | amazon_outbound )
\n","type":"text/plain"},"key":"delivery_type","value":"inbound"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"ref","value":"myrefrence"},{"disabled":true,"description":{"content":"optional ( new | confirmed | delivered | stocked | shipped | cancelled )
\n","type":"text/plain"},"key":"status","value":"new"},{"disabled":true,"description":{"content":"optional: filter deliveries with delivery_date >= this value. Accepts 'Y-m-d' or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"delivery_date_from","value":"2023-01-01"},{"disabled":true,"description":{"content":"optional: filter deliveries with delivery_date <= this value. Accepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"delivery_date_to","value":"2023-01-31"},{"disabled":true,"description":{"content":"optional, receive only deliveries with updated_at greater the parameter value
\n","type":"text/plain"},"key":"updated_at","value":"2023-01-01 14:00:20"}],"variable":[]}},"response":[{"id":"b4926f7c-bf8e-46c6-92b6-2a7ca88ea69b","name":"Get pending deliveries","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/deliveries?page=1&status=stocked&supplier_id=13&sort_attr=delivery_date&sort_dir=DESC","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","deliveries"],"query":[{"key":"page","value":"1"},{"key":"status","value":"stocked","description":"optional"},{"key":"supplier_id","value":"13","description":"optional"},{"key":"sort_attr","value":"delivery_date","description":"optional"},{"key":"sort_dir","value":"DESC","description":"optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 10,\n \"delivery_count\": 2,\n \"deliveries\": [\n {\n \"id\": 8101,\n \"delivery_type\": \"inbound\",\n \"ref\": \"PO-2026-0042\",\n \"status\": \"stocked\",\n \"extra_description\": \"Restock from PowerKite – Q2 order.\",\n \"pallets\": 1,\n \"boxes\": 4,\n \"delivery_date\": \"2026-06-02\",\n \"stocked_at\": \"2026-06-03 14:22:11\",\n \"created_at\": \"2026-05-18 10:05:00\",\n \"supplier_id\": 42,\n \"supplier\": {\n \"id\": 42,\n \"firstname\": \"Klaus\",\n \"lastname\": \"Berger\",\n \"company\": \"PowerKite Manufacturing GmbH\",\n \"phone\": \"+49 89 1234 5678\",\n \"email\": \"orders@powerkite.example.com\",\n \"address1\": \"Industriestraße 12\",\n \"address2\": \"\",\n \"city\": \"München\",\n \"state\": \"Bayern\",\n \"zipcode\": \"80331\",\n \"country\": \"DE\",\n \"payment_term\": 30,\n \"website\": \"https://powerkite.example.com\",\n \"vat\": 19,\n \"vat_number\": \"DE123456789\",\n \"email_text\": \"Hi Klaus,\\\\n\\\\nPlease find our latest purchase order attached.\\\\n\\\\nBest regards,\\\\nUpwind Watersports\"\n },\n \"items\": [\n {\n \"id\": 17501,\n \"product_id\": 25851,\n \"amount\": 50,\n \"original_amount\": 50,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"ref\": \"PO-2026-0042-L1\",\n \"stock_location_id\": 114,\n \"seller_is_processed\": 1,\n \"is_stocked\": 1\n },\n {\n \"id\": 17502,\n \"product_id\": 25853,\n \"amount\": 12,\n \"original_amount\": 12,\n \"ean\": \"8719326583655\",\n \"sku\": \"UPW-BRD-134\",\n \"title\": \"Kiteboard Surge 134cm\",\n \"ref\": \"PO-2026-0042-L2\",\n \"stock_location_id\": 113,\n \"seller_is_processed\": 1,\n \"is_stocked\": 1\n }\n ]\n },\n {\n \"id\": 8102,\n \"delivery_type\": \"inbound\",\n \"ref\": \"PO-2026-0050\",\n \"status\": \"new\",\n \"extra_description\": \"Wetsuit restock for summer season.\",\n \"pallets\": 0,\n \"boxes\": 2,\n \"delivery_date\": \"2026-06-20\",\n \"stocked_at\": null,\n \"created_at\": \"2026-06-10 09:30:00\",\n \"supplier_id\": 7,\n \"supplier\": {\n \"id\": 7,\n \"firstname\": \"Sarah\",\n \"lastname\": \"Williams\",\n \"company\": \"NeoTech Wetsuits Ltd.\",\n \"phone\": \"+44 1637 555 100\",\n \"email\": \"wholesale@neotech.example.com\",\n \"address1\": \"Harbour Industrial Estate 22\",\n \"address2\": \"Unit 4B\",\n \"city\": \"Newquay\",\n \"state\": \"Cornwall\",\n \"zipcode\": \"TR7 1AB\",\n \"country\": \"GB\",\n \"payment_term\": 14,\n \"website\": \"https://neotech.example.com\",\n \"vat\": 20,\n \"vat_number\": \"GB987654321\",\n \"email_text\": \"\"\n },\n \"items\": [\n {\n \"id\": 17511,\n \"product_id\": 25852,\n \"amount\": 40,\n \"original_amount\": 40,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"ref\": \"PO-2026-0050-L1\",\n \"stock_location_id\": 0,\n \"seller_is_processed\": 0,\n \"is_stocked\": 0\n }\n ]\n }\n ]\n}"}],"_postman_id":"406da57f-9de9-4d0a-b66c-8dc3232f80b2"},{"name":"Create delivery","id":"7aee703d-0cb6-4349-9506-0f7c385b8aeb","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"ref\": \"1234567890\",\n \"delivery_date\": \"2021-12-10\",\n \"delivery_type\": \"inbound\",\n \"extra_description\": \"This delivery was created using the API.\",\n \"pallets\": 0,\n \"boxes\": 0,\n \"supplier_id\": 13,\n \"items\": [\n {\n \"ean\": \"8719326583631\",\n \"amount\": 1200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/delivery","description":"Create a new delivery. It is at this moment not yet possible to confirm and stock the inbound via the API.
\n","urlObject":{"path":["portal","api","v2","seller","delivery"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"385c1c87-0a19-437c-b8af-93de57647d25","name":"Create delivery","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"ref\": \"1234567890\",\n \"delivery_date\": \"2021-12-10\",\n \"delivery_type\": \"inbound\",\n \"extra_description\": \"This delivery was automatically created using the API.\",\n \"pallets\": 0,\n \"boxes\": 0,\n \"supplier_id\": 13,\n \"items\": [\n {\n \"ean\": \"8719326583631\",\n \"amount\": 1200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/delivery"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Inserted delivery: 8103\",\n \"delivery_id\": 8103\n}"}],"_postman_id":"7aee703d-0cb6-4349-9506-0f7c385b8aeb"},{"name":"Update a delivery","id":"8b708066-80e6-4cdf-bb4d-e5a2040fcc7c","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"delivery_id\": 411,\n \"ref\": \"Ref-00123\",\n \"status\": \"shipped\",\n \"extra_description\": \"Fragile items, handle with care.\",\n \"pallets\": 5,\n \"boxes\": 20,\n \"delivery_date\": \"2023-12-20\",\n \"supplier_id\": 789,\n \"items\": [\n {\n \"id\": \"411\",\n \"amount\": 100,\n \"is_processed\": 0\n },\n {\n \"ean\": \"8719326583617\",\n \"amount\": 20,\n \"is_processed\": 1\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/delivery","description":"This endpoint allows the user to update the details of a seller delivery.
\nHTTP Method: PUT
\ndelivery_id (integer, required): The ID of the delivery to be updated.
ref (string, optional): The reference for the delivery.
status (string, optional): The status of the delivery: 'new', 'confirmed', 'delivered', 'shipped' or 'cancelled'.
extra_description (string, optional): Any additional description related to the delivery.
pallets (integer, optional): The number of pallets for the delivery.
boxes (integer, optional): The number of boxes for the delivery.
delivery_date (string, optional): The date of the delivery.
delivered_at (string, optional): The timestamp when the delivery was completed.
shipped_at (string, optional): The timestamp when the delivery was shipped.
supplier_id (integer, optional): The ID of the supplier associated with the delivery.
response (string): Indicates the status of the update, e.g., \"success\".
message (string): Describes the outcome of the update operation.
When updating the inbound items, you can send us either the item 'id' or 'ean'. When the EAN is not found in the inbound, we will add it as a new item.
\n{\n \"response\": \"success\",\n \"message\": \"Successfully updated delivery: 12345\"\n}\n\nCreate a new inbound delivery from your supplier. It is at this moment not yet possible to confirm and stock the inbound via the API.
\n","urlObject":{"path":["portal","api","v2","seller","delivery"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"4abd92a6-69ec-4024-a132-51608947d888","name":"Delete delivery","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"delivery_id\": 69\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/delivery"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Successfully deleted delivery: 8101\"\n}"}],"_postman_id":"d997775c-647d-43c9-b7b2-e8774901237c"}],"id":"eb7749c3-9e6b-4281-a3bd-97bbf75fc0d5","description":"Deliveries are incoming (inbounds) or out going (outbounds) shipments to / from your warehouse. These could either be purchase orders incoming from your supplier in China, or out going shipment to replensih FBA / LvB. There are four delivery types:
\nBol outbounds and Amazon outbounds can be created in ChannelDock manually, or are automatically imported from the sales channel.
\n","_postman_id":"eb7749c3-9e6b-4281-a3bd-97bbf75fc0d5"},{"name":"Suppliers","item":[{"name":"Get all suppliers","id":"f31fa14a-ddd0-4d7b-bc61-63ce2276af04","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/suppliers?page=1","description":"Get a list of all suppliers.
\n","urlObject":{"path":["portal","api","v2","seller","suppliers"],"host":["https://channeldock.com"],"query":[{"key":"page","value":"1"},{"disabled":true,"key":"id","value":"13"},{"disabled":true,"key":"company","value":"ChannelDocks"},{"disabled":true,"key":"sort_attr","value":"company"},{"disabled":true,"key":"sort_dir","value":"ASC"}],"variable":[]}},"response":[{"id":"3a006760-5707-49a8-a09d-65662ae34267","name":"Get all suppliers","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/suppliers?page=1&company=Dutchwebs&sort_attr=company&sort_dir=ASC","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","suppliers"],"query":[{"key":"page","value":"1"},{"key":"id","value":"13","disabled":true},{"key":"company","value":"Dutchwebs"},{"key":"sort_attr","value":"company"},{"key":"sort_dir","value":"ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"suppliers_count\": 3,\n \"suppliers\": [\n {\n \"id\": 42,\n \"firstname\": \"Klaus\",\n \"lastname\": \"Berger\",\n \"company\": \"PowerKite Manufacturing GmbH\",\n \"phone\": \"+49 89 1234 5678\",\n \"email\": \"orders@powerkite.example.com\",\n \"address1\": \"Industriestraße 12\",\n \"address2\": \"\",\n \"city\": \"München\",\n \"state\": \"Bayern\",\n \"zipcode\": \"80331\",\n \"country\": \"DE\",\n \"payment_term\": 30,\n \"website\": \"https://powerkite.example.com\",\n \"vat\": 19,\n \"vat_number\": \"DE123456789\",\n \"email_text\": \"Hi Klaus,\\\\n\\\\nPlease find our latest purchase order attached.\\\\n\\\\nBest regards,\\\\nUpwind Watersports\"\n },\n {\n \"id\": 7,\n \"firstname\": \"Sarah\",\n \"lastname\": \"Williams\",\n \"company\": \"NeoTech Wetsuits Ltd.\",\n \"phone\": \"+44 1637 555 100\",\n \"email\": \"wholesale@neotech.example.com\",\n \"address1\": \"Harbour Industrial Estate 22\",\n \"address2\": \"Unit 4B\",\n \"city\": \"Newquay\",\n \"state\": \"Cornwall\",\n \"zipcode\": \"TR7 1AB\",\n \"country\": \"GB\",\n \"payment_term\": 14,\n \"website\": \"https://neotech.example.com\",\n \"vat\": 20,\n \"vat_number\": \"GB987654321\",\n \"email_text\": \"\"\n },\n {\n \"id\": 13,\n \"firstname\": \"Nicky\",\n \"lastname\": \"Kouffeld\",\n \"company\": \"Dutchwebs Distribution B.V.\",\n \"phone\": \"+31 346 123 456\",\n \"email\": \"sales@dutchwebs.example.com\",\n \"address1\": \"Stationsweg 8\",\n \"address2\": \"\",\n \"city\": \"Breukelen\",\n \"state\": \"Utrecht\",\n \"zipcode\": \"3621 LL\",\n \"country\": \"NL\",\n \"payment_term\": 14,\n \"website\": \"https://dutchwebs.example.com\",\n \"vat\": 21,\n \"vat_number\": \"NL801234567B01\",\n \"email_text\": \"\"\n }\n ]\n}"}],"_postman_id":"f31fa14a-ddd0-4d7b-bc61-63ce2276af04"},{"name":"Create / Update supplier","id":"fe9d9d2b-89a5-49b2-86e4-f0df4f5cd497","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"company\": \"company\",\n \"firstname\": \"firstname\",\n \"lastname\": \"lastname\",\n \"phone\": \"phone\",\n \"email\": \"email\",\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zipcode\": \"zipcode\",\n \"country\": \"country\",\n \"payment_term\": \"payment_term\",\n \"website\": \"website\",\n \"vat\": \"vat\",\n \"vat_number\": \"vat_number\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/suppliers","description":"Update an existing or create a new supplier.
\n","urlObject":{"path":["portal","api","v2","seller","suppliers"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"066af176-b535-426a-9b1a-c812fe210ca2","name":"Create supplier","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"company\": \"company\",\n \"firstname\": \"firstname\",\n \"lastname\": \"lastname\",\n \"phone\": \"phone\",\n \"email\": \"email\",\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zipcode\": \"zipcode\",\n \"country\": \"country\",\n \"payment_term\": \"payment_term\",\n \"website\": \"website\",\n \"vat\": \"vat\",\n \"vat_number\": \"vat_number\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/suppliers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Inserted new supplier.\"\n}"},{"id":"1575c8dc-d5f7-4d2a-8238-869419204137","name":"Update supplier","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"company\": \"company\",\n \"firstname\": \"Nicky\",\n \"lastname\": \"Kouffeld\",\n \"phone\": \"phone\",\n \"email\": \"nicky@gmail.com\",\n \"address1\": \"Example street 12\",\n \"address2\": \"1082AS Amsterdam\",\n \"city\": \"Amsterdam\",\n \"state\": \"Noord-Holland\",\n \"zipcode\": \"1082AS\",\n \"country\": \"the Netherlands\",\n \"payment_term\": \"30 days\",\n \"website\": \"channeldock.com\",\n \"vat\": \"21\",\n \"vat_number\": \"8347777241\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/suppliers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Updated existing supplier.\"\n}"}],"_postman_id":"fe9d9d2b-89a5-49b2-86e4-f0df4f5cd497"},{"name":"Delete supplier","id":"8321ce59-f055-482b-8973-afec24984a7c","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"company\": \"company\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/suppliers","description":"Delete an existing supplier.
\n","urlObject":{"path":["portal","api","v2","seller","suppliers"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"67cd9e75-63ff-4d31-8f63-905d2eea7747","name":"Delete supplier","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"company\": \"company\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/suppliers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Successfully deleted supplier: 42\"\n}"}],"_postman_id":"8321ce59-f055-482b-8973-afec24984a7c"}],"id":"dfa1f82d-1b20-4cd4-9806-e86d6111f6a2","description":"Suppliers can be created in a seller account. They can then be assigned to an inbound delivery, or directly to a product.
\n","_postman_id":"dfa1f82d-1b20-4cd4-9806-e86d6111f6a2"},{"name":"Returns","item":[{"name":"Get returns","id":"18b1a383-c723-41a5-bd3f-8b731c88e14f","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/returns?page=1","description":"Get a list of all returns.
\nAdd include_attachments=true to also get each return's uploaded files, with the file content included as base64 (base64_content) — no extra call needed to read attachment content. It's opt-in because it downloads every file from storage, which isn't free. Without it, the attachments field is omitted entirely.
required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional (default false): also return each return's attachments, with base64_content included
\n","type":"text/plain"},"key":"include_attachments","value":"true"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"13"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_attr","value":"order_id"},{"disabled":true,"description":{"content":"optional ( ASC or DESC )
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"optional ( Order ID from e.g. Amazon or bol.com )
\n","type":"text/plain"},"key":"remote_order_id","value":"12345"},{"disabled":true,"description":{"content":"optional ( Return ID from e.g. Amazon or bol.com )
\n","type":"text/plain"},"key":"remote_return_id","value":"12345"},{"disabled":true,"description":{"content":"optional ( 1 or 0 )
\n","type":"text/plain"},"key":"is_handled","value":"1"},{"disabled":true,"description":{"content":"optional ( date )
\n","type":"text/plain"},"key":"created_at","value":"2026-01-01"},{"disabled":true,"description":{"content":"optional ( date )
\n","type":"text/plain"},"key":"start_date","value":"2024-01-01"},{"disabled":true,"description":{"content":"optional ( date )
\n","type":"text/plain"},"key":"end_date","value":"2025-01-01"}],"variable":[]}},"response":[{"id":"67a4f6c2-f1ae-432a-94e9-b4b61dbe5f73","name":"Get returns","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/returns?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","seller","returns"],"query":[{"key":"page","value":"1"},{"key":"id","value":"13","disabled":true},{"key":"include_attachments","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"return_count\": 1,\n \"returns\": [\n {\n \"id\": 9301,\n \"api_id\": 2450,\n \"order_id\": 88211,\n \"remote_return_id\": \"BOL-RET-77123\",\n \"is_handled\": 1,\n \"handled_date\": \"2026-06-13 11:14:08\",\n \"created_at\": \"2026-06-12 16:45:22\",\n \"channel_id\": 1,\n \"custom_return_comment\": \"Return product 8719326583648 handled by Lars van Schaick (RETURN_RECEIVED).\",\n \"return_products\": [\n {\n \"id\": 12211,\n \"api_id\": 2450,\n \"ean\": \"8719326583648\",\n \"quantity\": 1,\n \"reason\": \"Defective seam\",\n \"return_status\": \"RETURN_RECEIVED\",\n \"return_id\": 9301,\n \"order_id\": 88211,\n \"remote_order_id\": \"BOL-19877\",\n \"restocked\": 0,\n \"stock_location_id\": 0,\n \"track_and_trace\": \"3SBOLRET00099\",\n \"child_from_bundle\": 0,\n \"order_product\": {\n \"id\": 91215,\n \"api_id\": 2450,\n \"seller_id\": 1,\n \"center_id\": 0,\n \"order_id\": 88211,\n \"orderItemId\": \"BOL-88211-1\",\n \"ean\": \"8719326583648\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"price\": 189.95,\n \"quantity\": 1,\n \"is_shipped\": 1\n }\n }\n ],\n \"attachments\": [\n {\n \"id\": 501,\n \"name\": \"9301-64f1c2a1b2c3d-damage.jpg\",\n \"extension\": \"jpg\",\n \"content_type\": \"image/jpeg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"18b1a383-c723-41a5-bd3f-8b731c88e14f"},{"name":"Handle return","id":"1ce7d997-48f5-4316-8b91-9fe3c53cde14","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"is_handled\": true,\n \"needs_attention\": false,\n \"attachments\": [\n {\n \"filename\": \"received-package.jpg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n },\n {\n \"filename\": \"inspection-report.pdf\",\n \"base64_content\": \"JVBERi0xLjQKJcTl8uXr...BASE64...\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/returns","description":"This endpoint updates an existing return using its return ID. Send a PUT request with a JSON body (Content-Type: application/json) and the fields that match what you want to do.
Simple update (flags and attachments)\nYou can mark a return as handled by setting is_handled to true. When a return is marked as handled, the system records the handling timestamp automatically.
You can flag or unflag a return for attention by setting needs_attention to true/false — the same field as the portal UI's \"needs attention\" toggle.
You may include attachments (e.g. photos or documents). Each item must use base64-encoded base64_content and a filename. They are validated and stored only when the update completes successfully.
To process individual return lines (and push handling to channels such as Bol.com, Shopify, Otto, or Returnless when supported), include a return_products array. Each element must include:
id (integer) — the return product line id (from the GET returns response, not the marketplace order line id).
return_status (string) — one of: PENDING, RETURN_RECEIVED, EXCHANGE_PRODUCT, REPAIR_PRODUCT, STILL_APPROVED, RETURN_DOES_NOT_MEET_CONDITIONS, CUSTOMER_KEEPS_PRODUCT_PAID.
quantity (integer) — how many units to handle on that line; must be greater than zero and not greater than the line quantity.
When return_products is present, the system applies those statuses to each line and runs the same remote handling logic as elsewhere in the product (subject to channel support, remote_return_id, and API settings). If all relevant lines are no longer pending, the parent return may be marked handled automatically. Optional attachments are still only processed if the operation completes successfully.
If return_products is omitted, behaviour is limited to updating is_handled / needs_attention / handled_date (and optional attachments) as in the simple update above.
If the return_id is valid and the return belongs to the authenticated seller, the record is updated as described. On error, the API returns an appropriate HTTP status and a message describing the problem.
Body parameters
\nreturn_id (integer, required)\nThe unique identifier of the return to update.
is_handled (boolean, optional)\nUsed when you are not sending return_products. If true, the return is marked as handled and a handling date is set automatically.
needs_attention (boolean, optional)\nFlags (true) or unflags (false) the return for attention.
return_products (array, optional)\nIf present, each object must include:
id (integer, required) — return product id.
return_status (string, required) — one of the values listed above.
quantity (integer, required) — units to handle on that line.
attachments (array, optional)\n Files related to the return, as base64. Each item must include:
filename (string)
base64_content (string, base64-encoded file content)
This endpoint allows you to create a new return based on a set of order products. To initiate a return, send a POST request containing an order_products array, where each item specifies the related order_product_id and the quantity to be returned. At least one product must have a quantity greater than zero for the return to be created successfully.
\nOptionally, you may provide a return_action. If omitted, the return will default to PENDING.
\nYou can also include a return_track_trace value to store tracking information for the return shipment.
\nAdditionally, this endpoint supports uploading attachments, such as photos or documents related to the return (e.g. damage images or invoices). Attachments must be provided as base64-encoded content and will be validated and stored upon successful return creation.
\nIf the request is valid, the API creates a new return record, associates the provided products, stores any tracking information, and processes any supplied attachments. In case of an error, the API responds with an appropriate HTTP status code and a descriptive error message.
\norder_products (array, required)
\nList of order products to be returned. Each item must include:
\norder_product_id (integer, required)
\nquantity (integer, required, must be greater than 0)
\nreturn_action (string, optional)
\nThe initial status of the return. Defaults to PENDING.
\nAllowed values:
\nPENDING, RETURN_RECEIVED, EXCHANGE_PRODUCT, REPAIR_PRODUCT, STILL_APPROVED, RETURN_DOES_NOT_MEET_CONDITIONS, CUSTOMER_KEEPS_PRODUCT_PAID
\nreturn_track_trace (string, optional)
\nTrack and trace code for the return shipment.
\nFiles related to the return, provided as base64-encoded content. Each attachment must include:
\nfilename (string)
\nbase64_content (string, base64-encoded file content)
\nAdd one or more attachments to an existing return, after it has already been created. This is the same attachment logic used by POST/PUT /returns, but for attaching files after the fact — the return is identified in the body (return_id), not in the URL, matching the rest of this API.
return_id (integer, required)
\nThe return to attach the files to.
\nattachments (array, required)
\nOne or more files, each an object with:
\nfilename (string, required)
\nbase64_content (string, required, base64-encoded file content)
\nAllowed file extensions: png, jpg, jpeg, gif, webp, zip, pdf, docx, xlsx, xls, csv. Max 10MB per file.
\nThe return must belong to the authenticated seller, otherwise the API responds with an appropriate HTTP status code and error message.
\n","urlObject":{"path":["portal","api","v2","seller","returns","attachments"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"846008df-27a3-4195-a94b-a08ac9a9d7c1","name":"Add return attachments","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachments\": [\n {\n \"filename\": \"extra-photo.jpg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/returns/attachments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attachments_uploaded\": 1\n}"}],"_postman_id":"f6061f3d-7576-4812-8388-94092e8e7e9e"},{"name":"Delete return attachment","id":"64fcf2ed-d56d-4cd1-9a88-1b466541fb62","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachment_id\": 501\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/returns/attachments","description":"Delete a single uploaded attachment from a return.
\nreturn_id (integer, required)
\nThe return the attachment belongs to.
\nattachment_id (integer, required)
\n The id value from the attachments array (returned by GET /returns?include_attachments=true).
The attachment must belong to a return owned by the authenticated seller. Deletion removes the file from storage and its database record; if storage deletion fails, the database record is still removed.
\n","urlObject":{"path":["portal","api","v2","seller","returns","attachments"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"a51d007d-9c10-47e1-b75d-db548a193d45","name":"Delete return attachment","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachment_id\": 501\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/returns/attachments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Attachment ID 501 deleted!\"\n}"}],"_postman_id":"64fcf2ed-d56d-4cd1-9a88-1b466541fb62"}],"id":"1169f998-bf89-4ee2-bfd3-a9e0fc05e98b","description":"A seller can manually create a return in their account. Using this endpoint you can fetch all open (?is_handled=0) or processed (?is_handled=1) returns.
\n","_postman_id":"1169f998-bf89-4ee2-bfd3-a9e0fc05e98b"},{"name":"User logs","item":[{"name":"Get user logs","id":"2f4cbf38-60fc-4713-9c65-a74eb0c68f8c","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/userlogs?page=1","description":"Retrieve user activity logs for the authenticated seller. Returns 250 items per page. Optional filters: user_id, status, function_name, start_date, end_date, sort_dir.
\n","urlObject":{"path":["portal","api","v2","seller","userlogs"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"function_name","value":""},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"start_date","value":"2024-01-01 00:00:00"},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"end_date","value":"2024-12-31 23:59:59"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"}],"variable":[]}},"response":[{"id":"2a82e38f-3454-4a8c-9052-2d777d870be7","name":"Get user logs","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/user_logs?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","seller","user_logs"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 250,\n \"user_logs\": [\n {\n \"id\": 60412,\n \"status\": \"function_call\",\n \"user_id\": 1,\n \"title\": \"Order Created\",\n \"description\": \"Order WC-88210 created via WooCommerce\",\n \"created_at\": \"2026-06-13 09:24:11\",\n \"function_name\": \"createOrder\"\n },\n {\n \"id\": 60408,\n \"status\": \"api_connected\",\n \"user_id\": 1,\n \"title\": \"PostNL gekoppeld\",\n \"description\": \"connectPostNL\",\n \"created_at\": \"2026-06-02 09:14:55\",\n \"function_name\": \"connectAPI\"\n },\n {\n \"id\": 60355,\n \"status\": \"stock_corrected\",\n \"user_id\": 1,\n \"title\": \"Stock corrected\",\n \"description\": \"Kiteboard Surge 134cm: 18 → 16\",\n \"created_at\": \"2026-06-05 10:12:44\",\n \"function_name\": \"correctStock\"\n },\n {\n \"id\": 60310,\n \"status\": \"api_deleted\",\n \"user_id\": 1,\n \"title\": \"API verwijderd: Magento (oud)\",\n \"description\": \"deleteAPI\",\n \"created_at\": \"2026-05-12 14:02:08\",\n \"function_name\": \"deleteAPI\"\n }\n ]\n}"}],"_postman_id":"2f4cbf38-60fc-4713-9c65-a74eb0c68f8c"}],"id":"514434c6-b759-42c2-b909-157ec6ef99de","description":"Retrieve activity logs for users associated with the seller account.
\n","_postman_id":"514434c6-b759-42c2-b909-157ec6ef99de"},{"name":"Tasks","item":[{"name":"Get tasks","id":"258455f8-00b2-471f-aacf-87e1990cb29b","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/tasks?page=1","description":"List tasks for the authenticated seller (tasks.seller_id). Returns all statuses unless you filter with status.
Default pagination: 50 items per page (max 100). Sort by created_at using sort_dir (default DESC).
Planned datetimes are stored in UTC; send filter dates in a format accepted by the API.
\n","urlObject":{"path":["portal","api","v2","seller","tasks"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional (default 50, max 100)
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional (ASC | DESC, sorts on created_at)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional (single task, internal tasks.id)
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"optional (open, in_progress, waiting, completed, cancelled — comma-separated allowed)
\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"optional (assignee user id, must be account employee)
\n","type":"text/plain"},"key":"planned_for_user_id","value":""},{"disabled":true,"description":{"content":"optional (ChannelDock order id)
\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"product_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"return_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"task_category_id","value":""},{"disabled":true,"description":{"content":"optional (filter tasks linked to this fulfillment center)
\n","type":"text/plain"},"key":"center_id","value":""},{"disabled":true,"description":{"content":"optional (partial match on title and description)
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"optional (filters planned_datetime)
\n","type":"text/plain"},"key":"date_from","value":"2026-01-01"},{"disabled":true,"description":{"content":"optional (filters planned_datetime)
\n","type":"text/plain"},"key":"date_to","value":"2026-12-31"}],"variable":[]}},"response":[{"id":"20db8f66-c83f-4431-935e-889018f1ec3c","name":"Get tasks","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/tasks?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","seller","tasks"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"tasks\": [\n {\n \"id\": 123,\n \"title\": \"Check stock\",\n \"description\": \"Verify shelf A3\",\n \"status\": \"open\",\n \"created_at\": \"2026-03-24 10:00:00\",\n \"completed_at\": null,\n \"planned_datetime\": \"2026-03-25 14:00:00\",\n \"planned_end_datetime\": null,\n \"created_by_user_id\": 1,\n \"planned_for_user_id\": 42,\n \"order_id\": null,\n \"product_id\": 17007,\n \"return_id\": null,\n \"delivery_id\": null,\n \"seller_id\": 2,\n \"center_id\": null,\n \"task_category_id\": 5,\n \"task_price\": 0,\n \"task_currency\": \"EUR\",\n \"is_internal\": false\n }\n ]\n}"}],"_postman_id":"258455f8-00b2-471f-aacf-87e1990cb29b"},{"name":"Create task","id":"2917658d-bb85-48a4-8435-55d5ff3ca9ba","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Pick extra units for order\",\n \"description\": \"Customer called\",\n \"planned_for_user_id\": 42,\n \"planned_datetime\": \"2026-03-25 09:00:00\",\n \"order_id\": 3161,\n \"task_category_id\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/tasks","description":"Create a new task for the seller account.
\nRequired: title
Optional: description, planned_for_user_id, planned_datetime, planned_end_datetime, order_id, product_id, return_id, delivery_id, task_category_id (or category_id), task_price, task_currency (default EUR), center_id (only if the fulfillment center is connected).
Rules:
\nopen.is_internal is always false for sellers.center_id is not set (seller-owned categories).planned_datetime and planned_end_datetime are interpreted in the seller account timezone and stored as UTC.Create and list operational tasks (to-dos) for the seller account. Tasks can be linked to orders, products, returns, or deliveries, and optionally assigned to a fulfillment center.
\nEnable Tasks (GET and POST) on your API key in ChannelDock settings before calling these endpoints.
\n","_postman_id":"9adc381f-4a9a-4cac-bac8-240d86beb76b"},{"name":"Inventory logs","item":[{"name":"Get Inventory logs","id":"60490b9e-476b-44e5-9716-9c7bf35ad104","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/seller/stockmutations?ean=8719326583617","description":"This endpoint allows users to retrieve event data based on specific criteria. It is particularly useful for fetching details related to a product's events within a defined date range.
\nThe following parameters are required in the query string of the GET request:
\nean (string) (optional if Product ID / SKU is not used): The European Article Number (EAN) of the product. This is a unique identifier used to specify the product for which event data is being requested.
\nproduct_id (string) (optional if EAN / SKU is not used): The unique identifier for the product. This ID is used alongside the EAN to ensure accurate retrieval of event data.
\nsku (string) (optional if Product ID / EAN is not used)
\nstart_date (datetime): The starting date and time for the event data retrieval. The format should be YYYY-MM-DD HH:MM:SS. This parameter defines the beginning of the time range for the events you want to fetch.
end_date (datetime): The ending date and time for the event data retrieval. The format should be YYYY-MM-DD HH:MM:SS. This parameter defines the end of the time range for the events you want to fetch.
event_action (string): The action type of the event you are interested in. In this case, the value is set to \"correct\", indicating that you want to retrieve events related to this specific action.
\nThe response from this endpoint will typically include a JSON object containing the following details:
\nstatus (string): Indicates the success or failure of the request.
\ndata (array): An array of event objects that match the specified criteria. Each event object may include details such as event ID, timestamp, and any additional relevant information related to the event.
\nmessage (string): A message providing additional context about the response, such as errors or warnings if applicable.
\nrequired if product_id is not used
\n","type":"text/plain"},"key":"ean","value":"8719326583617"},{"disabled":true,"description":{"content":"required if ean is not used (ChannelDock Product ID)
\n","type":"text/plain"},"key":"product_id","value":"23456765"},{"disabled":true,"description":{"content":"optional (date time)
\n","type":"text/plain"},"key":"start_date","value":"2025-08-13 00:00:00"},{"disabled":true,"description":{"content":"optional (date time)
\n","type":"text/plain"},"key":"end_date","value":"2025-08-17 23:00:00"},{"disabled":true,"description":{"content":"optional (make a call to this endpoint without this parameter to get an idea of the possible values)
\n","type":"text/plain"},"key":"event_action","value":"correct"}],"variable":[]}},"response":[{"id":"84be3049-007c-4f6d-a610-55d2b66caf34","name":"Get Inventory logs","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/stockmutations?ean=842143514325&event_action=correct","host":["https://channeldock.com"],"path":["portal","api","v2","seller","stockmutations"],"query":[{"key":"ean","value":"842143514325"},{"key":"event_action","value":"correct"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"inventory_logs\": [\n {\n \"id\": 71204,\n \"ean\": \"8719326583631\",\n \"event_action\": \"update_product_information\",\n \"message\": \"Updated fields: price, x_size, y_size\",\n \"old_stock\": 84,\n \"new_stock\": 84,\n \"created_at\": \"2026-06-12 14:32:18\",\n \"total_stock\": 84\n },\n {\n \"id\": 71198,\n \"ean\": \"8719326583631\",\n \"event_action\": \"add_stock_location\",\n \"message\": \"Lars van Schaick added product to stock location: Pick zone B - Shelf 12\",\n \"old_stock\": 36,\n \"new_stock\": 84,\n \"created_at\": \"2026-06-03 14:22:11\",\n \"total_stock\": 84\n },\n {\n \"id\": 71180,\n \"ean\": \"8719326583631\",\n \"event_action\": \"channel_sale\",\n \"message\": \"Order 88210 (WooCommerce) reserved 1 unit\",\n \"old_stock\": 85,\n \"new_stock\": 84,\n \"created_at\": \"2026-06-13 09:24:11\",\n \"total_stock\": 84\n },\n {\n \"id\": 71132,\n \"ean\": \"8719326583655\",\n \"event_action\": \"correct\",\n \"message\": \"Own stock amount updated: 18 → 16\",\n \"old_stock\": 18,\n \"new_stock\": 16,\n \"created_at\": \"2026-06-05 10:12:44\",\n \"total_stock\": 16\n }\n ]\n}"}],"_postman_id":"60490b9e-476b-44e5-9716-9c7bf35ad104"}],"id":"2d757a2b-6493-4d83-93ad-16c5849081a9","description":"Endpoints to retrieve a seller’s inventory change history. Supports filtering by EAN, product ID, date range, and event action, with pagination (250 items per page). Returns processed inventory log data for the authenticated seller. Filter by ean, product_id, or sku is recommended but optional.
\n","_postman_id":"2d757a2b-6493-4d83-93ad-16c5849081a9"},{"name":"Batches","item":[{"name":"Get Batch Templates","id":"7bfa7de7-41d0-4568-a365-813eeb526be8","request":{"method":"GET","header":[],"url":"https://channeldock.com/portal/api/v2/seller/batchtemplates?page=1","urlObject":{"path":["portal","api","v2","seller","batchtemplates"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional default: 50 max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"1, 2, 3"},{"disabled":true,"description":{"content":"optional (true | false | ALL)
\n","type":"text/plain"},"key":"active","value":"ALL"},{"disabled":true,"description":{"content":"optional (id | priority | active | created_at | updated_at)
\n","type":"text/plain"},"key":"sort_attr","value":"priority"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"include","value":"requirements"}],"variable":[]}},"response":[{"id":"e8ac5449-5bba-4c47-ab38-ebe2ae4c0f77","name":"Get Batch Templates","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/batchtemplates?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","seller","batchtemplates"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"batch_templates_count\": 2,\n \"batch_templates\": [\n {\n \"id\": 401,\n \"seller_id\": 1,\n \"center_id\": 0,\n \"description\": \"Standard NL Orders\",\n \"priority\": 1,\n \"active\": true,\n \"match_type\": \"all\",\n \"max_orders\": 100,\n \"max_order_items\": null,\n \"pick_algorithm\": \"fifo\",\n \"batch_category\": \"standard\",\n \"created_at\": \"2026-04-01 09:00:00\",\n \"updated_at\": \"2026-06-10 12:30:00\",\n \"requirements\": [\n {\n \"requirement\": \"country\",\n \"operator\": \"equals\",\n \"value\": \"NL\"\n },\n {\n \"requirement\": \"order_status\",\n \"operator\": \"equals\",\n \"value\": \"order\"\n }\n ]\n },\n {\n \"id\": 402,\n \"seller_id\": 1,\n \"center_id\": 0,\n \"description\": \"Bol.com Express\",\n \"priority\": 2,\n \"active\": true,\n \"match_type\": \"all\",\n \"max_orders\": 50,\n \"max_order_items\": 200,\n \"pick_algorithm\": \"lifo\",\n \"batch_category\": \"express\",\n \"created_at\": \"2026-04-15 11:20:00\",\n \"updated_at\": \"2026-06-08 09:00:00\",\n \"requirements\": [\n {\n \"requirement\": \"channel\",\n \"operator\": \"equals\",\n \"value\": \"bolcom\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"7bfa7de7-41d0-4568-a365-813eeb526be8"},{"name":"Get Batches","id":"065ff011-b0a4-4585-be4b-df8d824d961d","request":{"method":"GET","header":[],"url":"https://channeldock.com/portal/api/v2/seller/batches?page=1","urlObject":{"path":["portal","api","v2","seller","batches"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional default: 50 max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"1, 2, 3"},{"disabled":true,"description":{"content":"optional (pending | picking | picked | packing | shipped)
\n","type":"text/plain"},"key":"batch_status","value":"pending"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"batch_template_id","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"created_at_from","value":"YYYY-mm-dd"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"created_at_to","value":"YYYY-mm-dd"},{"disabled":true,"description":{"content":"optional (id | created_at | batch_status | batch_template_id)
\n","type":"text/plain"},"key":"sort_attr","value":"id"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional (template | template_requirements | counts | orders | order_products)
\n","type":"text/plain"},"key":"include","value":"template, counts"}],"variable":[]}},"response":[{"id":"515c1799-40cf-499f-8c48-4e1a47612cd3","name":"Get Batches","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/batches?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","seller","batches"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"batches_count\": 2,\n \"batches\": [\n {\n \"id\": 11001,\n \"seller_id\": 1,\n \"batch_title\": \"Morning batch 2026-06-14\",\n \"batch_status\": \"picking\",\n \"batch_template_id\": 401,\n \"assigned_user_id\": 1,\n \"batch_cart_number\": \"batch_cart_A12\",\n \"created_at\": \"2026-06-14 08:00:00\",\n \"updated_at\": \"2026-06-14 08:15:30\",\n \"template\": {\n \"id\": 401,\n \"description\": \"Standard NL Orders\"\n },\n \"orders\": [\n {\n \"id\": 88210,\n \"seller_id\": 1,\n \"order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"order_status\": \"order\",\n \"order_date\": \"2026-06-13 09:24:11\",\n \"ship_on_date\": \"2026-06-14\",\n \"shipping_first_name\": \"Lars\",\n \"shipping_last_name\": \"van Schaick\",\n \"shipping_country_code\": \"NL\"\n }\n ]\n },\n {\n \"id\": 11002,\n \"seller_id\": 1,\n \"batch_title\": \"Afternoon batch 2026-06-14\",\n \"batch_status\": \"pending\",\n \"batch_template_id\": 402,\n \"assigned_user_id\": null,\n \"batch_cart_number\": null,\n \"created_at\": \"2026-06-14 12:30:00\",\n \"updated_at\": \"2026-06-14 12:30:00\",\n \"template\": {\n \"id\": 402,\n \"description\": \"Bol.com Express\"\n },\n \"orders\": []\n }\n ]\n}"}],"_postman_id":"065ff011-b0a4-4585-be4b-df8d824d961d"},{"name":"Update batch status","id":"8ac6d08f-8583-44ac-a832-dc674a8a0a8a","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"[\n {\n \"batch_id\": 8279454,\n \"batch_status\": \"picking\",\n \"assign_user_id\": \"user@example.com\",\n \"batch_cart_number\": \"batch_cart_A12\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/seller/batches","description":"Update the status of one or more batches. You can also record which pick cart or box a batch was picked into.
\nSend a single object, or an array of objects (max 200). If the same batch_id appears more than once, only the last object is applied.
batch_id (integer) or batch_ids (array of integers) — required. Use batch_ids only on a single-object request.batch_status (string, required) — pending | picking | picked | packing | shippedassign_user_id (integer or string, required) — user ID or email of the picker/packer. This is not necessarily the API key owner.batch_cart_number (string, optional) — cart/box codes for this batch. Same format as in the portal: each code must start with batch_cart_. Multiple codes may be separated by commas, spaces or semicolons (they are stored as a comma-separated string). Max 100 characters after normalization. Send an empty string to clear the cart. A non-empty cart can only be set when updating a single batch.batch_status, assigned_user_id, batch_cart_numberupdated_ids, updated_count — batches whose status was updatedcart_updated_ids — batches whose cart number was updatedskipped, skipped_count — batches that could not be updated (with a reason)The Batches API allows you to retrieve and update batch information for your seller account. Batches represent groups of orders that are processed together for picking, packing, and shipping operations. PUT can also set batch_cart_number (cart/box codes starting with batch_cart_) on a single batch.
The seller API can be used to fetch products, PIM listings, connected channels, bundles, product tags, stock locations and inbounds from the seller account.
\nThe base URL is: https://channeldock.com
\n","_postman_id":"84daad8d-aad4-44e7-b4d1-f9ac69566c62"},{"name":"ChannelDock Fulfillment Center","item":[{"name":"Home","item":[{"name":"Home endpoint","id":"00f2dcf4-8c45-419d-8074-9d1eb2de76a5","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/","urlObject":{"path":["portal","api","v2",""],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"59ddc597-8706-4baa-a9ad-0c3ca589380a","name":"Home endpoint","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"url":"https://channeldock.com/portal/api/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"API v2 auth is valid, good luck integrating the ChannelDock API!\"\n}"}],"_postman_id":"00f2dcf4-8c45-419d-8074-9d1eb2de76a5"}],"id":"be1ff66d-61ae-46d8-bbc1-8b44d22648a9","_postman_id":"be1ff66d-61ae-46d8-bbc1-8b44d22648a9","description":""},{"name":"Products","item":[{"name":"Get products","id":"ad10613f-4500-44a8-913c-3e8acdc434fb","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/center/inventory?page=1","description":"Products that are connected to a fulfillment center account can be viewed by this API. The seller can connect his / her products to your FC account using their own seller account. Product attributes are then initially copied over from the seller product onto the newly created FC product.
\nChannelDock uses the EAN to identify products cross platform for its inventory synchronisation functionality. Please note that EAN will never be NULL, while SKU could be NULL.
This request's return results are paginated. The API returns 50 items per page.
\nis_flagged (optional): true/false or 1/0. Same product flag as in the portal product list. Omit to return all products.
Filter by FC product tag with tag_id or tag_title. Each product includes tags (title strings) and product_tags (id, title, color).
archived (optional): true/false or 1/0. Same archive setting as on the linked seller product. Omit to return all products; the archived field is always included in each product (1 or 0). Use archived=true to list only archived products.
sort_attr may be archived (with sort_dir ASC or DESC).
optional: id of the product
\n","type":"text/plain"},"key":"id","value":"8"},{"disabled":true,"description":{"content":"optional: id of the seller
\n","type":"text/plain"},"key":"seller_id","value":"2"},{"disabled":true,"description":{"content":"optional (Out of stock | default: Active | Paused by center | Paused by seller | Deleted by center | Deleted by seller)
\n","type":"text/plain"},"key":"center_product_status","value":"Active"},{"disabled":true,"description":{"content":"optional: ean of the product
\n","type":"text/plain"},"key":"ean","value":"8719326583631"},{"disabled":true,"description":{"content":"optional: SKU of the product
\n","type":"text/plain"},"key":"sku","value":""},{"disabled":true,"description":{"content":"optional: product reference of the product
\n","type":"text/plain"},"key":"product_reference","value":""},{"disabled":true,"description":{"content":"optional: (free input) location of the product
\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"optional (id | seller_id | ean | center_product_status | sku | product_reference | location | updated_at | archived)
\n","type":"text/plain"},"key":"sort_attr","value":"updated_at"},{"disabled":true,"description":{"content":"optional ( DESC | default: ASC )
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional: includes stock location data
\n","type":"text/plain"},"key":"include_stock_location_data","value":"true"},{"disabled":true,"description":{"content":"optional: true/false or 1/0 to list only flagged or unflagged products
\n","type":"text/plain"},"key":"is_flagged","value":"true"},{"disabled":true,"description":{"content":"optional, only products with this FC tag
\n","type":"text/plain"},"key":"tag_id","value":"21"},{"disabled":true,"description":{"content":"optional, exact tag title (case-insensitive)
\n","type":"text/plain"},"key":"tag_title","value":"fragile"},{"disabled":true,"description":{"content":"optional: true/false or 1/0 to list only archived or unarchived seller products
\n","type":"text/plain"},"key":"archived","value":"true"}],"variable":[]}},"response":[{"id":"0cf11b7d-ec2f-417f-b2e9-92c3cea549aa","name":"Get products","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://channeldock.com/portal/api/v2/center/inventory?page=1&sort_attr=updated_at&sort_dir=DESC","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","inventory"],"query":[{"key":"page","value":"1"},{"key":"id","value":"6","description":"optional: id of the product","disabled":true},{"key":"seller_id","value":"3","description":"optional: id of the seller","disabled":true},{"key":"center_product_status","value":"Active","description":"optional (Out of stock | default: Active | Paused by center | Paused by seller | Deleted by center | Deleted by seller)","disabled":true},{"key":"ean","value":"8719326801019","description":"optional: ean of the product","disabled":true},{"key":"sku","value":"","description":"optional: SKU of the product","disabled":true},{"key":"product_reference","value":"","description":"optional: product reference of the product","disabled":true},{"key":"location","value":"","description":"optional: (free input) location of the product","disabled":true},{"key":"is_flagged","value":"true","description":"optional: true/false or 1/0 to list only flagged or unflagged products","disabled":true},{"key":"archived","value":"true","description":"optional: true/false or 1/0 to list only archived or unarchived seller products","disabled":true},{"key":"sort_attr","value":"updated_at","description":"optional (id | seller_id | ean | center_product_status | sku | product_reference | location | updated_at | archived)"},{"key":"sort_dir","value":"DESC","description":"optional ( DESC | default: ASC )"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"products_count\": 3,\n \"products\": [\n {\n \"id\": 7,\n \"seller_id\": 2,\n \"ean\": \"8719326583631\",\n \"center_product_status\": \"Active\",\n \"active_stock\": 48,\n \"weight\": 1.8,\n \"x_size\": 60,\n \"y_size\": 12,\n \"z_size\": 8,\n \"sku\": \"UPW-BAR-52\",\n \"product_reference\": \"UPW-REF-001\",\n \"units_per_box\": 1,\n \"location\": \"B-12\",\n \"updated_at\": \"2026-06-12 14:32:18\",\n \"packaging_category_id\": 4,\n \"is_flagged\": 1,\n \"archived\": 0,\n \"tags\": [\n \"kitesurf\",\n \"control-bar\"\n ],\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"img_url\": \"https://cdn.upwind.example.com/products/kitesurf-bar-pro-52.jpg\",\n \"classification\": \"Watersports\",\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\",\n \"packaging\": \"Box\",\n \"child_products\": [],\n \"stock_location_data\": [\n {\n \"stock_section_id\": 2716,\n \"stock_location_id\": 114,\n \"stock_section_description\": \"Pick zone B - Shelf 12\",\n \"stock\": 48,\n \"corrected_stock\": 48,\n \"include_in_stock_sync\": 1,\n \"pick_location\": 1\n }\n ]\n },\n {\n \"id\": 8,\n \"seller_id\": 2,\n \"ean\": \"8719326583648\",\n \"center_product_status\": \"Active\",\n \"active_stock\": 36,\n \"weight\": 1.4,\n \"x_size\": 35,\n \"y_size\": 25,\n \"z_size\": 6,\n \"sku\": \"UPW-WET-M\",\n \"product_reference\": \"UPW-REF-002\",\n \"units_per_box\": 1,\n \"location\": \"B-13\",\n \"updated_at\": \"2026-06-10 08:21:44\",\n \"packaging_category_id\": 4,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"tags\": [\n \"wetsuit\",\n \"neoprene\"\n ],\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"img_url\": \"https://cdn.upwind.example.com/products/wetsuit-predator-5-4-m.jpg\",\n \"classification\": \"Watersports\",\n \"country_of_origin\": \"TH\",\n \"product_classification\": \"6110309100\",\n \"packaging\": \"Bag\",\n \"child_products\": [],\n \"stock_location_data\": [\n {\n \"stock_section_id\": 2717,\n \"stock_location_id\": 115,\n \"stock_section_description\": \"Pick zone B - Shelf 13\",\n \"stock\": 36,\n \"corrected_stock\": 36,\n \"include_in_stock_sync\": 1,\n \"pick_location\": 1\n }\n ]\n },\n {\n \"id\": 9,\n \"seller_id\": 2,\n \"ean\": \"8719326583655\",\n \"center_product_status\": \"Active\",\n \"active_stock\": 12,\n \"weight\": 2.6,\n \"x_size\": 134,\n \"y_size\": 41,\n \"z_size\": 4,\n \"sku\": \"UPW-BRD-134\",\n \"product_reference\": \"UPW-REF-003\",\n \"units_per_box\": 1,\n \"location\": \"PR-A\",\n \"updated_at\": \"2026-06-08 12:05:31\",\n \"packaging_category_id\": 5,\n \"is_flagged\": 0,\n \"archived\": 0,\n \"tags\": [\n \"kiteboard\",\n \"twintip\"\n ],\n \"title\": \"Kiteboard Surge 134cm\",\n \"img_url\": \"https://cdn.upwind.example.com/products/kiteboard-surge-134.jpg\",\n \"classification\": \"Watersports\",\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\",\n \"packaging\": \"Oversize\",\n \"child_products\": [],\n \"stock_location_data\": [\n {\n \"stock_section_id\": 2715,\n \"stock_location_id\": 113,\n \"stock_section_description\": \"Pallet rack A\",\n \"stock\": 12,\n \"corrected_stock\": 12,\n \"include_in_stock_sync\": 1,\n \"pick_location\": 0\n }\n ]\n }\n ]\n}"}],"_postman_id":"ad10613f-4500-44a8-913c-3e8acdc434fb"},{"name":"Update product","id":"4dc129fc-97fb-4f89-b918-8615525f224a","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 25,\n \"active_stock\": 1000,\n \"weight\": 1,\n \"x_size\": 2,\n \"y_size\": 0,\n \"z_size\": 2,\n \"sku\": \"TestSKU\",\n \"product_reference\": \"Referentie\",\n \"packaging\": \"Bag\",\n \"tags\": [\"kitesurf\", \"outlet\"],\n \"is_flagged\": true,\n \"archived\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inventory","description":"This API allows you to update the stock level and other attributes of a product. If the stock level is above 0, ChannelDock will automatically change the 'center_product_status' to 'Active'. If the stock synchronisation is turned on for this product in the sellers' account, ChannelDock will automatically update the stock level to the connected sales channels.
\ntags (array of strings, optional): Tag titles to assign to the center product. Unknown titles are automatically created (scoped to your center account, separate from seller tags). Full replacement: any tags currently on the product that are not in this array are removed. Omit the tags field entirely to leave existing tags untouched; send \"tags\": [] to remove all tags. The synced tags are returned inside updated_fields.tags in the response.
is_flagged (boolean, optional): Same product flag as in the portal product list (true/false or 1/0). Applies to the fulfillment-center product only. Omit to leave the current flag unchanged. Returned in updated_fields when set.
archived (boolean, optional): Same archive setting as on the linked seller product (true/false or 1/0). Omit to leave the current archive state unchanged. Returned in updated_fields when set.
This POST call allows you to create a new product. When making this call, ChannelDock will create a product in the Seller account and also connect that product to your fulfillment center account.
\ntags (array of strings, optional): Tag titles to assign to the center product. Unknown titles are automatically created (scoped to your center account, separate from seller tags). Omit this field entirely to leave tags untouched; send an empty array [] to remove all tags. The response only confirms product_id, not the resulting tags — use a GET to verify.
is_flagged (boolean, optional): Same product flag as in the portal product list (true/false or 1/0). Applies to the fulfillment-center product only, not the seller product. Defaults to not flagged when omitted.
archived (boolean, optional): Same archive setting as on the seller product (true/false or 1/0). Applied to the seller product when it is created or already exists. Defaults to not archived when omitted.
Bulk update stock levels in ChannelDock.
\n","urlObject":{"path":["portal","api","v2","center","stockupdateall"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"14c6818d-e036-453f-9067-733d6269ca7f","name":"Update stock amount bulk","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"product_id\": \"30\", \n \"stock_amount\": 50\n }, \n {\n \"product_id\": \"32\", \n \"stock_amount\": 150\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stockupdateall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": [\n {\n \"sku\": \"UPW-BAR-52\",\n \"stock_amount\": 48\n },\n {\n \"sku\": \"UPW-WET-M\",\n \"stock_amount\": 36\n },\n {\n \"sku\": \"UPW-BRD-134\",\n \"stock_amount\": 12\n }\n ]\n}"}],"_postman_id":"403b0b29-f701-4294-b53f-b425ff4336c2"}],"id":"1a6c9a7f-04bb-4a99-b9d7-5452605d68ca","description":"The products API allows you to view and update individual, or a batch, of products.
\n","_postman_id":"1a6c9a7f-04bb-4a99-b9d7-5452605d68ca"},{"name":"Bundles","item":[{"name":"Get bundles","id":"ea8b1879-90d7-4ca7-a6d0-6f0ccab24c7a","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/bundles","description":"List bundle products stocked at this fulfillment center.
\nOptional filters: product_id (catalog product id), ean.
optional (catalog parent product id)
\n","type":"text/plain"},"key":"product_id","value":"25860"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"ean","value":"8719326583700"}],"variable":[]}},"response":[{"id":"14f9d341-8e9e-48a5-850a-c419b031ffc7","name":"Get bundles","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/bundles","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","bundles"],"query":[{"key":"product_id","value":"25860","description":"optional (catalog parent product id)","disabled":true},{"key":"ean","value":"8719326583700","description":"optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"bundles_count\": 1,\n \"bundles\": [\n {\n \"parent_product_id\": 25860,\n \"parent_center_product_id\": 4412,\n \"parent_ean\": \"8719326583700\",\n \"parent_sku\": \"UPW-BUNDLE-STARTER\",\n \"parent_title\": \"Upwind starter bundle\",\n \"seller_id\": 1184,\n \"stock\": 12,\n \"child_products\": [\n {\n \"bundle_row_id\": 901,\n \"child_product_id\": 25851,\n \"child_ean\": \"8719326583631\",\n \"child_sku\": \"UPW-BAR-52\",\n \"child_title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"quantity\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"ea8b1879-90d7-4ca7-a6d0-6f0ccab24c7a"},{"name":"Create bundle","id":"b4e4a1cd-7f72-42fb-9e00-568e9a10b504","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"parent_center_product_id\": 4412,\n \"children\": [\n { \"child_product_id\": 25851, \"quantity\": 1 },\n { \"child_product_id\": 25856, \"quantity\": 1 }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/bundles","description":"Create a bundle from an existing FC product and add children.
\nRequired: parent_center_product_id (id from GET /center/inventory), children (child_product_id is the catalog product id; the child must be stocked at this center). Parent available stock must be 0 if converting from a regular product.
Add and/or remove children on an existing bundle.
\nRequired: parent_product_id (catalog id, not FC product id). Optional: add_children, remove_children.
Convert a bundle back to a regular product. Stock is reset to 0 and all children are removed.
\nRequired: parent_product_id (catalog id).
Create and manage product bundles for products stocked at this fulfillment center.
\nCreate uses parent_center_product_id (the FC product id from GET inventory). Children are catalog child_product_id values that must be stocked at this center. Cross-seller children are allowed when both sellers are connected to the FC.
Enable Bundles (GET, POST, PUT, DELETE) on your API key.
\n","_postman_id":"b9efa059-52ad-4446-978f-e268c825b152"},{"name":"Product tags","item":[{"name":"Get product tags","id":"68b9aebd-b0ed-424a-a115-7d1b671da68d","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/product-tags?page=1","description":"List FC product tags. Paginated: 50 per page. Optional search/q or tag_id.
optional (default 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"search","value":"fragile"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"tag_id","value":"21"}],"variable":[]}},"response":[{"id":"7cb6a020-0f28-4cd3-a201-4d4488a53100","name":"Get product tags","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/product-tags?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","product-tags"],"query":[{"key":"page","value":"1","description":"optional (default 1)"},{"key":"search","value":"fragile","description":"optional","disabled":true},{"key":"tag_id","value":"21","description":"optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"product_tags_count\": 1,\n \"total_matching\": 1,\n \"page\": 1,\n \"product_tags\": [\n { \"id\": 21, \"title\": \"fragile\", \"color\": \"#cc0000\", \"product_count\": 6 }\n ]\n}"}],"_postman_id":"68b9aebd-b0ed-424a-a115-7d1b671da68d"},{"name":"Create product tag","id":"a5f1c1ee-bfbf-44ce-b412-a37ea75520ca","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"title\": \"fragile\",\n \"color\": \"#cc0000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/product-tags","description":"Create an FC product tag. Required title. Optional color (#rgb / #rrggbb).
Update an FC tag. Required tag_id. Optional title, color.
Delete an FC tag and unlink it from all center products. Required tag_id.
Attach an FC tag to center products.
\nIdentify the tag with tag_id or title. Identify products with product_id / product_ids (center product ids), or ean / sku. Max 500 products per request.
Detach an FC tag from center products. Same identification as attach. HTTP POST or DELETE.
\n","urlObject":{"path":["portal","api","v2","center","product-tags","detach"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"7250ffb7-e02b-4cdd-bc50-acb9da65c9e4","name":"Detach product tags","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"tag_id\": 21,\n \"product_ids\": [4411]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/product-tags/detach"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"tag_id\": 21,\n \"detached_count\": 1,\n \"not_linked_count\": 0,\n \"product_count\": 1\n}"}],"_postman_id":"c6f7ba94-5d23-45c6-8a54-7544ae765f40"}],"id":"5182c931-469e-4cd0-b740-8ad4cf4b8831","description":"Manage product tags owned by this fulfillment center (tags scoped to center_id).
Attach/detach uses center product ids from GET /center/inventory (product_id / product_ids), not seller catalog ids. You can also pass ean or sku.
Enable Product Tags, Product Tags Attach, and Product Tags Detach on your API key.
\n","_postman_id":"5182c931-469e-4cd0-b740-8ad4cf4b8831"},{"name":"Orders","item":[{"name":"Get Orders","id":"06700ff8-6291-4b87-a0e5-1a68384f6941","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/orders?page=1","description":"Retrieve paginated orders for the current fulfillment center, including order lines and optional raw data, traceability data and inventory logs.
\nThe endpoint returns only orders that belong to sellers linked to the current fulfillment center. By default it includes only orders with status order or backorder, and only where the shipping address is marked as accurate.
\npage (required, integer)
\n1-based page number. If omitted, the API returns a 400 (\"No page specified.\").
\npage_size (optional, integer)
\nNumber of orders per page.
\nMust be between 1 and 100.
\nIf omitted, the API uses its internal default page size.
\nid (optional, integer)
\nChannelDock Order ID. If set, only this order is returned and the default order_status filter is not applied.
\norder_id (optional, string)
\nRemote order ID from the sales channel.
\nMatches against both order_id and seq_order_id.
\nseller_id (optional, integer)
\nFilter by seller (must be one of the sellers connected to this fulfillment center).
\n\n\nNotes
\n
id = ChannelDock internal Order ID
order_id = remote Order ID from the marketplace / webshop where the order originated
order_status (optional, enum)
\nThe order_status enum values are:
\norder (default)
\nshipment
\nreturn
\npending
\non-hold
\nbackorder
\ncancelled
\nrefunded
\nfailed
\ntrash
\nUse ALL to fetch orders regardless of status.
\nIf omitted (and id is not set): the API returns orders where order_status is order or backorder.
\norder_status=ALL: return orders regardless of status.
\nAny other value: filter on that specific status (e.g. order_status=shipped).
\norder_status=backorder
\nSpecial case. Returns backorders: order lines that are not yet assigned to any fulfillment center (center_id = 0).
\nIn this case, product lines are not filtered on the current center.
\nEach of these filters is optional and performs an exact match:
\nshipping_first_name
\nshipping_last_name
\nshipping_company
\nshipping_street
\nshipping_house_number
\nshipping_house_number_ext
\nshipping_region
\nshipping_country_code
\nshipping_city
\nshipping_email
\norder_date (optional, date Y-m-d)
\nReturns orders with order_date on this exact date.
\nstart_date (optional, datetime or date)
\nReturns orders with order_date >= start_date.
\nend_date (optional, datetime or date)
\nReturns orders with order_date <= end_date.
\nIf end_date is passed as date only (Y-m-d), it is treated as Y-m-d 23:59:59 (includes the entire day).
\nship_on_date (optional, datetime or date)
\nExact match on ship_on_date.
\nYou can filter orders by their last update timestamp using the updated_at parameters:
\nupdated_at (optional, date Y-m-d)
\nExact date match on updated_at (date only).
\nupdated_at_from (optional, date or datetime)
\nReturns orders with updated_at >= updated_at_from.
\nupdated_at_to (optional, date or datetime)
\nReturns orders with updated_at <= updated_at_to.
\nIf updated_at_to is passed as date only (Y-m-d), it is interpreted as Y-m-d 23:59:59 to include the full day.
\nExamples
\nupdated_at=2024-01-15
\n→ Orders updated on 2024-01-15.
\nupdated_at_from=2024-01-01&updated_at_to=2024-01-31
\n→ Orders updated in January 2024.
\nYou can filter orders by their sync_date using:
\nsync_date_from (optional, date or datetime)
\nReturns orders with sync_date >= sync_date_from.
\nAccepts 'Y-m-d' (treated as 00:00:00) or 'Y-m-d H:i:s'.
\nsync_date_to (optional, date or datetime)
\nReturns orders with sync_date <= sync_date_to.
\nAccepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\nPreferred over updated_at filters for polling since sync_date only changes on order create or explicit sync, not on internal batch reassignments.
\nFilters apply to order lines assigned to your fulfillment center. Not used when order_status=backorder.
fulfillment_status (optional, string)
\n Orders with at least one assigned line matching this exact fulfillment_status.
Example: fulfillment_status=default for lines not yet marked imported into your WMS.
fulfillment_status_exclude (optional, string)
\n Orders with at least one assigned line where fulfillment_status is not equal to this value.
Example: fulfillment_status_exclude=imported for orders that still have unimported lines.
Writable via PUT (Update an order) or POST fulfillment-status: any custom status (1–50 chars, lowercase letters, digits, underscore, hyphen). Integration-reserved patterns (e.g. *_pending, disconnected_from_fc) cannot be set via API.
By default, orders are returned when at least one line is assigned to your fulfillment center. Mixed orders (some lines at the FC, some still at the seller) are included.
\nskip_partial_orders (optional, 0, 1, true, or false)
When 1 or true: exclude orders that still have open seller lines (center_id = 0, not shipped, no cancellation request). Only fully FC-assigned open orders are returned.
When omitted or 0: no extra filter (partial orders remain visible).
Not used when order_status=backorder.
Mirrors the per-seller Skip partial orders setting in the portal (Fulfillment → Sellers), but applies only when you pass this query parameter on the API request.
\nshipping_address_accurate (optional, 0, 1, or ALL)
\nIf omitted: only orders where shipping_address_accurate = 1 are returned.
\nshipping_address_accurate=ALL: no filter is applied (both accurate and inaccurate).
\nAny other value: cast to boolean and filter accordingly.
\ninclude_seller_handled (optional, \"true\"/\"1\"/\"yes\")
\n By default, only order lines assigned to your fulfillment center (center_id = your center) are matched and returned. Orders that were handled directly by the seller (order lines with center_id = 0) are otherwise invisible via this endpoint, even when looked up by id or order_id.
When set to a truthy value:
\ncenter_id in (your center, 0), so seller-handled orders are found.order_status IN (order, backorder) filter is skipped, since seller-handled orders are typically already shipped or returned.center_id = 0) are included in the order_products array of the response, alongside any lines assigned to your center. Use this to look up order data for returns on orders that the seller fulfilled themselves — e.g. GET /center/orders?page=1&id=23487271&include_seller_handled=true.
Backward compatible: default behavior (flag omitted) is unchanged.
\nsort_attr (optional, string)
\nAllowed values: id, order_id, order_date, ship_on_date, order_status, sync_date, updated_at.
\nDefaults to id if an unsupported attribute is provided.
\nsort_dir (optional, string)
\nSort direction: asc or desc (case-insensitive).
\nDefaults to DESC if not asc/ASC.
\nIf both sort_attr and sort_dir are provided, the result is sorted accordingly.
\ninclude_raw_order_data (optional, \"true\"/\"false\")
\nWhen \"true\", includes raw_order_data with the original payload from the sales channel (if available).
\ninclude_serial_numbers (optional, \"true\"/\"false\")
\nWhen \"true\", enables traceability data for order lines (serial numbers, batch IDs, expiration dates).
\nThis is internally treated as enabling traceability.
\ninclude_traceability_data (optional, \"true\"/\"false\")
\nSame effect as include_serial_numbers; when \"true\", adds traceability_data to each order line.
\ninclude_inventory_log (optional, \"true\"/\"false\")
\nWhen \"true\", includes inventory_logs for each order (based on the ChannelDock order ID).
\ninclude_shipping_label_addresses (optional, string — comma-separated carrier slugs)
\n Example: include_shipping_label_addresses=postnl,sendcloud,generic
When provided, each order in the response will include a shipping_label_addresses object keyed by carrier slug. Each entry contains the sanitized address as stored in the shipping label for that carrier.
Supported slugs: generic, bolcom, myparcel, dpdnl, dhlnl, dhlde, internetmarke, ampere, amperev2, postnl, gls, bpost, sendcloud, wuunder, shipcloud, shipstation, sendy, sendwise, parcelpro, qls, shipit, gls_shipit, ups, hermes, monta, easyship, amazon_easyship, landmark, trunkrs, asendia, fedex
\nUnsupported slugs are silently ignored.
\n PII / privacy: If api_pii_enabled = 0 for the seller, the shipping_label_addresses field is redacted (not returned).
Backward compatibility: The existing flat shipping_* fields on the order are unchanged.
Response field structure (shipping_label_addresses):
Each key is a carrier slug. Each value is an object with:
\nExample response snippet:
\n{\n \"shipping_label_addresses\": {\n \"postnl\": {\n \"first_name\": \"Jan\",\n \"last_name\": \"de Vries\",\n \"full_name\": \"Jan de Vries\",\n \"street\": \"Hoofdstraat\",\n \"house_number\": \"12\",\n \"house_number_ext\": \"A\",\n \"house_number_full\": \"12A\",\n \"address_line1\": \"Hoofdstraat 12\",\n \"address_line2\": \"A\",\n \"postal_code\": \"1234AB\",\n \"city\": \"Amsterdam\",\n \"region\": null,\n \"country_code\": \"NL\",\n \"email\": \"jan@example.com\",\n \"phone\": \"+31612345678\",\n \"is_complete\": true,\n \"warnings\": []\n },\n \"sendcloud\": {\n \"first_name\": \"Jan\",\n \"last_name\": \"de Vries\",\n \"full_name\": \"Jan de Vries\",\n \"street\": \"Hoofdstraat\",\n \"house_number\": \"12\",\n \"house_number_ext\": \"A\",\n \"house_number_full\": \"12A\",\n \"address_line1\": \"Hoofdstraat 12\",\n \"address_line2\": \"A\",\n \"postal_code\": \"1234AB\",\n \"city\": \"Amsterdam\",\n \"region\": null,\n \"country_code\": \"NL\",\n \"email\": \"jan@example.com\",\n \"phone\": \"+31612345678\",\n \"is_complete\": true,\n \"warnings\": []\n }\n }\n}\noptional: ChannelDock order id
\n","type":"text/plain"},"key":"id","value":"3215746"},{"disabled":true,"key":"seller_id","value":"2"},{"disabled":true,"description":{"content":"optional ( default: order+backorder | shipment | return | pending | on-hold | backorder | cancelled | refunded | failed | trash | ALL )
\n","type":"text/plain"},"key":"order_status","value":"shipment"},{"disabled":true,"description":{"content":"optional: special case. Returns order lines NOT YET assigned to any fulfillment center (center_id=0), instead of lines assigned to your own center. Ignores skip_partial_orders and fulfillment_status filters. Not the same as 'only orders whose status literally is backorder' — order_status IN (order, backorder) lines with an unassigned product line are included too.
\n","type":"text/plain"},"key":"order_status","value":"backorder"},{"disabled":true,"description":{"content":"optional: remote order id of the webshop / marketplace
\n","type":"text/plain"},"key":"order_id","value":"5576463548764"},{"disabled":true,"description":{"content":"optional: country code of order
\n","type":"text/plain"},"key":"shipping_country_code","value":"NL"},{"disabled":true,"description":{"content":"optional ( id | default: order_date | sync_date | updated_at )
\n","type":"text/plain"},"key":"sort_attr","value":"sync_date"},{"disabled":true,"description":{"content":"optional ( DESC | default: ASC )
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional: filter on address validation ( default: 1 | 0 | 'ALL')
\n","type":"text/plain"},"key":"shipping_address_accurate","value":"0"},{"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional ( date )
\n","type":"text/plain"},"key":"start_date","value":"2023-11-19"},{"disabled":true,"description":{"content":"optional ( date )
\n","type":"text/plain"},"key":"end_date","value":"2023-12-19"},{"disabled":true,"key":"include_raw_order_data","value":"false"},{"disabled":true,"key":"include_traceability_data","value":"true"},{"disabled":true,"description":{"content":"optional: filter orders with sync_date >= this value. Accepts 'Y-m-d' (e.g. 2024-06-09, treated as 00:00:00) or 'Y-m-d H:i:s' (e.g. 2024-06-09 12:30:00). Preferred over updated_at_from for polling since sync_date only changes on order create or explicit sync, not on internal batch reassignments.
\n","type":"text/plain"},"key":"sync_date_from","value":"2024-06-09"},{"disabled":true,"description":{"content":"optional: filter orders with sync_date <= this value. Accepts 'Y-m-d' (e.g. 2024-06-10, treated as 23:59:59) or 'Y-m-d H:i:s' (e.g. 2024-06-10 12:30:00).
\n","type":"text/plain"},"key":"sync_date_to","value":"2024-06-10"},{"disabled":true,"description":{"content":"optional: orders with at least one FC-assigned line with this fulfillment_status (e.g. default = not imported into FC WMS).
\n","type":"text/plain"},"key":"fulfillment_status","value":"default"},{"disabled":true,"description":{"content":"optional: orders with at least one FC-assigned line where fulfillment_status is not this value.
\n","type":"text/plain"},"key":"fulfillment_status_exclude","value":"imported"},{"disabled":true,"description":{"content":"optional: when 1 or true, exclude orders with open lines still at the seller (center_id=0). Omit or 0 to include partial orders.
\n","type":"text/plain"},"key":"skip_partial_orders","value":"1"},{"disabled":true,"description":{"content":"optional: also return orders/lines handled directly by the seller (center_id = 0), skipping the default order_status filter. Useful for looking up order data for returns on seller-fulfilled orders.
\n","type":"text/plain"},"key":"include_seller_handled","value":"true"},{"disabled":true,"description":{"content":"optional: comma-separated list of carrier slugs. When provided, each order in the response will include a shipping_label_addresses object keyed by carrier slug. Supported slugs: generic, bolcom, myparcel, dpdnl, dhlnl, dhlde, internetmarke, ampere, amperev2, postnl, gls, bpost, sendcloud, wuunder, shipcloud, shipstation, sendy, sendwise, parcelpro, qls, shipit, gls_shipit, ups, hermes, monta, easyship, amazon_easyship, landmark, trunkrs, asendia, fedex. Unsupported slugs are silently ignored. Requires api_pii_enabled=1; if PII is disabled the field is redacted.
\n","type":"text/plain"},"key":"include_shipping_label_addresses","value":"postnl,sendcloud,generic"}],"variable":[]}},"response":[{"id":"6e2558eb-489c-4c85-949c-29511f8527aa","name":"Get Orders","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/orders?id=3215746&page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","orders"],"query":[{"key":"id","value":"3215746","description":"optional: ChannelDock order id"},{"key":"seller_id","value":"2","disabled":true},{"key":"order_status","value":"shipment","description":"optional ( default: order | shipment | cancelled | return | backorder )","disabled":true},{"key":"order_id","value":"5576463548764","description":"optional: remote order id of the webshop / marketplace","disabled":true},{"key":"shipping_country_code","value":"NL","description":"optional: country code of order","disabled":true},{"key":"sort_attr","value":"sync_date","description":"optional ( id | default: order_date | sync_date | updated_at )","disabled":true},{"key":"sort_dir","value":"DESC","description":"optional ( DESC | default: ASC )","disabled":true},{"key":"shipping_address_accurate","value":"0","description":"optional: filter on address validation ( default: 1 | 0 )","disabled":true},{"key":"page","value":"1"},{"key":"include_traceability_data","value":"false","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 10,\n \"orders_count\": 1,\n \"orders\": [\n {\n \"id\": 88210,\n \"seller_id\": 2,\n \"order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"api_id\": 0,\n \"price_total\": 466.8,\n \"discount_total\": 0,\n \"vat_number\": \"\",\n \"payment_id\": \"pi_3PqAB12FCdEfGhI\",\n \"channel_name\": \"WooCommerce\",\n \"channel_id\": 8,\n \"billing_address_supplement\": \"\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_city\": \"Amsterdam\",\n \"billing_company\": \"ChannelDock B.V.\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"lars@upwind.example.com\",\n \"billing_first_name\": \"Lars\",\n \"billing_middle_name\": \"van\",\n \"billing_last_name\": \"Schaick\",\n \"billing_region\": \"Noord-Holland\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_zip_code\": \"1080 AH\",\n \"shipping_first_name\": \"Lars\",\n \"shipping_last_name\": \"van Schaick\",\n \"shipping_company\": \"ChannelDock B.V.\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080 AH\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_email\": \"lars@upwind.example.com\",\n \"shipping_phone_number\": \"+31 6 1234 5678\",\n \"order_date\": \"2026-06-13 09:24:11\",\n \"ship_on_date\": \"2026-06-14\",\n \"total_weight\": 2.4,\n \"order_status\": \"order\",\n \"extra_comment\": \"Customer asked for delivery before the weekend.\",\n \"is_b2b\": 0,\n \"po_number\": null,\n \"pallet_count\": 0,\n \"order_products\": [\n {\n \"id\": 91201,\n \"api_id\": 0,\n \"seller_id\": 2,\n \"center_id\": 7,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-1\",\n \"ean\": \"8719326583631\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"price\": 299.95,\n \"quantity\": 1,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 6.95,\n \"product\": {\n \"id\": 18421,\n \"sku\": \"UPW-BAR-52\",\n \"ean\": \"8719326583631\",\n \"weight\": 1.2,\n \"price\": 299.95,\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"child_from_bundle\": false,\n \"country_of_origin\": \"CN\",\n \"product_classification\": \"9506290000\"\n }\n },\n {\n \"id\": 91202,\n \"api_id\": 0,\n \"seller_id\": 2,\n \"center_id\": 7,\n \"order_id\": 88210,\n \"orderItemId\": \"WC-88210-2\",\n \"ean\": \"8719326583662\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"price\": 79.95,\n \"quantity\": 2,\n \"is_shipped\": 0,\n \"cancellation_request\": 0,\n \"shipment_label_id\": null,\n \"fulfillment_status\": \"pending\",\n \"shipping_costs\": 0,\n \"product\": {\n \"id\": 18424,\n \"sku\": \"UPW-FIN-G10\",\n \"ean\": \"8719326583662\",\n \"weight\": 0.6,\n \"price\": 79.95,\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"child_from_bundle\": false,\n \"country_of_origin\": \"DE\",\n \"product_classification\": \"9506290000\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"06700ff8-6291-4b87-a0e5-1a68384f6941"},{"name":"Update order line fulfillment status","id":"15c94d79-ef37-4900-93e5-5f79d7de0f1c","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"fulfillment_status\": \"imported\",\n \"order_ids\": [3918588, 3918589]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders/fulfillment-status","description":"Set fulfillment_status on order lines assigned to your fulfillment center. Use your own status labels (e.g. default, imported, wms_ready).
Provide one targeting mode:
\n{ \"id\" or \"order_product_id\", \"fulfillment_status\" } (mixed statuses allowed)order_ids and order_product_ids accept arrays or comma-separated strings.
\nStatus rules: 1–50 characters, lowercase letters, digits, underscore, hyphen. Cannot set integration-reserved values (e.g. jtl_pending, names ending in _pending, _shipped, or _error).
For a single order you can also use PUT /center/orders with id, fulfillment_status, and optional order_product_ids.
Update one or more fields on an existing order for a seller connected to the authenticated fulfillment center.
\nSend only the fields you want to change. The response includes an updated_fields object with the values that were applied.
\nshipping_address_accurate (optional, 0 or 1)
\nMarks whether the shipping address is considered valid for fulfillment.
\nUse 1 after correcting shipping fields via the API so the order can proceed to fulfillment.
\norder_products (optional, array)
\nPer-line updates. Each item:
\nfulfillment_status (optional, string)
\nApply one status to lines selected by order_product_ids, or to all FC-assigned lines on the order when id is set and order_product_ids is omitted.
\norder_product_ids (optional, array or comma-separated string)
\nChannelDock order line ids. Use with fulfillment_status on this request.
\nStatus rules: 1–50 characters, lowercase letters, digits, underscore, hyphen. Integration-reserved values (e.g. jtl_pending, *_shipped) cannot be set via API.
Response: updated_order_products, skipped_order_products, failed_order_products (on error).
Bulk updates (multiple orders): use POST /portal/api/v2/center/orders/fulfillment-status with order_ids or order_product_ids.
Allows a fulfillment center to claim products from a specific order. This action updates the status of the order’s products from back order to being managed by the fulfillment center, effectively removing them from the back order status and attaching them to the fulfillment center’s inventory.
\n","urlObject":{"path":["portal","api","v2","center","orders","claim"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"a51e9c15-ce05-4980-adca-9a2d99146446","name":"Get Orders","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"order_id\": 13839184\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders/claim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"claimed_order_products\": [\n {\n \"order_id\": 88210,\n \"order_product_id\": 91201,\n \"ean\": \"8719326583631\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"quantity\": 1\n },\n {\n \"order_id\": 88210,\n \"order_product_id\": 91202,\n \"ean\": \"8719326583662\",\n \"title\": \"Carbon Fin Set G10 (set of 4)\",\n \"quantity\": 2\n }\n ]\n}"}],"_postman_id":"27a8a417-8b19-4314-8832-b08f975a86a8"},{"name":"Create Order","id":"63d6bd5e-a788-48d9-a0f1-4e67bb02a407","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 123,\n \"order_id\": \"B-32333\",\n \"seq_order_id\": \"CD-ORDER-2024-001\",\n \"order_status\": \"order\",\n \"extra_comment\": \"A manual order created by ChannelDock API.\",\n \n \"price_total\": 125.50,\n \"price_currency\": \"EUR\",\n \n \"company\": \"ChannelDock BV\",\n \"email\": \"demo_customer@channeldock.com\",\n \"first_name\": \"Nicky\",\n \"last_name\": \"Smith\",\n \n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Smith\",\n \"shipping_company\": \"ChannelDock BV\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_phone_number\": \"+31612345678\",\n \"shipping_email\": \"demo_customer@channeldock.com\",\n\n \"billing_first_name\": \"Nicky\",\n \"billing_last_name\": \"Smith\", \n \"billing_company\": \"ChannelDock BV\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_zip_code\": \"1080AH\",\n \"billing_city\": \"Amsterdam\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"demo_customer@channeldock.com\",\n \n \"order_products\": [\n {\n \"ean\": \"8719326583631\",\n \"quantity\": 10,\n \"price\": 75.00\n },\n {\n \"ean\": \"8719326583648\",\n \"quantity\": 5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders","description":"Orders can be handled (processed to shipments) by sending ChannelDock the order_id, track_and_trace and carrier. ChannelDock will then automatically handle the order at the sales channel where it originated from.
\nDe parameter unrecognized_product_policy bepaalt hoe het systeem omgaat met orderregels die niet herkend worden. Ondersteunde waarden zijn:
\nallow (standaard)
\nDe order wordt aangemaakt, ook als er onbekende regels zijn.
\nResultaat: partial_success + order_products_failed
\nGedrag:
\nSeller: er wordt een placeholder-regel aangemaakt zonder gekoppeld product
\nCenter: onbekende regels worden overgeslagen
\nreject_order
\nDe volledige order wordt afgewezen zodra er één onbekende regel is.
\nhold_order
\nDe order wordt aangemaakt, maar op on-hold gezet als er onbekende regels zijn.
\nBelangrijk:
\nAls geen enkele orderregel herkend wordt, faalt de aanvraag altijd met een HTTP 400, ongeacht de gekozen policy.
\n","urlObject":{"path":["portal","api","v2","center","orders"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"cdef0ebd-fbad-4e76-8898-c14fc62897c0","name":"Created (success)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 123,\n \"order_status\": \"order\",\n \"extra_comment\": \"A manual order created by ChannelDock API.\",\n \n \"price_total\": 125.50,\n \"price_currency\": \"EUR\",\n \n \"company\": \"ChannelDock BV\",\n \"email\": \"demo_customer@channeldock.com\",\n \"first_name\": \"Nicky\",\n \"last_name\": \"Smith\",\n \n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Smith\",\n \"shipping_company\": \"ChannelDock BV\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_phone_number\": \"+31612345678\",\n \"shipping_email\": \"demo_customer@channeldock.com\",\n\n \"billing_first_name\": \"Nicky\",\n \"billing_last_name\": \"Smith\", \n \"billing_company\": \"ChannelDock BV\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_zip_code\": \"1080AH\",\n \"billing_city\": \"Amsterdam\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"demo_customer@channeldock.com\",\n \n \"order_products\": [\n {\n \"ean\": \"8719326583631\",\n \"quantity\": 10,\n \"price\": 75.00\n },\n {\n \"ean\": \"8719326583648\",\n \"quantity\": 5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Created new order: 88220\",\n \"order_id\": 88220\n}"},{"id":"d105a8f1-4c79-4e12-b431-4881a5b92940","name":"Created with unrecognized lines (partial_success)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 123,\n \"order_status\": \"order\",\n \"extra_comment\": \"A manual order created by ChannelDock API.\",\n \n \"price_total\": 125.50,\n \"price_currency\": \"EUR\",\n \n \"company\": \"ChannelDock BV\",\n \"email\": \"demo_customer@channeldock.com\",\n \"first_name\": \"Nicky\",\n \"last_name\": \"Smith\",\n \n \"shipping_first_name\": \"Nicky\",\n \"shipping_last_name\": \"Smith\",\n \"shipping_company\": \"ChannelDock BV\",\n \"shipping_street\": \"Duivendrechtsekade\",\n \"shipping_house_number\": \"40\",\n \"shipping_house_number_ext\": \"A\",\n \"shipping_zip_code\": \"1080AH\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_region\": \"Noord-Holland\",\n \"shipping_country_code\": \"NL\",\n \"shipping_phone_number\": \"+31612345678\",\n \"shipping_email\": \"demo_customer@channeldock.com\",\n\n \"billing_first_name\": \"Nicky\",\n \"billing_last_name\": \"Smith\", \n \"billing_company\": \"ChannelDock BV\",\n \"billing_street\": \"Duivendrechtsekade\",\n \"billing_house_number\": \"40\",\n \"billing_house_number_ext\": \"A\",\n \"billing_zip_code\": \"1080AH\",\n \"billing_city\": \"Amsterdam\",\n \"billing_country_code\": \"NL\",\n \"billing_email\": \"demo_customer@channeldock.com\",\n \n \"order_products\": [\n {\n \"ean\": \"8719326583631\",\n \"quantity\": 10,\n \"price\": 75.00\n },\n {\n \"ean\": \"8719326583648\",\n \"quantity\": 5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"partial_success\",\n \"message\": \"Created new order: 88221. One or more lines are not linked to a center product.\",\n \"order_id\": 88221,\n \"order_products_failed\": [\n {\n \"ean\": \"9990000000001\",\n \"message\": \"Product not recognized: no center product with this EAN for this seller. Order line was skipped.\"\n }\n ]\n}"},{"id":"3891cb57-f48f-4e17-a94e-4af189ad85d9","name":"Rejected — no order products recognized","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 42,\n \"seq_order_id\": \"EXT-2025-88421\",\n \"order_status\": \"order\",\n \"price_total\": 89.9,\n \"price_currency\": \"EUR\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Buyer\",\n \"email\": \"jane@example.com\",\n \"shipping_company\": \"ACME BV\",\n \"shipping_street\": \"Keizersgracht\",\n \"shipping_house_number\": \"100\",\n \"shipping_house_number_ext\": \"B\",\n \"shipping_city\": \"Amsterdam\",\n \"shipping_zip_code\": \"1015CV\",\n \"shipping_country_code\": \"NL\",\n \"extra_comment\": \"API test — mixed EANs\",\n \"order_products\": [\n {\n \"ean\": \"8888888888888\",\n \"quantity\": 2\n },\n {\n \"ean\": \"9999999999999\",\n \"quantity\": 1,\n \"price\": 19.99\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"error\",\n \"message\": \"No order products could be created: none of the given EANs match a product for this fulfillment center and seller.\",\n \"order_products_failed\": [\n {\n \"ean\": \"9990000000001\",\n \"message\": \"Product not recognized: no center product with this EAN for this seller.\"\n },\n {\n \"ean\": \"9990000000002\",\n \"message\": \"Product not recognized: no center product with this EAN for this seller.\"\n }\n ]\n}"}],"_postman_id":"63d6bd5e-a788-48d9-a0f1-4e67bb02a407"},{"name":"Add order product","id":"e73edac8-3689-4a8a-9a6e-e96e5e4f2b72","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 12345,\n \"quantity\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders/{{order_id}}/add-product","description":"Adds a product line to an existing order. Use this when you need to add extra items to an order that is already in the system.
\nRequirements:
\nThe order must belong to a seller connected to your center
\nThe product must exist in your center’s product catalog
\nThe product must belong to the same seller as the order
\nProduct ID: You can use either the center_product id or the seller product_id.
\n","urlObject":{"path":["portal","api","v2","center","orders","{{order_id}}","add-product"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"bc0559a6-fb72-4ce7-b402-4b06ad099159","name":"Add order product","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 12345,\n \"quantity\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orders/123456789/add-product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Order product added.\"\n}"}],"_postman_id":"e73edac8-3689-4a8a-9a6e-e96e5e4f2b72"},{"name":"Create order log","id":"28ee9e39-06cc-43d6-b69c-b7cb3dac6068","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": 12345,\n \"title\": \"External WMS update\",\n \"status\": \"info\",\n \"description\": \"Picked in warehouse A.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/orderlogs","description":"Create an order log entry on a specific order. Use the internal ChannelDock order id (orders.id), not the marketplace order reference.
Enable Order Logs with POST on your API key in ChannelDock settings.
\ninfo. Max 255 characters. Common values: info, updated, update, created, error, label, cancelled, changed.Logged via API by {user first name last name}.HTTP 201 — Returns order_id and the created order_log row.
order_id or title, or field too long.Use this endpoint to remove a single order line (order_product) from an existing order.
What it does
\nRemoves one order product line from the specified order
\nRecalculates/finalizes the order after deletion
\nWrites an order log entry
\nReturns success/error JSON
\nThe orders API allows you to view and update,an individual, or a batch, of orders.
\n","_postman_id":"f95b99bb-dfb7-4c40-a8c7-6d16357932d1"},{"name":"Stock locations","item":[{"name":"Create stock location","id":"8c09811f-ddfd-46c3-9223-66c9940083f9","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock\": 10,\n \"product_id\": 227,\n \"stock_section_id\": 11576\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations","description":"Create a stock location linked to a stock section. Use the 'id' (as 'product_id'), that can be retrieved by the GET /products endpoint.
\n","urlObject":{"path":["portal","api","v2","center","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"7c944e07-e2f1-46bf-bf27-e0cf5b893b7e","name":"Create stock location","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 11,\n \"product_id\": 31,\n \"active_stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location created!\",\n \"stock_location_id\": 116\n}"}],"_postman_id":"8c09811f-ddfd-46c3-9223-66c9940083f9"},{"name":"Update stock location","id":"620b4b29-5394-4231-a754-ebd81af9dade","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 321,\n \"stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations","urlObject":{"path":["portal","api","v2","center","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"cf5fa8a8-9bac-4a18-919d-f41bedee9ddc","name":"Update stock location","originalRequest":{"method":"PUT","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 11,\n \"product_id\": 31,\n \"active_stock\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location updated!\"\n}"}],"_postman_id":"620b4b29-5394-4231-a754-ebd81af9dade"},{"name":"Delete stock location","id":"bc09027c-113c-4450-bab0-f55a261845e2","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 326\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations","urlObject":{"path":["portal","api","v2","center","stocklocations"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"8f7a865f-1cab-4933-b415-c8133b435a44","name":"Delete stock location","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"api-secret","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_location_id\": 321\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocklocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock location deleted!\"\n}"}],"_postman_id":"bc09027c-113c-4450-bab0-f55a261845e2"},{"name":"Get stock locations","id":"df5a9922-3f8d-4a3c-8855-3f442dd8c3fd","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/stocklocations","description":"This endpoint retrieves a paginated list of stock locations.
\nOptional filters include id, stock_section_id, product_id, seller_id, and has_expiration. Pass seller_id to only return locations for that seller's products at this fulfillment center. Results can be sorted by attributes like id, stock_section_id, product_id, stock, and expiration_date in ascending or descending order.
\nEach stock location includes key details (id, stock_section_id, product_id, expiration_date, batch_id, etc.) and associated product information (e.g., ean, sku, title, dimensions, and weight) if linked to a product.
\nBy default this endpoint only returns stock locations that already have a product assigned. Stock sections (shelves) that exist but currently hold no product are NOT included unless you pass include_empty=true. When include_empty=true, the response adds an empty_stock_sections_count and empty_stock_sections array listing those empty shelves — the existing stock_locations array is unchanged.
\nPagination is supported, with customizable page numbers and page size.
\n","urlObject":{"path":["portal","api","v2","center","stocklocations"],"host":["https://channeldock.com"],"query":[{"disabled":true,"description":{"content":"Optional: The ID of the stock location
\n","type":"text/plain"},"key":"id","value":"0"},{"disabled":true,"description":{"content":"Optional: The ID of the stock section
\n","type":"text/plain"},"key":"stock_section_id","value":"0"},{"disabled":true,"description":{"content":"Optional: The ID of the product
\n","type":"text/plain"},"key":"product_id","value":"0"},{"disabled":true,"description":{"content":"Optional: only locations for this seller's products at this fulfillment center
\n","type":"text/plain"},"key":"seller_id","value":"0"},{"disabled":true,"description":{"content":"Optional: true = only locations with a THT/expiration date and stock > 0
\n","type":"text/plain"},"key":"has_expiration","value":"true"},{"disabled":true,"description":{"content":"Optional: ( id | stock_section_id | product_id | stock | expiration_date )
\n","type":"text/plain"},"key":"sort_attr","value":"stock"},{"disabled":true,"description":{"content":"( ASC | DESC )\nRequired when sort_attr is filled in
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"Optional (default false): when true, also returns empty stock sections (shelves with no product) in a separate empty_stock_sections array. Not combined with product_id or seller_id.
\n","type":"text/plain"},"key":"include_empty","value":"true"}],"variable":[]}},"response":[{"id":"c0229d6b-e7b0-431f-8bea-9a319e9a0e33","name":"Get stock locations","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/seller/stocklocations","host":["https://channeldock.com"],"path":["portal","api","v2","seller","stocklocations"],"query":[{"key":"id","value":"0","description":"Optional: The ID of the stock location","disabled":true},{"key":"stock_section_id","value":"0","description":"Optional: The ID of the stock section","disabled":true},{"key":"product_id","value":"0","description":"Optional: The ID of the product","disabled":true},{"key":"seller_id","value":"0","description":"Optional: only locations for this seller's products at this fulfillment center","disabled":true},{"key":"has_expiration","value":"true","description":"Optional: true = only locations with a THT/expiration date and stock > 0","disabled":true},{"key":"sort_attr","value":"stock","description":"Optional: ( id | stock_section_id | product_id | stock | expiration_date )","disabled":true},{"key":"sort_dir","value":"ASC","description":"( ASC | DESC )\nRequired when sort_attr is filled in","disabled":true},{"key":"include_empty","value":"true","description":"Optional (default false): when true, also returns empty stock sections (shelves with no product) in a separate empty_stock_sections array. Not combined with product_id or seller_id.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"stock_locations_count\": 2,\n \"stock_locations\": [\n {\n \"id\": 114,\n \"stock_section_id\": 2716,\n \"seller_id\": 2,\n \"center_id\": 7,\n \"product_id\": 7,\n \"stock\": 48,\n \"include_in_stock_sync\": 1,\n \"expiration_date\": null,\n \"batch_id\": null,\n \"product\": {\n \"id\": 7,\n \"center_id\": 7,\n \"seller_id\": 2,\n \"product_id\": 7,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"product_reference\": \"UPW-REF-001\",\n \"location\": \"B-12\",\n \"title\": \"Upwind Kitesurf Bar Pro 52cm\",\n \"weight\": 1.8,\n \"x_size\": 60,\n \"y_size\": 12,\n \"z_size\": 8,\n \"stock\": 48,\n \"units_per_box\": 1,\n \"auto_assign_orders\": true,\n \"pick_costs\": 0.35,\n \"multi_pick_costs\": 0.28\n },\n \"stock_section\": {\n \"id\": 2716,\n \"description\": \"Pick zone B - Shelf 12\",\n \"extra_description\": \"Ground floor\",\n \"reference\": \"B-12\",\n \"pick_location\": 1,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Amsterdam DC\"\n }\n },\n {\n \"id\": 115,\n \"stock_section_id\": 2717,\n \"seller_id\": 2,\n \"center_id\": 7,\n \"product_id\": 8,\n \"stock\": 36,\n \"include_in_stock_sync\": 1,\n \"expiration_date\": null,\n \"batch_id\": null,\n \"product\": {\n \"id\": 8,\n \"center_id\": 7,\n \"seller_id\": 2,\n \"product_id\": 8,\n \"ean\": \"8719326583648\",\n \"sku\": \"UPW-WET-M\",\n \"product_reference\": \"UPW-REF-002\",\n \"location\": \"B-13\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"weight\": 1.4,\n \"x_size\": 35,\n \"y_size\": 25,\n \"z_size\": 6,\n \"stock\": 36,\n \"units_per_box\": 1,\n \"auto_assign_orders\": true,\n \"pick_costs\": 0.35,\n \"multi_pick_costs\": 0.28\n },\n \"stock_section\": {\n \"id\": 2717,\n \"description\": \"Pick zone B - Shelf 13\",\n \"extra_description\": \"Ground floor\",\n \"reference\": \"B-13\",\n \"pick_location\": 1,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Amsterdam DC\"\n }\n }\n ]\n}"}],"_postman_id":"df5a9922-3f8d-4a3c-8855-3f442dd8c3fd"}],"id":"53f1adea-5bef-43e9-8572-b6093ecb41c0","description":"For more advance stock management, users can use stock locations in ChannelDock. This means mapping out your warehouse structure assinging products to one or multiple stock locations.
\nUsing the GET /products endpoint, you can retrieve stock location data per product. Make sure to include the GET parameter 'include_stock_location_data'.
\nUse this stock locations endpoint to add, update or delete products from a specific stock location.
\nEach product at a stock location has a stock_location_id that you can use to update or delete the product from that location.
\nWhen adding a product to a stock location, you need to include a stock_section_id. Based on this stock_section_id ChannelDock knows where the product location is within your warehouse.
\n","_postman_id":"53f1adea-5bef-43e9-8572-b6093ecb41c0"},{"name":"Warehouses","item":[{"name":"Get warehouses","id":"75b7f573-c4d3-44e6-a715-aac228d00aec","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/warehouses","description":"Get a list of all warehouses (physical buildings/locations) for the current fulfillment center.
\nid: 0 (\"Default warehouse\") is always included first — it's not a real warehouse record, it's the same sentinel the portal UI has always shown, kept here so every warehouse_id value valid elsewhere in the API (including 0) is actually discoverable.
Real warehouses are sorted by priority (warehouses with priority = 0 last), then description — same order as the portal UI.
\n","urlObject":{"path":["portal","api","v2","center","warehouses"],"host":["https://channeldock.com"],"query":[{"disabled":true,"description":{"content":"Optional: filter on a specific warehouse
\n","type":"text/plain"},"key":"id","value":"1"}],"variable":[]}},"response":[{"id":"5915d8e5-697e-4322-ae07-40af1c6afea0","name":"Get warehouses","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/warehouses","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","warehouses"],"query":[{"key":"id","value":"1","description":"Optional: filter on a specific warehouse","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"warehouses_count\": 2,\n \"warehouses\": [\n {\n \"id\": 0,\n \"description\": \"Default warehouse\",\n \"allow_orders\": true,\n \"priority\": 0,\n \"packing_bins_total\": 0\n },\n {\n \"id\": 1,\n \"description\": \"Main Warehouse\",\n \"allow_orders\": true,\n \"priority\": 0,\n \"packing_bins_total\": 4\n }\n ]\n}"}],"_postman_id":"75b7f573-c4d3-44e6-a715-aac228d00aec"}],"id":"bdee9936-767a-4d24-90ee-b6fa7243f0f0","description":"A warehouse is a physical building/location. Stock sections belong to a warehouse via warehouse_id. Use this endpoint to look up which warehouses (and IDs) exist before creating or filtering stock sections.
\n","_postman_id":"bdee9936-767a-4d24-90ee-b6fa7243f0f0"},{"name":"Stock sections","item":[{"name":"Get stock sections","id":"3258c084-5215-4f60-b06d-121cb42fcde7","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/stocksections?page=1","description":"This endpoint retrieves a paginated list of stock sections (physical locations/shelves) for the current fulfillment center.
\nOptional filters include id, parent_section_id, warehouse_id, and location_type. Results can be sorted by id, description, parent_section_id, or warehouse_id, in ascending or descending order.
\nEach stock section includes stock_locations_count and total_stock, which tell you whether a DELETE would be blocked (blocked when total_stock > 0) — check this before attempting a delete instead of guessing.
\n","urlObject":{"path":["portal","api","v2","center","stocksections"],"host":["https://channeldock.com"],"query":[{"description":{"content":"Optional: page number (50 per page)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Optional: filter on a specific section
\n","type":"text/plain"},"key":"id","value":"4821"},{"disabled":true,"description":{"content":"Optional: filter on sections nested under a given parent
\n","type":"text/plain"},"key":"parent_section_id","value":"0"},{"disabled":true,"description":{"content":"Optional: filter on warehouse
\n","type":"text/plain"},"key":"warehouse_id","value":"1"},{"disabled":true,"description":{"content":"Optional: storage or pick
\n","type":"text/plain"},"key":"location_type","value":"pick"},{"disabled":true,"description":{"content":"Optional: ( id | description | parent_section_id | warehouse_id )
\n","type":"text/plain"},"key":"sort_attr","value":"description"},{"disabled":true,"description":{"content":"Optional: ( ASC | DESC )
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"}],"variable":[]}},"response":[{"id":"8a86d173-f9be-4ce7-b6c3-6f6a0016b1b7","name":"Get stock sections","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/stocksections?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","stocksections"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"stock_sections_count\": 1,\n \"stock_sections\": [\n {\n \"id\": 4821,\n \"description\": \"A1-01\",\n \"extra_description\": null,\n \"reference\": null,\n \"parent_section_id\": 12,\n \"warehouse_id\": 1,\n \"warehouse_name\": \"Main Warehouse\",\n \"location_type\": \"storage\",\n \"stock_locations_count\": 2,\n \"total_stock\": 14\n }\n ]\n}"}],"_postman_id":"3258c084-5215-4f60-b06d-121cb42fcde7"},{"name":"Create stock section","id":"a3de8af7-4805-4645-abd2-c1f2638eea5a","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"description\": \"A1-01\",\n \"warehouse_id\": 1,\n \"parent_section_id\": 12,\n \"location_type\": \"pick\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocksections","description":"Create a new stock section (physical location/shelf).
\ndescription (string, required)
\nSection name. Must be unique per center.
\nwarehouse_id (integer, optional)
\nWarehouse this section belongs to. Defaults to 0 (\"Default warehouse\"). Look up valid IDs via GET /warehouses — non-zero values must resolve to an existing warehouse for this center, otherwise the API returns a 404.
\nparent_section_id (integer, optional)
\nParent section ID, for nested locations. Defaults to 0 (top-level/root). A root section organizes the warehouse tree and cannot hold stock locations directly — check GET /stocksections?parent_section_id=0 first, since only one root per warehouse is shown in the portal UI's navigator.
\nextra_description (string, optional)
\nFree-text notes.
\nreference (string, optional)
\nYour own reference/code for this section.
\nlocation_type (string, optional)
\nstorage or pick. Defaults to storage. Returns a 422 for any other value.
\nFails with a 409 if a section with the same description already exists for this center.
\n","urlObject":{"path":["portal","api","v2","center","stocksections"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"c97f7b68-be15-497e-b79e-01882a23fcbd","name":"Create stock section","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"description\": \"A1-01\",\n \"warehouse_id\": 1,\n \"parent_section_id\": 12,\n \"location_type\": \"pick\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocksections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock section created!\",\n \"stock_section_id\": 4821\n}"}],"_postman_id":"a3de8af7-4805-4645-abd2-c1f2638eea5a"},{"name":"Delete stock section","id":"86b222bf-d5b1-4bcf-91a3-4f6c04d56953","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_id\": 4821\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocksections","description":"Delete a stock section (physical location/shelf).
\nstock_section_id (integer, required)
\nSection to delete.
\nFails with a 409 if the section still holds stock — set the stock of every location in that section to 0 first (via PUT /stocklocations), then retry. Any child sections nested under the deleted section are re-parented to its parent (not deleted). Stock locations left with 0 stock under the deleted section are removed along with it.
\n","urlObject":{"path":["portal","api","v2","center","stocksections"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"0fd454a1-0b44-4d70-8736-c4fb198e40e2","name":"Delete stock section","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"stock_section_id\": 4821\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/stocksections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Stock section deleted!\"\n}"}],"_postman_id":"86b222bf-d5b1-4bcf-91a3-4f6c04d56953"}],"id":"5597ee7a-c90c-49a9-9de5-d0e2e9bef77f","description":"A stock section is a physical location itself (a shelf/rack, e.g. \"A1-01\"), organized in a hierarchy under a warehouse. This is distinct from stock locations, which manage the stock of a product placed at a section — stock locations can already create/delete a product's presence at a section, but not the section itself. Use this endpoint to create or remove the location.
\nTo look up valid warehouse_id values before creating a section, use GET /warehouses.
\n","_postman_id":"5597ee7a-c90c-49a9-9de5-d0e2e9bef77f"},{"name":"Shipments","item":[{"name":"Get shipments","id":"da39f00a-ee85-4378-90f7-0c6fbec4ff30","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/shipment?page=1","urlObject":{"path":["portal","api","v2","center","shipment"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"key":"id","value":"2092968"},{"disabled":true,"key":"seller_id","value":"1701"},{"disabled":true,"description":{"content":"registered | distribution | delivered | return
\n","type":"text/plain"},"key":"status","value":"registered"},{"disabled":true,"description":{"content":"ChannelDock order id
\n","type":"text/plain"},"key":"order_id","value":"1838"},{"disabled":true,"description":{"content":"max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"id | default: created_at | order_id
\n","type":"text/plain"},"key":"sort_attr","value":"created_at"},{"disabled":true,"description":{"content":"DESC | default: ASC
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"start_date","value":"2022-07-28 02:03:22"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"end_date","value":"2022-08-28 06:03:33"},{"disabled":true,"description":{"content":"optional | includes the base64 encoded shipping label pdf in the response
\n","type":"text/plain"},"key":"include_pdf_label","value":"true"}],"variable":[]}},"response":[{"id":"c4c249d5-2572-4a0b-a8ce-1590c1362371","name":"Get Shipments","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/shipment?page=1&sort_attr=created_at&sort_dir=DESC","host":["https://channeldock.com"],"path":["portal","api","v2","center","shipment"],"query":[{"key":"page","value":"1","description":"required"},{"key":"id","value":"5110","disabled":true},{"key":"seller_id","value":"3","disabled":true},{"key":"status","value":"registered","description":"registered | distribution | delivered | return","disabled":true},{"key":"order_id","value":"1838","description":"ChannelDock order id","disabled":true},{"key":"sort_attr","value":"created_at","description":"id | default: created_at | order_id"},{"key":"sort_dir","value":"DESC","description":"DESC | default: ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 25,\n \"shipments_count\": 1,\n \"shipments\": [\n {\n \"id\": 7701,\n \"seller_id\": 2,\n \"api_id\": 0,\n \"order_id\": 88210,\n \"remote_order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"status\": \"registered\",\n \"remote_label_id\": \"PNL-3SBOL00112233\",\n \"price\": 6.95,\n \"shipment_method\": \"PostNL Pakket NL\",\n \"carrier_code\": \"postnl\",\n \"track_and_trace\": \"3SBOL00112233\",\n \"track_and_trace_url\": \"https://postnl.nl/tracktrace/?B=3SBOL00112233&P=1080AH&D=NL&T=C\",\n \"shipment_date\": \"2026-06-14\",\n \"order_date\": \"2026-06-13\",\n \"packaging\": \"Box M\",\n \"packaging_price\": 1.25,\n \"tags\": [\n \"express\"\n ],\n \"extra_comment\": \"\",\n \"pick_price\": 0.35,\n \"fulfillment_fee\": 1.1,\n \"order_options\": [\n {\n \"id\": 1,\n \"name\": \"Thank-you card\",\n \"amount\": 1,\n \"price\": 0.5\n }\n ]\n }\n ]\n}"}],"_postman_id":"da39f00a-ee85-4378-90f7-0c6fbec4ff30"},{"name":"Update shipment","id":"3072c3f0-e7cf-4f7a-98b1-4d9b588b4b92","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"id\": \"12345\",\n \"status\": \"registered\",\n \"price\": 7.95,\n \"surcharge\": 3.25,\n \"shipment_method\": \"UPS Parcel Express\",\n \"carrier_code\": \"UPS\",\n \"track_and_trace\": \"1Z999AA10123456784\",\n \"track_and_trace_url\": \"https://track.example.com/1Z999AA10123456784\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/shipment","description":"This endpoint updates the details of a shipment label based on the provided label ID and other optional fields.
\nid (required): The unique identifier of the label to be updated.
\nstatus (optional): The current status of the shipment label.
\nprice (optional): The price associated with the shipment label.
\nsurcharge (optional): Any additional surcharge for the shipment.
\nshipment_method (optional): The name of the shipment method used.
\ncarrier_code (optional): The code of the carrier used for the shipment.
\ntrack_and_trace (optional): The tracking number for the shipment.
\ntrack_and_trace_url (optional): The URL for tracking the shipment.
\nOrders can be handled (processed to shipments) by sending ChannelDock the order_id, track_and_trace, carrier and id's of the order products. ChannelDock will then automatically handle the order at the sales channel where it originated from.
\nUsing this endpoint, we expect that you generate the shipping label in your own warehouse management system. Using the 'POST - Generate shipping label' endpoint you can have ChannelDock generate the shipping label for you.
\nThe order_products object is optional. If you omit this object, ChannelDock will ship all the order products.
\nOptionally you can also send a track_and_trace_2 field with the payload if for example the order product is too big to ship with one label. We do not support the track and trace of a third, fourth etc. label. Most sales channel wil only accept 1 track and trace anyway
\n","urlObject":{"path":["portal","api","v2","center","shipment"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"498b0271-9aa8-4a32-89f2-40b68e47d50e","name":"Create shipment (with one tracking code)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"3150051\",\n \"track_and_trace\": \"3SYTYM0003251\",\n \"track_and_trace_url\": \"https://tracking.postnl.nl?id=3SYTYM0003251\",\n \"carrier\": \"TNT\",\n \"price\": 5.25,\n \"order_products\": [ { \"id\": 2683 } ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": [\n \"CD order ID: 88210 -> New label 7701: success\"\n ]\n}"},{"id":"190da25f-9135-4788-85b8-6a1be069f2f4","name":"Create shipment (with multiple tracking codes)","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"3150051\",\n \"track_and_traces\": [\n \"3SYTYM0003251\",\n \"3SYTYM0003252\",\n \"3SYTYM0003253\"\n ],\n \"track_and_trace_url\": \"https://tracking.postnl.nl?id=3SYTYM0003251\",\n \"carrier\": \"TNT\",\n \"price\": 5.25,\n \"order_products\": [\n { \"id\": 3406535 }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": [\n \"CD order ID: 88211 -> New label 7702 (with 2 tracking codes): success\"\n ]\n}"}],"_postman_id":"6ed6b68d-28b2-43f6-ad0f-b52bc12defcc"},{"name":"Generate shipping label","id":"334c8d35-0c58-4d0f-a2a8-aa487921f606","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"7470\",\n \"order_products\": [ { \"id\": 9104 } ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/label","description":"Use this endpoint to generate shipping labels via ChannelDock. To select the appropriate label, apply the shipping rules set within ChannelDock.
\nThe order_products object is optional and can be used for partial shipments. If omitted, all products associated with the order ID will be shipped.
\nThe label will be returned in base64 encoded format. To retrieve the label again later, use the GET shipments endpoint with the include_pdf_label=true parameter.
\n","urlObject":{"path":["portal","api","v2","center","label"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"e3025643-356d-4e64-9b13-b06eec1d5dd0","name":"Generate shipping label","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"7470\",\n \"order_products\": [ { \"id\": 9104 } ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/label"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"errors\": [],\n \"shipments\": [\n {\n \"status\": \"success\",\n \"order_id\": 88210,\n \"shipment_label_id\": 7701,\n \"base64_label_pdf\": \"JVBERi0xLjcKJeLjz9MKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCi4uLi4gKHRydW5jYXRlZCBmb3IgYnJldml0eSkgLi4uLgoKJSVFT0YK\"\n }\n ]\n}"}],"_postman_id":"334c8d35-0c58-4d0f-a2a8-aa487921f606"}],"id":"861120a2-5998-4327-bf0d-5a65644aa954","description":"Fetch shipment data from ChannelDock.
\n","_postman_id":"861120a2-5998-4327-bf0d-5a65644aa954"},{"name":"Shipment methods","item":[{"name":"Get Shipment methods","id":"7bcf8a0c-423d-4b55-b917-99ac1f2f71ba","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/shipmentmethods","urlObject":{"path":["portal","api","v2","center","shipmentmethods"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"0e151615-102d-4548-98b9-c61e804199fb","name":"Get Shipment methods","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/shipmentmethods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": \"all\",\n \"shipment_methods_count\": 4,\n \"shipment_methods\": [\n {\n \"id\": 9503,\n \"name\": \"DPD Classic NL 0-3 kg\",\n \"carrier\": \"dpdnl\",\n \"min_weight\": 0,\n \"max_weight\": 3,\n \"max_x\": 175,\n \"max_y\": 75,\n \"max_z\": 75,\n \"service_point_input\": \"dpdnl\",\n \"mailbox_size\": 0,\n \"remote_carrier_id\": \"CL\",\n \"settings\": null\n },\n {\n \"id\": 9504,\n \"name\": \"PostNL Pakket NL\",\n \"carrier\": \"postnl\",\n \"min_weight\": 0,\n \"max_weight\": 23,\n \"max_x\": 100,\n \"max_y\": 50,\n \"max_z\": 50,\n \"service_point_input\": \"postnl\",\n \"mailbox_size\": 0,\n \"remote_carrier_id\": \"3085\",\n \"settings\": null\n },\n {\n \"id\": 9505,\n \"name\": \"DHL Express NL → EU\",\n \"carrier\": \"dhl\",\n \"min_weight\": 0,\n \"max_weight\": 31,\n \"max_x\": 120,\n \"max_y\": 80,\n \"max_z\": 80,\n \"service_point_input\": \"dhl\",\n \"mailbox_size\": 0,\n \"remote_carrier_id\": \"DHL-EU\",\n \"settings\": null\n },\n {\n \"id\": 9506,\n \"name\": \"Bol DHL ForYou briefpost (VVB)\",\n \"carrier\": \"bolcom\",\n \"min_weight\": 0,\n \"max_weight\": 1,\n \"max_x\": 38,\n \"max_y\": 26.4,\n \"max_z\": 3.2,\n \"service_point_input\": \"dhlnl\",\n \"mailbox_size\": 1,\n \"remote_carrier_id\": \"DHLFORYOU\",\n \"settings\": null\n }\n ]\n}"}],"_postman_id":"7bcf8a0c-423d-4b55-b917-99ac1f2f71ba"},{"name":"Create / Update custom shipment method","id":"41d64b23-293c-4f78-9b2c-e9ff9dc2dbba","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCarrier - Package large express\",\n \"remote_carrier_id\": \"my_carrier_id\",\n \"logo_url\": \"https://example.com/logo-700x300.png\",\n \"carrier_code\": \"mycarrier\",\n \"min_weight\": 0,\n \"max_weight\": 23,\n \"max_x\": 150,\n \"max_y\": 150,\n \"max_z\": 150,\n \"mailbox_size\": 0,\n \"callback_request\": {\n \"method\": \"POST\",\n \"url\": \"https://yourdomain.com/api/shipment_endpoint\",\n \"headers\": {\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer YOUR_CARRIER_API_TOKEN\"\n }\n },\n \"shipment_method_countries\": [\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"NL\",\n \"price\": 3.2\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"BE\",\n \"price\": 4.8\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"DE\",\n \"price\": 5.6\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"FR\",\n \"price\": 15\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"US\",\n \"price\": 39.50\n },\n {\n \"country_code_from\": \"NL\",\n \"country_code_to\": \"IT\",\n \"price\": 22.50\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/shipmentmethods","description":"This endpoint allows you to create or update a shipment method for a custom carrier integration. If a shipment method with the same remote_carrier_id already exists, it will be updated. Otherwise, a new one will be created.
\nThe shipment method defines core logistics parameters such as weight and dimension limits, callback behavior, and available shipping routes per country.
\nFind additional info here: Help center
\nThe request must include all required fields listed below.
\nThe callback_request should be a valid JSON object including a url, method, and headers.
\nA logo_url must be provided, pointing to a PNG image of size 700x300 pixels.
\nThe shipment_method_countries field must contain at least one country mapping with a price.
\nname – Name of the shipment method (displayed to the user)
\nremote_carrier_id – Your unique ID for recognizing this shipment method
\ncarrier_code – Lowercase identifier for the carrier/platform
\nmin_weight, max_weight – Weight limits in kg
\nmax_x, max_y, max_z – Dimensions in cm
\nmailbox_size – Set to 1 if it fits through the mailbox (optional)
\nlogo_url – PNG image (700x300px) representing the carrier
\ncallback_request – Contains:
\nurl – Endpoint for label creation
\nmethod – HTTP method (e.g., POST)
\nheaders – Object with any required headers (e.g., API key)
\nshipment_method_countries – Array of country pairs and prices
\nIf a shipment method with the same remote_carrier_id exists, it will be updated.
\nOtherwise, a new shipment method will be created.
\nCountry-specific shipping rules are updated or created based on shipment_method_countries.
\nFetch all the shipment methods. The 'id' of these shipment methods can be matched with the 'shipment_method_id' field from an order product to check which shipping methods is assigend to the order.
\n","_postman_id":"fde19902-7fc5-4901-a1b4-1950aac07ed1"},{"name":"Carriers","item":[{"name":"List all carriers","id":"07644163-47b4-4818-930e-c69fbfe4d4e4","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://channeldock.com/portal/api/v2/center/carriers","description":"Test auth endpoint
\n","urlObject":{"path":["portal","api","v2","center","carriers"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"4bcffd1f-f4b8-4e43-a42a-a0a898cc31e2","name":"List all carriers","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://channeldock.com/portal/api/v2/center/carriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"carriers\": {\n \"postnl\": \"PostNL\",\n \"dhl\": \"DHL\",\n \"dpd\": \"DPD\",\n \"ups\": \"United Parcel Service (UPS)\",\n \"fedex\": \"FedEx\",\n \"gls\": \"GLS\",\n \"dhl_express\": \"DHL Express\",\n \"bol_dhl_for_you\": \"Bol DHL ForYou (VVB)\",\n \"bol_bpost\": \"Bol Bpost (VVB)\",\n \"amazon_logistics\": \"Amazon Logistics\",\n \"chronopost\": \"Chronopost\",\n \"colissimo\": \"Colissimo\",\n \"hermes\": \"Hermes\",\n \"royal_mail\": \"Royal Mail\",\n \"canada_post\": \"Canada Post\",\n \"tnt\": \"TNT\",\n \"manual\": \"Manual / custom carrier\"\n }\n}"}],"_postman_id":"07644163-47b4-4818-930e-c69fbfe4d4e4"}],"id":"45fb7fef-edb2-4714-ac6c-57c3546d0702","_postman_id":"45fb7fef-edb2-4714-ac6c-57c3546d0702","description":""},{"name":"Sellers","item":[{"name":"Get sellers","id":"8aaed190-5a55-4d84-ac32-3dff11bc20ab","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/center/sellers?page=1","description":"Products that are connected to a fulfillment center account can be viewed by this API.
\nThis request's return results are paginated. The API returns 50 items per page.
\n","urlObject":{"path":["portal","api","v2","center","sellers"],"host":["https://channeldock.com"],"query":[{"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"seller_id","value":"2"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_attr","value":"id"}],"variable":[]}},"response":[{"id":"858a66f1-82ab-4dec-ac29-6b09faf3660f","name":"Get sellers","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://channeldock.com/portal/api/v2/center/sellers?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","sellers"],"query":[{"key":"page","value":"1"},{"key":"seller_id","value":"2","description":"optional","disabled":true},{"key":"sort_dir","value":"DESC","description":"optional","disabled":true},{"key":"sort_attr","value":"id","description":"optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 25,\n \"sellers_count\": 2,\n \"sellers\": [\n {\n \"id\": 2,\n \"company\": \"Upwind Watersports B.V.\",\n \"first_name\": \"Lars\",\n \"last_name\": \"van Schaick\",\n \"email\": \"lars@upwind.example.com\",\n \"seller_email\": \"orders@upwind.example.com\",\n \"vat_number\": \"NL801234567B01\",\n \"kvk\": \"12345678\",\n \"eori_number\": \"NL801234567000\",\n \"street\": \"Duivendrechtsekade\",\n \"house_number\": \"40\",\n \"zipcode\": \"1080 AH\",\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"status\": \"connected\",\n \"description\": \"Watersports & kitesurf retailer – priority shipping\",\n \"private_note\": \"Active since 2024 – Q1 2026 expansion to FR/DE\"\n },\n {\n \"id\": 5,\n \"company\": \"Sail & Sport Demo\",\n \"first_name\": \"Nicky\",\n \"last_name\": \"Kouffeld\",\n \"email\": \"nicky@sailsport.example.com\",\n \"seller_email\": \"orders@sailsport.example.com\",\n \"vat_number\": \"NL987654321B02\",\n \"kvk\": \"87654321\",\n \"eori_number\": null,\n \"street\": \"Stationsweg\",\n \"house_number\": \"15A\",\n \"zipcode\": \"3011 AA\",\n \"city\": \"Rotterdam\",\n \"country\": \"NL\",\n \"status\": \"connected\",\n \"description\": null,\n \"private_note\": null\n }\n ]\n}"}],"_postman_id":"8aaed190-5a55-4d84-ac32-3dff11bc20ab"},{"name":"Create seller","id":"70b044cb-c11f-46d7-8e5e-097e3c958c51","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"tel\": \"+123456789\",\n \"country\": \"USA\",\n \"password\": \"StrongPassword123\",\n \"company\": \"John's Supplies\",\n \"description\": \"A reliable supplier for electronics.\",\n \"timezone\": \"America/New_York\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/sellers","description":"Products that are connected to a fulfillment center account can be viewed by this API.
\nThis request's return results are paginated. The API returns 50 items per page.
\n","urlObject":{"path":["portal","api","v2","center","sellers"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"8749a9e1-227f-44cd-8681-5a457da4a12a","name":"Create seller","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"tel\": \"+123456789\",\n \"country\": \"USA\",\n \"password\": \"StrongPassword123\",\n \"company\": \"John's Supplies\",\n \"description\": \"A reliable supplier for electronics.\",\n \"timezone\": \"America/New_York\"\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/sellers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Seller created successfully!\",\n \"seller\": {\n \"id\": 6,\n \"company\": \"Northern Lights Outdoor\",\n \"first_name\": \"Anders\",\n \"last_name\": \"Lindqvist\",\n \"email\": \"anders@northern-lights.example.com\",\n \"tel\": \"+46 8 555 123 45\"\n }\n}"}],"_postman_id":"70b044cb-c11f-46d7-8e5e-097e3c958c51"}],"id":"b9d60aaa-abe5-4cc1-9d91-f863de125838","description":"The products API allows you to view and update individual, or a batch, of products.
\n","_postman_id":"b9d60aaa-abe5-4cc1-9d91-f863de125838"},{"name":"User logs","item":[{"name":"Get user logs","id":"7aeb9fcd-2380-406d-a032-ddebf5752021","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/center/userlogs?page=1","description":"Retrieve user activity logs for the authenticated fulfillment center. Returns 250 items per page. Optional filters: user_id, status, function_name, start_date, end_date, sort_dir.
\n","urlObject":{"path":["portal","api","v2","center","userlogs"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"function_name","value":""},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"start_date","value":"2024-01-01 00:00:00"},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"end_date","value":"2024-12-31 23:59:59"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"}],"variable":[]}},"response":[{"id":"21861ca6-995f-48f0-b1dc-23ab5e65b1a5","name":"Get user logs","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://channeldock.com/portal/api/v2/center/userlogs?page=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","userlogs"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 250,\n \"user_logs\": [\n {\n \"id\": 90042,\n \"status\": \"function_call\",\n \"user_id\": 7,\n \"title\": \"Inventory updated\",\n \"description\": \"Stock amount updated for UPW-BAR-52: 50 → 48\",\n \"created_at\": \"2026-06-14 08:12:30\"\n },\n {\n \"id\": 90031,\n \"status\": \"api_connected\",\n \"user_id\": 7,\n \"title\": \"PostNL gekoppeld\",\n \"description\": \"connectPostNL\",\n \"created_at\": \"2026-06-02 09:14:55\"\n },\n {\n \"id\": 90015,\n \"status\": \"label_created\",\n \"user_id\": 7,\n \"title\": \"Shipping label created\",\n \"description\": \"Order 88210 → label 7701 (PostNL)\",\n \"created_at\": \"2026-06-14 08:12:30\"\n },\n {\n \"id\": 89998,\n \"status\": \"activated_sub_account\",\n \"user_id\": 7,\n \"title\": \"Sub account toegevoegd\",\n \"description\": \"addEmployee – warehouse_picker\",\n \"created_at\": \"2026-05-22 11:05:18\"\n }\n ]\n}"}],"_postman_id":"7aeb9fcd-2380-406d-a032-ddebf5752021"}],"id":"f91436fe-2020-4466-bdfd-1559df3c5855","description":"The user log API allows you to view all user logs, including those of employee accounts. Returns 250 items per page.
\n","_postman_id":"f91436fe-2020-4466-bdfd-1559df3c5855"},{"name":"Inventory logs","item":[{"name":"Get Inventory logs","id":"837807d8-fa83-40e0-b2de-b70929f4a620","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/stockmutations?page=1&ean=8719326583617","description":"Retrieve inventory change history (stock mutations) for the fulfillment center. Returns 250 items per page. Filter by ean, product_id, or sku is recommended but optional.
\n","urlObject":{"path":["portal","api","v2","center","stockmutations"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"optional, required if product_id/sku not used
\n","type":"text/plain"},"key":"ean","value":"8719326583617"},{"disabled":true,"description":{"content":"optional, required if ean/sku not used (Center Product ID)
\n","type":"text/plain"},"key":"product_id","value":""},{"disabled":true,"description":{"content":"optional, required if ean/product_id not used
\n","type":"text/plain"},"key":"sku","value":""},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"start_date","value":"2025-08-13 00:00:00"},{"disabled":true,"description":{"content":"optional (datetime)
\n","type":"text/plain"},"key":"end_date","value":"2025-08-17 23:00:00"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"event_action","value":"correct"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"}],"variable":[]}},"response":[{"id":"32ff7af5-b622-4e24-9f69-4ba56f597cb8","name":"Get Inventory logs","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/inventory/logs?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","center","inventory","logs"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"inventory_logs\": [\n {\n \"id\": 88301,\n \"ean\": \"8719326583631\",\n \"event_action\": \"stock_inbound\",\n \"message\": \"Stocked 50 units of UPW-BAR-52 from delivery 8101\",\n \"old_stock\": 0,\n \"new_stock\": 50,\n \"created_at\": \"2026-06-03 14:22:11\",\n \"total_stock\": 50\n },\n {\n \"id\": 88302,\n \"ean\": \"8719326583631\",\n \"event_action\": \"shipment_picked\",\n \"message\": \"Picked 2 units for shipment 7701 (order WC-88210)\",\n \"old_stock\": 50,\n \"new_stock\": 48,\n \"created_at\": \"2026-06-14 08:12:30\",\n \"total_stock\": 48\n },\n {\n \"id\": 88305,\n \"ean\": \"8719326583655\",\n \"event_action\": \"stock_corrected\",\n \"message\": \"Stock correction by warehouse_picker: 14 → 12\",\n \"old_stock\": 14,\n \"new_stock\": 12,\n \"created_at\": \"2026-06-05 10:12:44\",\n \"total_stock\": 12\n }\n ]\n}"}],"_postman_id":"837807d8-fa83-40e0-b2de-b70929f4a620"}],"id":"893b920d-e788-4a1c-95fd-33318df3d439","description":"Endpoints to retrieve a fulfillment center's inventory change history (stock mutations). Supports filtering by EAN, product ID, SKU, date range, and event action, with pagination (250 items per page).
\n","_postman_id":"893b920d-e788-4a1c-95fd-33318df3d439"},{"name":"Administration","item":[{"name":"Get administration","id":"1c76915d-bd91-46b3-abf5-1c5bc533cbf3","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://channeldock.com/portal/api/v2/center/administration?page=1&start_date=2024-04-01&end_date=2024-04-05","description":"This request's return results are paginated. The API returns 10 items (sellers) per page.
\n","urlObject":{"path":["portal","api","v2","center","administration"],"host":["https://channeldock.com"],"query":[{"key":"page","value":"1"},{"description":{"content":"required: (Format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"start_date","value":"2024-04-01"},{"description":{"content":"required: (Format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"end_date","value":"2024-04-05"},{"disabled":true,"description":{"content":"optional: ID of a seller connected to your FC account
\n","type":"text/plain"},"key":"seller_id","value":"2"}],"variable":[]}},"response":[{"id":"c1b53788-16a3-4b1a-b908-7d9eaf683f10","name":"Get administration","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"page\": 1\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://channeldock.com/portal/api/v2/center/administration?page=1&start_date=2023-01-01&end_date=2024-01-01","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","administration"],"query":[{"key":"page","value":"1"},{"key":"start_date","value":"2023-01-01"},{"key":"end_date","value":"2024-01-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 10,\n \"sellers_count\": 2,\n \"sellers\": [\n {\n \"id\": 2,\n \"company\": \"Upwind Watersports B.V.\",\n \"storage_costs\": 24.8,\n \"pick_costs\": 18.55,\n \"labels\": 142,\n \"label_costs\": 198.4,\n \"order_options_costs\": 4.5,\n \"order_option_amount_4\": 9,\n \"order_option_price_4\": 0.5,\n \"processed_returns\": 3\n },\n {\n \"id\": 5,\n \"company\": \"Sail & Sport Demo\",\n \"storage_costs\": 12.0,\n \"pick_costs\": 6.3,\n \"labels\": 47,\n \"label_costs\": 71.25,\n \"order_options_costs\": 0,\n \"order_option_amount_4\": 0,\n \"order_option_price_4\": 0,\n \"processed_returns\": 0\n }\n ],\n \"custom_fields\": [\n {\n \"id\": 4,\n \"title\": \"Thank-you card\",\n \"price\": 0.5\n },\n {\n \"id\": 5,\n \"title\": \"Gift wrap\",\n \"price\": 1.95\n }\n ]\n}"}],"_postman_id":"1c76915d-bd91-46b3-abf5-1c5bc533cbf3"}],"id":"b7a74f0e-2aeb-4875-95b1-3485a5f15cbc","description":"This endpoint is designed to facilitate streamlined invoicing by gathering a comprehensive set of financial data tied to individual sellers operating under a center, over a specific date range. It supersedes the standard GET orders API in several ways, providing a more holistic view of a seller's financial activities and obligations during the specified period.
Detailed Financial Breakdown:
\nStorage Costs: Know exactly what your storage obligations are with a detailed breakdown of storage costs accrued over the specified time period.
\nPick Costs: Gain insights into the costs associated with picking products.
\nLabel Costs: Understand the financial implications of labels created, including associated costs tied to specific shipping methods.
\nCustomization and Flexibility:
\nDynamic Date Range: Easily fetch data over different time frames to suit various invoicing cycles, be it weekly, monthly, or custom periods.
\nCustom Fields: Tailor the data to suit your needs with customizable fields pertaining to order options.
\nOrder Options Insights:
\nGet the deliveries. Deliveries can have either of three types:
\nReplenishments to your warehouse (outbound)
\nLogistiek via Bol replenishments (bol_outbound)
\nFulfillment by Amazon replinishments (amazon_outbound)
\nrequired
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"236"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"seller_id","value":"1"},{"disabled":true,"description":{"content":"optional ( new | confirmed | stocked )
\n","type":"text/plain"},"key":"status","value":"confirmed"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_attr","value":"updated_at"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional ( default: outbound | bol_outbound | amazon_outbound )
\n","type":"text/plain"},"key":"delivery_type","value":"outbound"},{"disabled":true,"description":{"content":"optional: filter deliveries with delivery_date >= this value. Accepts 'Y-m-d' or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"delivery_date_from","value":"2023-01-01"},{"disabled":true,"description":{"content":"optional: filter deliveries with delivery_date <= this value. Accepts 'Y-m-d' (treated as 23:59:59) or 'Y-m-d H:i:s'.
\n","type":"text/plain"},"key":"delivery_date_to","value":"2023-01-31"},{"disabled":true,"description":{"content":"optional ( datetime in UTC )
\n","type":"text/plain"},"key":"updated_at","value":"2025-07-23 12:34:36"}],"variable":[]}},"response":[{"id":"2862e437-514e-4289-b41f-54d4fce69b6b","name":"Get inbounds","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/inbounds","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","inbounds"],"query":[{"key":"page","value":"1","disabled":true},{"key":"id","value":"236","description":"optional","disabled":true},{"key":"seller_id","value":"1","disabled":true},{"key":"status","value":"confirmed","description":"optional ( new | confirmed | stocked )","disabled":true},{"key":"sort_attr","value":"updated_at","description":"optional","disabled":true},{"key":"sort_dir","value":"DESC","description":"optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 10,\n \"inbounds_count\": 1,\n \"inbounds\": [\n {\n \"id\": 8101,\n \"seller_id\": 2,\n \"ref\": \"PO-2026-0042\",\n \"status\": \"stocked\",\n \"extra_description\": \"Restock from PowerKite – Q2 order.\",\n \"pallets\": 1,\n \"boxes\": 4,\n \"delivery_date\": \"2026-06-02\",\n \"stocked_at\": \"2026-06-03 14:22:11\",\n \"created_at\": \"2026-05-18 10:05:00\",\n \"supplier_id\": 42,\n \"supplier\": {\n \"id\": 42,\n \"firstname\": \"Klaus\",\n \"lastname\": \"Berger\",\n \"company\": \"PowerKite Manufacturing GmbH\",\n \"phone\": \"+49 89 1234 5678\",\n \"email\": \"orders@powerkite.example.com\",\n \"address1\": \"Industriestraße 12\",\n \"address2\": \"\",\n \"city\": \"München\",\n \"state\": \"Bayern\",\n \"zipcode\": \"80331\",\n \"country\": \"DE\",\n \"payment_term\": 30,\n \"website\": \"https://powerkite.example.com\",\n \"vat\": 19,\n \"vat_number\": \"DE123456789\",\n \"email_text\": \"Hi Klaus,\\\\n\\\\nPlease find our latest purchase order attached.\\\\n\\\\nBest regards,\\\\nUpwind Watersports\"\n },\n \"items\": [\n {\n \"product_id\": 7,\n \"ean\": \"8719326583631\",\n \"sku\": \"UPW-BAR-52\",\n \"location\": \"B-12\",\n \"amount\": 50,\n \"ref\": \"PO-2026-0042-L1\",\n \"stock_location_id\": 114,\n \"is_stocked\": 1\n },\n {\n \"product_id\": 9,\n \"ean\": \"8719326583655\",\n \"sku\": \"UPW-BRD-134\",\n \"location\": \"PR-A\",\n \"amount\": 12,\n \"ref\": \"PO-2026-0042-L2\",\n \"stock_location_id\": 113,\n \"is_stocked\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"f3b3f032-cc8a-45fa-94e8-2282e2f5f87a"},{"name":"Create inbound","id":"6dd540b4-a4a0-43ea-a623-5158f005f3b0","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 950,\n \"ref\": \"1234567890\",\n \"status\": \"confirmed\",\n \"delivery_date\": \"2021-12-10\",\n \"extra_description\": \"This inbound was automatically created using the API.\",\n \"pallets\": 0,\n \"boxes\": 1,\n \"items\": [\n {\n \"ean\": \"8719326801019\",\n \"amount\": 10,\n \"is_stocked\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds","description":"This endpoint lets you create a new inbound delivery to your fulfillment center. After creating the inbound you can use the PUT method to update it.
\nInbound status can be: 'new', 'confirmed', 'delivered', 'stocked', 'shipped', 'cancelled'.
\n","urlObject":{"path":["portal","api","v2","center","inbounds"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"38d76fa2-0252-4912-8504-f29f8b0e22d8","name":"Create inbound","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"seller_id\": 3,\n \"ref\": \"1234567890\",\n \"status\": \"confirmed\",\n \"delivery_date\": \"2021-12-10\",\n \"extra_description\": \"This inbound was automatically created using the API.\",\n \"pallets\": 0,\n \"boxes\": 1,\n \"items\": [\n {\n \"ean\": \"8719326801019\",\n \"amount\": 10,\n \"is_stocked\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Inserted inbound: 8102\",\n \"inbound_id\": 8102\n}"}],"_postman_id":"6dd540b4-a4a0-43ea-a623-5158f005f3b0"},{"name":"Update inbound","id":"fbf2721c-c4fc-4d50-82be-da69009f0517","request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"inbound_id\": 418,\n \"ref\": \"1234567890\",\n \"status\": \"stocked\",\n \"delivery_date\": \"2021-12-10\",\n \"extra_description\": \"This inbound was automatically created using the API.\",\n \"pallets\": 0,\n \"boxes\": 1,\n \"items\": [\n {\n \"id\": \"1001\",\n \"amount\": 100,\n \"is_processed\": 0\n },\n {\n \"ean\": \"4548736091948\",\n \"amount\": 25,\n \"is_processed\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds","description":"This endpoint updates the inbound delivery. For example, when the whole delivery is accepted and stocked by your warehouse, you can set the inbound status to stocked and each inbound item to: 'is_processed': 1.
\nWhen updating the inbound to be stocked, ChannelDock does not actually add the inbound item amount to your stock level. We expect this to happen through a stock level update through the Products endpoint.
\nInbound status can be: 'new', 'confirmed', 'delivered', 'stocked', 'shipped', 'cancelled'.
\nWhen updating the inbound items, you can send us either the item 'id' or 'ean'. When the EAN is not found in the inbound, we will add it as a new item.
\n","urlObject":{"path":["portal","api","v2","center","inbounds"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"ef1cf3bb-32b2-4613-8f08-afaba6b380ba","name":"Update inbound","originalRequest":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"inbound_id\": 236,\n \"ref\": \"1234567890\",\n \"status\": \"stocked\",\n \"delivery_date\": \"2021-12-10\",\n \"extra_description\": \"This inbound was automatically created using the API.\",\n \"pallets\": 0,\n \"boxes\": 1,\n \"items\": [\n {\n \"id\": \"1001\",\n \"amount\": 100,\n \"is_processed\": 0\n },\n {\n \"ean\": \"870987654321\",\n \"amount\": 20,\n \"is_processed\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Updated inbound: 8101\",\n \"inbound_id\": 8101\n}"}],"_postman_id":"fbf2721c-c4fc-4d50-82be-da69009f0517"},{"name":"Delete inbound","id":"36d0c369-528f-4006-93a1-f80aa474bc53","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"inbound_id\": 235\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds","description":"Create a new inbound delivery from your supplier. It is at this moment not yet possible to confirm and stock the inbound via the API.
\n","urlObject":{"path":["portal","api","v2","center","inbounds"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"df237752-4486-49ec-a6a6-d6b6a72d1e26","name":"Delete inbound","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"inbound_id\": 235\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Successfully deleted inbound: 8101\"\n}"}],"_postman_id":"36d0c369-528f-4006-93a1-f80aa474bc53"},{"name":"Stock inbound items","id":"39761e88-a1ca-4105-bd21-e04d5e4d19cb","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"inbound_id\": 236,\n \"items\": [\n {\n \"ean\": \"8719326801019\",\n \"amount\": 15\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/inbounds/stock","description":"The POST /portal/api/v2/center/inbounds/stock endpoint is used to add stock for inbound items. The request should include the inbound_id and an array of items, where each item contains the ean (European Article Number) and the amount of stock to be added.
Please note that this endpoint only processes the status of the inbound items and does not actually increase the stock level. We expect you to increase the stock level in your internal WMS and then send the updated stock levels to us via the products API.
\ninbound_id (number): The ID of the inbound item.items (array): An array of objects containing the following parameters:ean (string): The European Article Number of the item.amount (number): The amount of stock to be added for the item.response (string): Indicates the status of the request, where \"success\" denotes a successful operation.message (string): Provides a message regarding the outcome of the stock addition operation.{\n \"response\": \"success\",\n \"message\": \"Succesfully stocked 1 inbound item(s)\"\n}\n\nDeliveries represent incoming shipments of products from sellers to a fulfillment center.Purpose:
\nTrack shipments from sellers as they arrive
\nRecord what products and quantities are included
\nManage the receiving process (confirm arrival, mark items as received)
\nUpdate inventory when items are stocked
\nMonitor shipment status (new, confirmed, delivered, stocked, shipped, cancelled)
\nTypical flow:
\nSeller creates a delivery with products to send
\nShipment is sent to the fulfillment center
\nCenter receives and confirms the delivery
\nCenter marks items as stocked
\nProducts become available for order fulfillment
\nList tasks for the authenticated fulfillment center (tasks.center_id). Returns all statuses unless you filter with status.
Default pagination: 50 items per page (max 100). Sort by created_at using sort_dir (default DESC).
required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional (default 50, max 100)
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional (ASC | DESC, sorts on created_at)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional (single task, internal tasks.id)
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"optional (open, in_progress, waiting, completed, cancelled — comma-separated allowed)
\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"optional (assignee user id, must be account employee)
\n","type":"text/plain"},"key":"planned_for_user_id","value":""},{"disabled":true,"description":{"content":"optional (connected seller only)
\n","type":"text/plain"},"key":"seller_id","value":""},{"disabled":true,"description":{"content":"optional (ChannelDock order id)
\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"product_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"return_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"task_category_id","value":""},{"disabled":true,"description":{"content":"optional (partial match on title and description)
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"optional (filters planned_datetime)
\n","type":"text/plain"},"key":"date_from","value":"2026-01-01"},{"disabled":true,"description":{"content":"optional (filters planned_datetime)
\n","type":"text/plain"},"key":"date_to","value":"2026-12-31"}],"variable":[]}},"response":[{"id":"6b2e9853-d8a6-4958-8407-e0f71b247861","name":"Get tasks","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/tasks?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","center","tasks"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"tasks\": [\n {\n \"id\": 501,\n \"title\": \"Relabel inbound pallet\",\n \"description\": null,\n \"status\": \"in_progress\",\n \"created_at\": \"2026-03-24 09:30:00\",\n \"completed_at\": null,\n \"planned_datetime\": \"2026-03-24 15:00:00\",\n \"planned_end_datetime\": null,\n \"created_by_user_id\": 10,\n \"planned_for_user_id\": 15,\n \"order_id\": null,\n \"product_id\": null,\n \"return_id\": null,\n \"delivery_id\": 9001,\n \"seller_id\": 2,\n \"center_id\": 3,\n \"task_category_id\": 8,\n \"task_price\": 12.5,\n \"task_currency\": \"EUR\",\n \"is_internal\": true\n }\n ]\n}"}],"_postman_id":"ff1b57af-3314-4d94-97b8-1384bc3ed380"},{"name":"Create task","id":"38c2d6c2-6d7d-41d4-9a7b-d4814653b366","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Relabel inbound pallet\",\n \"seller_id\": 2,\n \"delivery_id\": 9001,\n \"status\": \"open\",\n \"is_internal\": true,\n \"planned_for_user_id\": 15\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/tasks","description":"Create a new task for the fulfillment center.
\nRequired: title
Optional: description, planned_for_user_id, planned_datetime, planned_end_datetime, order_id, product_id, return_id, delivery_id, task_category_id (or category_id), task_price, task_currency (default EUR), seller_id (must be connected), status (open, in_progress, waiting, completed, cancelled — default open), is_internal (boolean).
Rules:
\ncenter_id is set automatically for the authenticated center.seller_id is omitted, it may be derived from the linked product, order, return, or delivery.Create and list operational tasks for the fulfillment center. Tasks can be linked to connected sellers, orders, products, returns, or deliveries.
\nEnable Tasks (GET and POST) on your API key in ChannelDock settings before calling these endpoints.
\n","_postman_id":"cdca5875-f376-434a-9785-40fd91d2c872"},{"name":"Batches","item":[{"name":"Get Batch Templates","id":"6a912837-42bb-45b7-aa46-1165cd0882b9","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/batchtemplates?page=1","urlObject":{"path":["portal","api","v2","center","batchtemplates"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional default: 50 max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"1, 2, 3"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"seller_id","value":"1"},{"disabled":true,"description":{"content":"optional (true | false | ALL)
\n","type":"text/plain"},"key":"active","value":"ALL"},{"disabled":true,"description":{"content":"optional (id | priority | active | created_at | updated_at | seller_id)
\n","type":"text/plain"},"key":"sort_attr","value":"priority"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"include","value":"requirements"}],"variable":[]}},"response":[{"id":"884e1ac0-6d99-469d-96c9-4f5de36b80ce","name":"Get Batch Templates","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/batchtemplates?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","center","batchtemplates"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"batch_templates_count\": 2,\n \"batch_templates\": [\n {\n \"id\": 401,\n \"seller_id\": 0,\n \"center_id\": 1,\n \"description\": \"Standard NL Orders\",\n \"priority\": 1,\n \"active\": true,\n \"match_type\": \"all\",\n \"max_orders\": 100,\n \"max_order_items\": null,\n \"pick_algorithm\": \"fifo\",\n \"batch_category\": \"standard\",\n \"created_at\": \"2026-04-01 09:00:00\",\n \"updated_at\": \"2026-06-10 12:30:00\",\n \"requirements\": [\n {\n \"requirement\": \"country\",\n \"operator\": \"equals\",\n \"value\": \"NL\"\n },\n {\n \"requirement\": \"order_status\",\n \"operator\": \"equals\",\n \"value\": \"order\"\n }\n ]\n },\n {\n \"id\": 402,\n \"seller_id\": 12,\n \"center_id\": 1,\n \"description\": \"Bol.com Express\",\n \"priority\": 2,\n \"active\": true,\n \"match_type\": \"all\",\n \"max_orders\": 50,\n \"max_order_items\": 200,\n \"pick_algorithm\": \"lifo\",\n \"batch_category\": \"express\",\n \"created_at\": \"2026-04-15 11:20:00\",\n \"updated_at\": \"2026-06-08 09:00:00\",\n \"requirements\": [\n {\n \"requirement\": \"channel\",\n \"operator\": \"equals\",\n \"value\": \"bolcom\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"6a912837-42bb-45b7-aa46-1165cd0882b9"},{"name":"Get Batches","id":"5082b5a9-1982-4786-86e9-5dca72034645","request":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":"https://channeldock.com/portal/api/v2/center/batches?page=1","urlObject":{"path":["portal","api","v2","center","batches"],"host":["https://channeldock.com"],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"optional default: 50 max: 100
\n","type":"text/plain"},"key":"page_size","value":"50"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"id","value":"1, 2, 3"},{"disabled":true,"description":{"content":"optional (pending | picking | picked | packing | shipped)
\n","type":"text/plain"},"key":"batch_status","value":"pending"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"batch_template_id","value":"1"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"created_at_from","value":"YYYY-mm-dd"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"created_at_to","value":"YYYY-mm-dd"},{"disabled":true,"description":{"content":"optional (id | created_at | batch_status | batch_template_id)
\n","type":"text/plain"},"key":"sort_attr","value":"id"},{"disabled":true,"description":{"content":"optional (ASC | DESC)
\n","type":"text/plain"},"key":"sort_dir","value":"DESC"},{"disabled":true,"description":{"content":"optional (template | template_requirements | counts | orders | order_products)
\n","type":"text/plain"},"key":"include","value":"template, counts"}],"variable":[]}},"response":[{"id":"5e7dadcb-dfdf-4761-acdf-352d66cfc8f5","name":"Get Batches","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/batches?page=1","host":["https://channeldock.com"],"path":["portal","api","v2","center","batches"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"batches_count\": 2,\n \"batches\": [\n {\n \"id\": 11001,\n \"center_id\": 1,\n \"batch_title\": \"Morning batch 2026-06-14\",\n \"batch_status\": \"picking\",\n \"batch_template_id\": 401,\n \"assigned_user_id\": 1,\n \"batch_cart_number\": \"batch_cart_A12\",\n \"created_at\": \"2026-06-14 08:00:00\",\n \"updated_at\": \"2026-06-14 08:15:30\",\n \"template\": {\n \"id\": 401,\n \"description\": \"Standard NL Orders\"\n },\n \"orders\": [\n {\n \"id\": 88210,\n \"seller_id\": 12,\n \"order_id\": \"WC-88210\",\n \"seq_order_id\": \"UPW-2026-00415\",\n \"order_status\": \"order\",\n \"order_date\": \"2026-06-13 09:24:11\",\n \"ship_on_date\": \"2026-06-14\",\n \"shipping_first_name\": \"Lars\",\n \"shipping_last_name\": \"van Schaick\",\n \"shipping_country_code\": \"NL\"\n }\n ]\n },\n {\n \"id\": 11002,\n \"center_id\": 1,\n \"batch_title\": \"Afternoon batch 2026-06-14\",\n \"batch_status\": \"pending\",\n \"batch_template_id\": 402,\n \"assigned_user_id\": null,\n \"batch_cart_number\": null,\n \"created_at\": \"2026-06-14 12:30:00\",\n \"updated_at\": \"2026-06-14 12:30:00\",\n \"template\": {\n \"id\": 402,\n \"description\": \"Bol.com Express\"\n },\n \"orders\": []\n }\n ]\n}"}],"_postman_id":"5082b5a9-1982-4786-86e9-5dca72034645"},{"name":"Update batch status","id":"eb340a63-2929-42e4-9f99-6815fdfdb3c9","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"[\n {\n \"batch_id\": 8279454,\n \"batch_status\": \"picking\",\n \"assign_user_id\": \"user@example.com\",\n \"batch_cart_number\": \"batch_cart_A12\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/batches","description":"Update the status of one or more batches. You can also record which pick cart or box a batch was picked into.
\nSend a single object, or an array of objects (max 200). If the same batch_id appears more than once, only the last object is applied.
batch_id (integer) or batch_ids (array of integers) — required. Use batch_ids only on a single-object request.batch_status (string, required) — pending | picking | picked | packing | shippedassign_user_id (integer or string, required) — user ID or email of the picker/packer. This is not necessarily the API key owner.batch_cart_number (string, optional) — cart/box codes for this batch. Same format as in the portal: each code must start with batch_cart_. Multiple codes may be separated by commas, spaces or semicolons (they are stored as a comma-separated string). Max 100 characters after normalization. Send an empty string to clear the cart. A non-empty cart can only be set when updating a single batch.batch_status, assigned_user_id, batch_cart_numberupdated_ids, updated_count — batches whose status was updatedcart_updated_ids — batches whose cart number was updatedskipped, skipped_count — batches that could not be updated (with a reason)The Batches API allows you to retrieve and update batch information for your fulfillment center account. Batches represent groups of orders that are processed together for picking, packing, and shipping operations. PUT can also set batch_cart_number (cart/box codes starting with batch_cart_) on a single batch.
Get a list of all returns.
\nAdd include_attachments=true to also get each return's uploaded files, with the file content included as base64 (base64_content) — no extra call needed to read attachment content. It's opt-in because it downloads every file from storage, which isn't free. Without it, the attachments field is omitted entirely.
optional (default false): also return each return's attachments, with base64_content included
\n","type":"text/plain"},"key":"include_attachments","value":"true"},{"disabled":true,"key":"id","value":"13"},{"disabled":true,"description":{"content":"ChannelDock Order ID
\n","type":"text/plain"},"key":"order_id","value":"12345"},{"disabled":true,"key":"sort_attr","value":"order_id"},{"disabled":true,"description":{"content":"ASC or DESC
\n","type":"text/plain"},"key":"sort_dir","value":"ASC"},{"disabled":true,"description":{"content":"Order ID from e.g. Amazon or bol.com
\n","type":"text/plain"},"key":"remote_order_id","value":"12345"},{"disabled":true,"description":{"content":"Return ID from e.g. Amazon or bol.com
\n","type":"text/plain"},"key":"remote_return_id","value":"12345"},{"disabled":true,"description":{"content":"1 or 0
\n","type":"text/plain"},"key":"is_handled","value":"1"},{"disabled":true,"key":"start_handled_date","value":"2024-01-01"},{"disabled":true,"key":"end_handled_date","value":"2024-01-03"}],"variable":[]}},"response":[{"id":"17458630-6d8e-47f3-b05e-00fa6374fc45","name":"Get returns","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"url":{"raw":"https://channeldock.com/portal/api/v2/center/returns?page=1&order_id=12345&sort_attr=order_id&sort_dir=ASC&remote_order_id=12345&remote_return_id=12345&is_handled=1","protocol":"https","host":["channeldock","com"],"path":["portal","api","v2","center","returns"],"query":[{"key":"page","value":"1"},{"key":"id","value":"13","disabled":true},{"key":"order_id","value":"12345","description":"ChannelDock Order ID"},{"key":"sort_attr","value":"order_id"},{"key":"sort_dir","value":"ASC","description":"ASC or DESC"},{"key":"remote_order_id","value":"12345","description":"Order ID from e.g. Amazon or bol.com"},{"key":"remote_return_id","value":"12345","description":"Return ID from e.g. Amazon or bol.com"},{"key":"is_handled","value":"1","description":"1 or 0"},{"key":"include_attachments","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"page\": 1,\n \"page_size\": 50,\n \"return_count\": 1,\n \"returns\": [\n {\n \"id\": 9301,\n \"api_id\": 2450,\n \"order_id\": 88211,\n \"remote_return_id\": \"BOL-RET-77123\",\n \"is_handled\": 1,\n \"handled_date\": \"2026-06-13 11:14:08\",\n \"created_at\": \"2026-06-12 16:45:22\",\n \"channel_id\": 1,\n \"custom_return_comment\": \"Return product 8719326583648 handled by Lars van Schaick (RETURN_RECEIVED).\",\n \"return_products\": [\n {\n \"id\": 12211,\n \"api_id\": 2450,\n \"ean\": \"8719326583648\",\n \"quantity\": 1,\n \"reason\": \"Defective seam\",\n \"return_status\": \"RETURN_RECEIVED\",\n \"return_id\": 9301,\n \"order_id\": 88211,\n \"remote_order_id\": \"BOL-19877\",\n \"restocked\": 0,\n \"stock_location_id\": 0,\n \"track_and_trace\": \"3SBOLRET00099\",\n \"child_from_bundle\": 0,\n \"order_product\": {\n \"id\": 91215,\n \"api_id\": 2450,\n \"seller_id\": 1,\n \"center_id\": 0,\n \"order_id\": 88211,\n \"orderItemId\": \"BOL-88211-1\",\n \"ean\": \"8719326583648\",\n \"title\": \"Wetsuit Predator 5/4 Freezip - Size M\",\n \"price\": 189.95,\n \"quantity\": 1,\n \"is_shipped\": 1\n }\n }\n ],\n \"attachments\": [\n {\n \"id\": 501,\n \"name\": \"9301-64f1c2a1b2c3d-damage.jpg\",\n \"extension\": \"jpg\",\n \"content_type\": \"image/jpeg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"c0bdd656-a434-4a5b-8dd3-802685703b0b"},{"name":"Create return","id":"1c819d89-891a-44f2-bda9-04530c372aa3","request":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_action\": \"PENDING\",\n \"return_track_trace\": \"3SABCD123456789\",\n \"order_products\": [\n {\n \"order_id\": 123456,\n \"quantity\": 1,\n \"reason\": \"DAMAGED\"\n },\n {\n \"order_id\": 123456,\n \"quantity\": 2,\n \"reason\": \"NOT_AS_DESCRIBED\"\n }\n ],\n \"attachments\": [\n {\n \"filename\": \"damage-photo-1.jpg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n },\n {\n \"filename\": \"invoice.pdf\",\n \"base64_content\": \"JVBERi0xLjQKJcTl8uXr...BASE64...\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/returns","description":"This endpoint allows you to create a new return based on a set of order products. To initiate a return, send a POST request containing an order_products array, where each item specifies the related order_product_id and the quantity to be returned. At least one product must have a quantity greater than zero for the return to be created successfully.
\nOptionally, you may provide a return_action. If omitted, the return will default to PENDING.
\nYou can also include a return_track_trace value to store tracking information for the return shipment.
\nAdditionally, this endpoint supports uploading attachments, such as photos or documents related to the return (e.g. damage images or invoices). Attachments must be provided as base64-encoded content and will be validated and stored upon successful return creation.
\nIf the request is valid, the API creates a new return record, associates the provided products, stores any tracking information, and processes any supplied attachments. In case of an error, the API responds with an appropriate HTTP status code and a descriptive error message.
\norder_products (array, required)
\nList of order products to be returned. Each item must include:
\norder_product_id (integer, required)
\nquantity (integer, required, must be greater than 0)
\nreturn_action (string, optional)
\nThe initial status of the return. Defaults to PENDING.
\nAllowed values:
\nPENDING, RETURN_RECEIVED, EXCHANGE_PRODUCT, REPAIR_PRODUCT, STILL_APPROVED, RETURN_DOES_NOT_MEET_CONDITIONS, CUSTOMER_KEEPS_PRODUCT_PAID
\nreturn_track_trace (string, optional)
\nTrack and trace code for the return shipment.
\nattachments (array, optional)
\nFiles related to the return, provided as base64-encoded content. Each attachment must include:
\nfilename (string)
\nbase64_content (string, base64-encoded file content)
\nThis endpoint allows you to update an existing return by its return ID. To process a return, send a PUT request including the return_id and the fields you wish to update.
\nYou can mark a return as handled by setting is_handled to true. When a return is marked as handled, the system automatically records the handling timestamp.
\nYou can flag or unflag a return for attention by setting needs_attention to true/false — the same field as the portal UI's \"needs attention\" toggle.
\nOptionally, you may include attachments such as photos or documents related to the return. Attachments must be provided as base64-encoded content and will be validated and stored if the update is successful.
\nIf the return ID is valid and belongs to a seller connected to the authenticated center, the return record is updated accordingly and any provided attachments are processed. In case of an error, the API responds with an appropriate HTTP status code and a descriptive error message.
\nreturn_id (integer, required)
\nThe unique identifier of the return to be updated.
\nis_handled (boolean, optional)
\nIndicates whether the return has been processed.
\nWhen set to true, the return is marked as handled and a handling date is automatically assigned.
\nneeds_attention (boolean, optional)
\nFlags (true) or unflags (false) the return for attention.
\nFiles related to the return, provided as base64-encoded content. Each attachment must include:
\nfilename (string)
\nbase64_content (string, base64-encoded file content)
\nAdd one or more attachments to an existing return, after it has already been created. This is the same attachment logic used by POST/PUT /returns, but for attaching files after the fact — the return is identified in the body (return_id), not in the URL, matching the rest of this API. The center resolves the return via its connected sellers.
return_id (integer, required)
\nThe return to attach the files to.
\nattachments (array, required)
\nOne or more files, each an object with:
\nfilename (string, required)
\nbase64_content (string, required, base64-encoded file content)
\nAllowed file extensions: png, jpg, jpeg, gif, webp, zip, pdf, docx, xlsx, xls, csv. Max 10MB per file.
\nThe return must belong to a seller connected to the authenticated center, otherwise the API responds with an appropriate HTTP status code and error message.
\n","urlObject":{"path":["portal","api","v2","center","returns","attachments"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"520b5103-2831-4263-a34d-f3b66b556658","name":"Add return attachments","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachments\": [\n {\n \"filename\": \"extra-photo.jpg\",\n \"base64_content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD...BASE64...\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/returns/attachments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"attachments_uploaded\": 1\n}"}],"_postman_id":"576ed610-ff05-4cdf-a67a-89a5c432a107"},{"name":"Delete return attachment","id":"0d7644d1-8772-44a4-9105-8e673005c1ce","request":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachment_id\": 501\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/returns/attachments","description":"Delete a single uploaded attachment from a return.
\nreturn_id (integer, required)
\nThe return the attachment belongs to.
\nattachment_id (integer, required)
\n The id value from the attachments array (returned by GET /returns?include_attachments=true).
The return must belong to a seller connected to the authenticated center. Deletion removes the file from storage and its database record; if storage deletion fails, the database record is still removed.
\n","urlObject":{"path":["portal","api","v2","center","returns","attachments"],"host":["https://channeldock.com"],"query":[],"variable":[]}},"response":[{"id":"97aa5df8-7ba3-4f26-93c0-8af2a6372668","name":"Delete return attachment","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"api-secret","value":"xxxx-xxxx-xxxx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"return_id\": 98765,\n \"attachment_id\": 501\n}","options":{"raw":{"language":"json"}}},"url":"https://channeldock.com/portal/api/v2/center/returns/attachments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\",\n \"message\": \"Attachment ID 501 deleted!\"\n}"}],"_postman_id":"0d7644d1-8772-44a4-9105-8e673005c1ce"}],"id":"0a3fe3fa-64d5-4cf5-af4b-e15990147a4d","description":"A seller can manually create a return in their account. Using this endpoint you can fetch all open (?is_handled=0) or processed (?is_handled=1) returns.
\n","_postman_id":"0a3fe3fa-64d5-4cf5-af4b-e15990147a4d"}],"id":"e0b8da3c-ed71-4455-89d1-794dc7bef769","description":"The Fulfillment center API can be used to perform several functions. Most of the time you can filter based on seller_id. Bundles and product tags are documented alongside products.
\nThe base URL is: https://channeldock.com
\n","_postman_id":"e0b8da3c-ed71-4455-89d1-794dc7bef769"}],"variable":[{"key":"BASE_URL","value":"https://channeldock.com"},{"key":"API_KEY_SELLER","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"API_SECRET_SELLER","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"API_KEY_CENTER","value":"xxxx-xxxx-xxxx-xxxx"},{"key":"API_SECRET_CENTER","value":"xxxx-xxxx-xxxx-xxxx"}]}