{ "item": [ { "name": "Status", "description": "Health and uptime of the API itself.", "item": [ { "id": "fa7f067e-d2de-41d7-aada-e63364dbb7da", "name": "API health check", "request": { "name": "API health check", "description": { "content": "Unauthenticated liveness probe. Returns `ok` when the API and its database are reachable. Powers the Status page on this site.\n", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "05de79b0-3a77-4167-b614-d1bf494a3923", "name": "API operational.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"status\": \"degraded\",\n \"time\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6da7b782-c0d4-435d-bc4e-0f06266ef14e", "name": "API degraded (database unreachable).", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec662f19-c21a-45fd-bc09-fdc2d630669b", "name": "API status (monitored)", "request": { "name": "API status (monitored)", "description": { "content": "Aggregated health of the API as monitored from Nembol's own infrastructure (one probe per minute, 7 days of history): current state, 24-hour uptime, average latency and half-hour buckets. Unauthenticated; powers the public Status page.\n", "type": "text/plain" }, "url": { "path": [ "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "752b3d0c-3fef-4bf2-98f1-3154639bdb73", "name": "Current aggregated status.", "originalRequest": { "url": { "path": [ "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"state\": \"down\",\n \"last_check\": {\n \"time\": \"\",\n \"ok\": \"\",\n \"latency_ms\": \"\"\n },\n \"uptime_24h\": \"\",\n \"avg_latency_ms\": \"\",\n \"buckets\": [\n {\n \"t\": \"\",\n \"up_ratio\": \"\"\n },\n {\n \"t\": \"\",\n \"up_ratio\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Store", "description": "", "item": [ { "id": "5dac3eba-c9a0-4752-8b3f-c397c6c1e35f", "name": "Retrieve the store", "request": { "name": "Retrieve the store", "description": { "content": "Returns the store this API key belongs to, its plan, base currency and the scopes of the current key. Canonical \"test your key\" endpoint.\n", "type": "text/plain" }, "url": { "path": [ "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3fd8776c-be81-4730-b94b-a1e60721b1b6", "name": "The store.", "originalRequest": { "url": { "path": [ "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"name\": \"\",\n \"currency\": \"\",\n \"plan\": \"\",\n \"mode\": \"test\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53201990-b647-4d80-a212-097602d71bc6", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Channel accounts", "description": "Connected channel accounts and per-account discovery: categories, attribute schemas and policies. Read-only — connecting accounts happens in the Nembol dashboard.\n", "item": [ { "id": "e8335db2-e5d8-4706-9223-44dd257f2ec9", "name": "List channel accounts", "request": { "name": "List channel accounts", "description": { "content": "One entry per connected account. A seller with two eBay accounts has two entries with different ids. Always take `id` from here — never construct it.\n", "type": "text/plain" }, "url": { "path": [ "channel_accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0037d3e7-8df0-47a1-a1cb-7cb094d63139", "name": "Connected channel accounts.", "originalRequest": { "url": { "path": [ "channel_accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"channel\": \"\",\n \"label\": \"\",\n \"shop_name\": \"\",\n \"status\": \"disconnected\",\n \"sync\": {\n \"product_edits\": \"\",\n \"quantity_from_orders\": \"\",\n \"quantity_from_channel_edits\": \"\",\n \"content_from_channel_edits\": \"\"\n },\n \"pricing\": {\n \"mode\": \"off\",\n \"value\": \"\"\n },\n \"inventory\": {\n \"control\": \"\",\n \"threshold\": \"\"\n },\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"channel\": \"\",\n \"label\": \"\",\n \"shop_name\": \"\",\n \"status\": \"disconnected\",\n \"sync\": {\n \"product_edits\": \"\",\n \"quantity_from_orders\": \"\",\n \"quantity_from_channel_edits\": \"\",\n \"content_from_channel_edits\": \"\"\n },\n \"pricing\": {\n \"mode\": \"percentage\",\n \"value\": \"\"\n },\n \"inventory\": {\n \"control\": \"\",\n \"threshold\": \"\"\n },\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf92f53-c94d-440a-a9fd-d4113daf6bec", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "channel_accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3400acca-9bc3-4b77-8854-a08a1058225b", "name": "Retrieve a channel account", "request": { "name": "Retrieve a channel account", "description": {}, "url": { "path": [ "channel_accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2b003497-4611-46dc-bf17-2364edf389c5", "name": "The channel account.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"channel\": \"\",\n \"label\": \"\",\n \"shop_name\": \"\",\n \"status\": \"disconnected\",\n \"sync\": {\n \"product_edits\": \"\",\n \"quantity_from_orders\": \"\",\n \"quantity_from_channel_edits\": \"\",\n \"content_from_channel_edits\": \"\"\n },\n \"pricing\": {\n \"mode\": \"percentage\",\n \"value\": \"\"\n },\n \"inventory\": {\n \"control\": \"\",\n \"threshold\": \"\"\n },\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1294681f-ab23-4553-9789-fc88c55892ea", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92dd8754-4327-43bf-9755-b2b8a225572e", "name": "Search channel categories", "request": { "name": "Search channel categories", "description": { "content": "Search the channel's category tree (e.g. eBay categories, Etsy taxonomy, Kaufland categories). Support varies by channel — see the `discovery` flags on the channel account. Channels without a category model (e.g. Shopify) return an empty list.\n", "type": "text/plain" }, "url": { "path": [ "channel_accounts", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "List children of a category instead of searching.", "type": "text/plain" }, "key": "parent_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "90416d01-dd87-47a5-b12d-4441d193fee3", "name": "Matching categories.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "List children of a category instead of searching.", "type": "text/plain" }, "key": "parent_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"leaf\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"leaf\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b76c1fb4-4af7-4cef-a7fb-3ded666e4939", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "List children of a category instead of searching.", "type": "text/plain" }, "key": "parent_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51f72a21-57b6-4600-a5b9-529d54abdef9", "name": "Retrieve the attribute schema for a category", "request": { "name": "Retrieve the attribute schema for a category", "description": { "content": "The JSON Schema describing which listing `attributes` the channel requires or accepts for this category (eBay item aspects, Etsy properties, Kaufland/OnBuy attributes…). Validate listing attributes against it before publishing; Nembol validates at write time with the same schema.\n", "type": "text/plain" }, "url": { "path": [ "channel_accounts", ":id", "categories", ":category_id", "attribute_schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "category_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ddc1312f-c711-46ed-bf36-b157c7e9fbb1", "name": "The attribute schema.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "categories", ":category_id", "attribute_schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "category_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"category_id\": \"\",\n \"schema\": {\n \"key_0\": 4749,\n \"key_1\": 1650.9008728398278\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "234a36ff-7de0-4bbd-9706-e416fd947eb6", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "categories", ":category_id", "attribute_schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "category_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd1e08e0-0a7e-4fc8-b8e8-c27e59e0f13c", "name": "List channel policies", "request": { "name": "List channel policies", "description": { "content": "Shipping, return and payment policies stored on the channel account (eBay Business Policies, Etsy shipping profiles…). Reference them by id in listing overrides where supported. Read-only.\n", "type": "text/plain" }, "url": { "path": [ "channel_accounts", ":id", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4f919f94-c49f-4511-95dc-491685c35cc0", "name": "Policies.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"payment\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"payment\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32149b59-1e9d-4427-9355-3d767e2d3746", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Products", "description": "", "item": [ { "id": "a0f285ad-c458-4501-b32f-b403b06094fc", "name": "List products", "request": { "name": "List products", "description": { "content": "Stable ordering (`updated_at` desc, `id` tiebreak). Use `updated_after` for incremental sync crawls.\n", "type": "text/plain" }, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of ready,listed,archived,sold_out,error,ongoing)", "type": "text/plain" }, "key": "status", "value": "ready" }, { "disabled": false, "description": { "content": "Exact match on any variant SKU.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cceda469-8a54-41a5-af1f-545b3037107d", "name": "Paginated products.", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of ready,listed,archived,sold_out,error,ongoing)", "type": "text/plain" }, "key": "status", "value": "ready" }, { "disabled": false, "description": { "content": "Exact match on any variant SKU.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"oz\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"m\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"sold_out\",\n \"sync_status\": \"error\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"57219580.70\",\n \"msrp\": \"999828378.80\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"660115158.98\",\n \"msrp\": \"62840046966.75\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"error\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"oz\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"in\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\n \"sync_status\": \"pending\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"8033.44\",\n \"msrp\": \"576.88\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"8288031398.87\",\n \"msrp\": \"60.66\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"error\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"listed\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9d4076-e527-41cd-997d-c566f09c76e9", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of ready,listed,archived,sold_out,error,ongoing)", "type": "text/plain" }, "key": "status", "value": "ready" }, { "disabled": false, "description": { "content": "Exact match on any variant SKU.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a3c6986-dc22-47fe-bdbe-0fe5ee36eb27", "name": "The key lacks the required scope, or the plan does not include API access.", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of ready,listed,archived,sold_out,error,ongoing)", "type": "text/plain" }, "key": "status", "value": "ready" }, { "disabled": false, "description": { "content": "Exact match on any variant SKU.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20a50edb-384e-42db-ac36-21fd3aa055a8", "name": "Create a product", "request": { "name": "Create a product", "description": { "content": "Creates the product locally and returns it immediately. Products may be created **without images** — they stay local (draft) until you create listings for them. Publishing is a separate call (`POST /listings`).\n", "type": "text/plain" }, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"486689078.21\",\n \"msrp\": \"52.51\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"5054.07\",\n \"msrp\": \"630892.64\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"price\": \"5.54\",\n \"msrp\": \"6343.74\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e3cff3fb-2cfb-45c1-86a1-aa7000923859", "name": "Product created (local write is synchronous).", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"486689078.21\",\n \"msrp\": \"52.51\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"5054.07\",\n \"msrp\": \"630892.64\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"price\": \"5.54\",\n \"msrp\": \"6343.74\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": null\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"listed\",\n \"sync_status\": \"pending\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"850427978.95\",\n \"msrp\": \"5877498551.06\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0685998.66\",\n \"msrp\": \"733167388.02\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"error\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4c722a-6bf3-45ff-b747-37e91846d502", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"486689078.21\",\n \"msrp\": \"52.51\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"5054.07\",\n \"msrp\": \"630892.64\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"price\": \"5.54\",\n \"msrp\": \"6343.74\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b902ffd-7a0e-42cf-8ce9-e551bf091f2f", "name": "Rate limit or daily write quota exceeded. Honor `Retry-After`.", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"486689078.21\",\n \"msrp\": \"52.51\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"5054.07\",\n \"msrp\": \"630892.64\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"price\": \"5.54\",\n \"msrp\": \"6343.74\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds until capacity is available.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2259952-2a14-4907-8cf2-cd2647268f19", "name": "Batch upsert products by SKU", "request": { "name": "Batch upsert products by SKU", "description": { "content": "Create or update up to 100 products in one call, matched by variant SKU. Items are validated upfront; per-item outcomes appear in the operation's `results[]` and the overall status may be `partial`.\n", "type": "text/plain" }, "url": { "path": [ "products", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"365005947.02\",\n \"msrp\": \"1766714.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"20803.44\",\n \"msrp\": \"5171943971.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"29389.69\",\n \"msrp\": \"914.36\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "10796cfc-b313-4f04-9e9f-6b2df4ca8a27", "name": "Batch accepted.", "originalRequest": { "url": { "path": [ "products", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"365005947.02\",\n \"msrp\": \"1766714.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"20803.44\",\n \"msrp\": \"5171943971.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"29389.69\",\n \"msrp\": \"914.36\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830dfbf6-96d6-4c67-b307-eebe9289068f", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "products", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"variants\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"365005947.02\",\n \"msrp\": \"1766714.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"20803.44\",\n \"msrp\": \"5171943971.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"29389.69\",\n \"msrp\": \"914.36\",\n \"quantity\": \"\",\n \"sku\": \"\",\n \"grams\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0663bd42-17e3-4694-bcb7-ae45dd51987c", "name": "Retrieve a product", "request": { "name": "Retrieve a product", "description": {}, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "69bf7797-0248-4572-9072-8b4e723d681f", "name": "The product, with images, variants and a read-only summary of its listings.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"lb\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": null\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"listed\",\n \"sync_status\": \"pending\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"850427978.95\",\n \"msrp\": \"5877498551.06\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0685998.66\",\n \"msrp\": \"733167388.02\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"error\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9d91ce6-2c32-4f6b-9ac9-f794d7b91e0c", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd044956-f89c-44eb-a8ef-e00dfc00299a", "name": "Update a product", "request": { "name": "Update a product", "description": { "content": "Applies the local update synchronously and returns the full updated product with a `sync` block describing channel propagation.\n**Images** are updated through this endpoint: send the desired `images[]` array — elements with a known `id` are kept untouched (never re-uploaded, channel-side image ids preserved), elements without an `id` are added (hosted on Nembol's storage, whether you pass a URL or base64), and ids you omit are removed (and deleted from storage). Array order is display order. Omit the field entirely to leave images unchanged. There is no daily upload cap; each product holds up to 20 images.\nConcurrency is last-write-wins; pass `expected_updated_at` to fail with `412` if the product changed since you read it.\n", "type": "text/plain" }, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"g\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"expected_updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d4d2fbed-362a-48fe-a092-d6a2af265aee", "name": "Updated product + channel sync state.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"g\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"expected_updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"kg\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": null\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\n \"sync_status\": \"ok\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"7.09\",\n \"msrp\": \"44.73\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"62718346.93\",\n \"msrp\": \"3.39\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"delisted\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"listed\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"ok\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b55619-3d72-4021-917b-a2387d120741", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"g\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"expected_updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90a6e15-825c-40df-bcd9-c2f83ebade5f", "name": "`expected_updated_at` precondition failed — re-read and retry.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"g\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"expected_updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0111673a-909b-4e02-9cf1-b725bd6c7ae7", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"g\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": \"yd\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"base64\": \"\",\n \"alt\": \"\"\n }\n ],\n \"expected_updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39fde9b2-d1eb-4088-b902-6e0f6d386478", "name": "Delete a product", "request": { "name": "Delete a product", "description": { "content": "Archives the product (soft delete) and removes its hosted images. A product with LIVE listings cannot be deleted — delist each listing first (`DELETE /listings/{id}`), otherwise this returns `422` `product_still_listed`. This mirrors the platform invariant: Nembol never forgets a product that is still live on a channel.\n", "type": "text/plain" }, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d071461b-ed52-46ac-8f97-35af87dd4cd2", "name": "Deletion accepted; channel delisting in progress.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a568a1-e5b5-413c-b0c1-94880423aabd", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Files", "description": "", "item": [ { "id": "d18501da-7592-4b3d-a46c-1af6a4228a01", "name": "Upload a file", "request": { "name": "Upload a file", "description": { "content": "Upload an image binary when it isn't publicly hosted anywhere. The returned `url` can be used in product `images[]`. Max 10 MB; JPEG/PNG/WebP.\n", "type": "text/plain" }, "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d9785c17-63e3-4c12-b696-cc57c009f810", "name": "File stored.", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47bb6fac-7aa9-4e4a-91fb-78e06f85319a", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Listings", "description": "A listing is one product on one channel account. Publish by creating a listing; delist by deleting it (the record is kept with status `delisted` — publish again by re-creating). Listings carry per-channel overrides, per-variant channel ids, and `issues[]` explaining failures.\n", "item": [ { "id": "60fcbae6-bec3-4b68-a7a2-e92ca5dc96a1", "name": "List listings", "request": { "name": "List listings", "description": { "content": "The query surface for everything channel-side. `?status=error` returns every failing listing; add `error_code` to target one specific failure (the exact filter your retry runs should use).\n", "type": "text/plain" }, "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "product_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "Base channel filter (e.g. `ebay` matches every eBay account).", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of listed,imported,ongoing,error,delisted)", "type": "text/plain" }, "key": "status", "value": "error" }, { "disabled": false, "description": { "content": "Only listings whose `issues[]` contain this code.", "type": "text/plain" }, "key": "error_code", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ec566195-d66c-4b1c-82de-8d5ce042e309", "name": "Paginated listings.", "originalRequest": { "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "product_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "Base channel filter (e.g. `ebay` matches every eBay account).", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of listed,imported,ongoing,error,delisted)", "type": "text/plain" }, "key": "status", "value": "error" }, { "disabled": false, "description": { "content": "Only listings whose `issues[]` contain this code.", "type": "text/plain" }, "key": "error_code", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"delisted\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"listed\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": 9389\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"warning\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210b14ab-dcde-4e6d-90eb-8912f5177425", "name": "The key lacks the required scope, or the plan does not include API access.", "originalRequest": { "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "product_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "Base channel filter (e.g. `ebay` matches every eBay account).", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of listed,imported,ongoing,error,delisted)", "type": "text/plain" }, "key": "status", "value": "error" }, { "disabled": false, "description": { "content": "Only listings whose `issues[]` contain this code.", "type": "text/plain" }, "key": "error_code", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "486c1f0d-c5a4-4ecb-9414-57e5415f32f8", "name": "Publish a product to a channel account", "request": { "name": "Publish a product to a channel account", "description": { "content": "Creates the listing and enqueues publication. Idempotent on `(product_id, channel_account_id)`: posting the same pair returns the existing listing instead of creating a duplicate. Fails upfront with `photo_required_for_channel` if the product has no images and the channel requires them.\n", "type": "text/plain" }, "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8200\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6649d8c5-9a51-46cd-8508-fc1150c53009", "name": "Listing created, publication in progress (`status: ongoing`).", "originalRequest": { "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8200\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\"\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3019825a-3eab-43f1-a82e-bdd824a3f63c", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8200\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f696a9a1-3bcb-4266-9e5b-e77494c884a9", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8200\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e68fa44a-3335-4bf0-9e1f-3712739ba049", "name": "Publish up to 100 listings in one call", "request": { "name": "Publish up to 100 listings in one call", "description": {}, "url": { "path": [ "listings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6f685d4e-6eaf-4fc6-874b-03e35605fd0d", "name": "Batch accepted; per-item outcomes in the operation.", "originalRequest": { "url": { "path": [ "listings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "089882d3-789c-4e6c-90af-546dd261a91f", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "listings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ae15387-346f-47e5-be67-cd54b463381a", "name": "Retrieve a listing", "request": { "name": "Retrieve a listing", "description": {}, "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e00651a7-8ed5-4506-b565-d10cf14af795", "name": "The listing.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\"\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a0cefe-0a62-4381-bee3-ed118a17a44a", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5d0b174-f390-4cbc-8150-548fd52d7eb5", "name": "Update listing overrides / resync", "request": { "name": "Update listing overrides / resync", "description": { "content": "Change per-channel overrides or attributes; the listing is re-synced to the channel. Sending an empty body triggers a plain resync.\n", "type": "text/plain" }, "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 2747,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8c1af93-912c-4d76-9ff0-ac59eb34efcb", "name": "Update accepted, propagation in progress.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 2747,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\"\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "958084d6-601b-4823-9512-5ef7a8764544", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 2747,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "840f83a4-ccb0-407d-b887-55330fa0dc7b", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 2747,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8661d21-9f00-4d37-8cee-40d2659c43ef", "name": "Delist from the channel", "request": { "name": "Delist from the channel", "description": { "content": "Removes the listing from the channel. The record is **kept** with `status: delisted` (history preserved); publish again with `POST /listings`.\n", "type": "text/plain" }, "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "327b28ea-37b7-49f2-92e2-264bca2636de", "name": "Delist accepted.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"id_on_channel\": \"\",\n \"url_on_channel\": \"\",\n \"site\": \"\",\n \"overrides\": {\n \"title\": \"\",\n \"description\": \"\",\n \"category_id\": \"\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\"\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "759dcafb-f7f0-4b62-a026-363ecd26e10f", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "listings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Inventory", "description": "", "item": [ { "id": "474fc7d2-c46c-44f4-a46a-fb776a8272e8", "name": "Update one variant (stock, price, msrp, weight, images)", "request": { "name": "Update one variant (stock, price, msrp, weight, images)", "description": { "content": "Updates a single variant and re-syncs it to the channels where the product is listed. `images` assigns variant-specific photos by referencing images already on the product (`image_id` from the product's `images[]`) — upload new photos on the product first, then assign them here.\n", "type": "text/plain" }, "url": { "path": [ "products", ":id", "variants", ":variant_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "variant_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"price\": \"3998908.36\",\n \"msrp\": \"2080.79\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "367ac520-08b3-4af7-bed7-3c6fda6bccfd", "name": "Updated product + channel sync state.", "originalRequest": { "url": { "path": [ "products", ":id", "variants", ":variant_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "variant_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"price\": \"3998908.36\",\n \"msrp\": \"2080.79\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"category\": \"\",\n \"short_description\": \"\",\n \"vat_rate\": \"\",\n \"mpn\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"kg\"\n },\n \"dimensions\": {\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit\": null\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\n \"sync_status\": \"ok\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"7.09\",\n \"msrp\": \"44.73\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"62718346.93\",\n \"msrp\": \"3.39\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"delisted\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"listed\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"ok\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa35020e-ffcf-45e5-9a70-0eba1f348eb6", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "products", ":id", "variants", ":variant_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "variant_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"price\": \"3998908.36\",\n \"msrp\": \"2080.79\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c4c4b9-adc1-4576-823a-ed4bcdfa7380", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "products", ":id", "variants", ":variant_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "variant_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"price\": \"3998908.36\",\n \"msrp\": \"2080.79\",\n \"grams\": \"\",\n \"asin\": \"\",\n \"images\": [\n {\n \"image_id\": \"\",\n \"position\": \"\"\n },\n {\n \"image_id\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "734cfdab-9668-4f76-8dfb-50f569e44fce", "name": "Batch update stock and prices by SKU", "request": { "name": "Batch update stock and prices by SKU", "description": { "content": "Update quantity and/or price for up to 100 SKUs in one call. Unknown or ambiguous (duplicated) SKUs are rejected per-item in `rejected_items` without failing the batch; accepted items are tracked by the returned operation, whose overall status may be `partial`.\n", "type": "text/plain" }, "url": { "path": [ "inventory", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"price\": \"60543351860.26\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d42c4b6a-c5f3-46bc-8b24-c74e94df9d49", "name": "Batch accepted.", "originalRequest": { "url": { "path": [ "inventory", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"price\": \"60543351860.26\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"simulated\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"simulated\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"rejected_items\": [\n {\n \"sku\": \"\",\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce1730dc-13b1-43a9-a100-0655ff81e9ec", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "inventory", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"price\": \"60543351860.26\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc0616c1-6339-4cd8-9edd-1bc32e99af25", "name": "Rate limit or daily write quota exceeded. Honor `Retry-After`.", "originalRequest": { "url": { "path": [ "inventory", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"price\": \"60543351860.26\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds until capacity is available.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Orders", "description": "", "item": [ { "id": "0298a5af-4ce4-458c-8f6b-fe475787c6f6", "name": "List orders", "request": { "name": "List orders", "description": { "content": "Orders ingested from all channels, one shape. Requires the `orders:read` scope (buyer personal data included — you are responsible for lawful processing).\n", "type": "text/plain" }, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of awaiting_payment,awaiting_shipment,shipped,canceled,refunded,partially_refunded)", "type": "text/plain" }, "key": "status", "value": "awaiting_shipment" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "58526d09-2900-4d9b-b45b-205d3467a2be", "name": "Paginated orders.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of awaiting_payment,awaiting_shipment,shipped,canceled,refunded,partially_refunded)", "type": "text/plain" }, "key": "status", "value": "awaiting_shipment" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"refunded\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"8988.24\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"97.84\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"379868245.82\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"awaiting_payment\",\n \"fulfillment_status\": \"unfulfilled\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"0189684854.07\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"6702486589.00\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"080453731.00\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cd8a9af-ab78-4055-bd8c-d60b93e5f9b7", "name": "The key lacks the required scope, or the plan does not include API access.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of awaiting_payment,awaiting_shipment,shipped,canceled,refunded,partially_refunded)", "type": "text/plain" }, "key": "status", "value": "awaiting_shipment" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f49b8442-0bf2-4bbf-a86d-9d4af2039e8f", "name": "Retrieve an order", "request": { "name": "Retrieve an order", "description": {}, "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0d601eeb-68c0-4754-9962-142988d2f907", "name": "The order.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"refunded\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"56882013.20\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"53017779791.03\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"62.56\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dd94e3a-1f14-4457-bd45-13d6728421d9", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3857959-50f1-4e3c-87b1-d800ff1af757", "name": "Mark shipped / attach tracking", "request": { "name": "Mark shipped / attach tracking", "description": { "content": "Marks the order as shipped and/or attaches tracking. Applies to the WHOLE channel order this line belongs to. With tracking present, Nembol also notifies the source marketplace (default; disable with `notify_channel: false`) — supported on eBay, Etsy, Shopify, WooCommerce, Amazon, TikTok Shop, OnBuy, Square and Squarespace. Marketplace notification is once-per-order (hard idempotent). Requires the `orders:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "orders", ":id", "fulfillment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mark_shipped\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"notify_channel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "17fb6053-010c-4291-b1e6-8002b8776baf", "name": "The updated order, plus `channel_notification` (`{attempted, delivered, error}`).", "originalRequest": { "url": { "path": [ "orders", ":id", "fulfillment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mark_shipped\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"notify_channel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"refunded\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"56882013.20\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"53017779791.03\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"62.56\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f42135-a04e-4562-9806-e901988efafc", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "orders", ":id", "fulfillment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mark_shipped\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"notify_channel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6183713c-8788-421a-9f54-54ca302d573f", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "orders", ":id", "fulfillment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mark_shipped\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"notify_channel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Operations", "description": "", "item": [ { "id": "653484e6-d700-419c-95dd-7c67eea50608", "name": "List operations", "request": { "name": "List operations", "description": {}, "url": { "path": [ "operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,processing,succeeded,partial,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "80f41285-5e0f-4aa1-903b-43b7204dd13a", "name": "Paginated operations.", "originalRequest": { "url": { "path": [ "operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,processing,succeeded,partial,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"pending\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": null\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"simulated\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"channel_rate_limited\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09d6c0e3-c4d7-4c77-b903-b6ad71ec5aea", "name": "Retrieve an operation", "request": { "name": "Retrieve an operation", "description": { "content": "Prefer subscribing to the `operation.completed` webhook over polling.\n", "type": "text/plain" }, "url": { "path": [ "operations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d72fe690-7434-4015-8a03-ba2d8d4c312e", "name": "The operation with per-item, per-channel results.", "originalRequest": { "url": { "path": [ "operations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e2b3c8c-ee49-4c6f-9bce-98d981f46fbc", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "operations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "", "item": [ { "id": "d9519088-f961-424c-9ba8-12a57574e8cc", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": {}, "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d78e2d10-bd6a-4bd0-ae76-edf8ba879e04", "name": "Webhook endpoints.", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"product.updated\",\n \"order.status_changed\"\n ],\n \"status\": \"disabled\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"inventory.updated\",\n \"listing.status_changed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89ae52d9-57dd-4e01-80b1-ca1a58ec0edc", "name": "Create a webhook endpoint", "request": { "name": "Create a webhook endpoint", "description": { "content": "The signing `secret` is returned **only in this response** — store it. Deliveries are signed with `X-Nembol-Signature: t=,v1=` over `.`. Delivery is at-least-once and unordered: deduplicate by `event.id` and tolerate unknown event types.\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"order.created\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2d136297-1dee-4af2-90be-5510d523a816", "name": "Endpoint created (includes the secret, shown once).", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"order.created\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"operation.completed\",\n \"operation.completed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b77c7ec2-991a-461d-8a69-965fb307cd77", "name": "Invalid request; see `error.param`.", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"order.created\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce41ff4d-c370-4d24-acf1-6fb0a5b1fb1b", "name": "Update a webhook endpoint", "request": { "name": "Update a webhook endpoint", "description": {}, "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"product.deleted\",\n \"listing.status_changed\"\n ],\n \"status\": \"enabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bfd74def-5f5e-4fb6-ba2d-ea16a932f2ff", "name": "Updated endpoint.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"product.deleted\",\n \"listing.status_changed\"\n ],\n \"status\": \"enabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"product.deleted\",\n \"operation.completed\"\n ],\n \"status\": \"enabled\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2780fc09-5186-4223-b297-9cf1a45545ff", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"product.deleted\",\n \"listing.status_changed\"\n ],\n \"status\": \"enabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7698ba07-309e-410c-85a4-b3b7491efc7c", "name": "Delete a webhook endpoint", "request": { "name": "Delete a webhook endpoint", "description": {}, "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "bbdde6eb-3386-4241-ae33-07100e223533", "name": "Deleted.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "558c13e3-42d4-4542-804c-f9ad2da25164", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63ee779d-fab0-456e-9936-d179063f4c00", "name": "Rotate the signing secret", "request": { "name": "Rotate the signing secret", "description": { "content": "Returns a new secret; the previous one keeps validating for 24 hours (deliveries carry both as multiple `v1=` entries during the window).\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "rotate_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "56f78ab6-e319-4054-81e1-ffa2912b10d8", "name": "New secret (shown once).", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "rotate_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"operation.completed\",\n \"operation.completed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f25e4f4e-b615-4caf-bc1c-fd35e2bba40d", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "rotate_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "468282a2-2a52-4194-9926-1a2e2732a0f2", "name": "Send a test event", "request": { "name": "Send a test event", "description": {}, "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"inventory.updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "77f4a57f-3170-4be9-8fdd-a7e7bdf9b8ec", "name": "Test delivery attempted.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"inventory.updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"delivered\": \"\",\n \"response_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4c0331f-d49f-46d1-9080-59cb7c7415e5", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"inventory.updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Events", "description": "", "item": [ { "id": "f7836ed4-d664-4684-b808-56a5c8f79a95", "name": "List events", "request": { "name": "List events", "description": { "content": "The durable event log (retained 30 days). Reconcile webhook deliveries, backfill after downtime, or skip webhooks entirely and poll this.\n", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of order.created,order.status_changed,product.updated,product.deleted,inventory.updated,listing.status_changed,operation.completed)", "type": "text/plain" }, "key": "type", "value": "order.created" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8f93ddc7-246b-4fd2-826f-bcbfd1063595", "name": "Paginated events.", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of order.created,order.status_changed,product.updated,product.deleted,inventory.updated,listing.status_changed,operation.completed)", "type": "text/plain" }, "key": "type", "value": "order.created" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"store_id\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"object\": {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"partially_refunded\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"7921496565.86\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"6415.88\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"127886236.75\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"store_id\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"object\": {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"shipped\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"92830722001.67\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"39873856.86\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"509327504.33\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a02404fe-4e47-49fb-8fbb-9b3881a35baa", "name": "Retrieve an event", "request": { "name": "Retrieve an event", "description": {}, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "070a9d7d-8c70-444d-a580-7c3cd354d273", "name": "The event.", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"store_id\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"object\": {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"awaiting_payment\",\n \"fulfillment_status\": \"delivered\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"38957174722.18\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"596146350.88\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"0535871.61\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"province\": \"\",\n \"country\": \"\"\n }\n },\n \"created_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cccc8b2c-f148-4bd4-af5f-e9105ec3ada2", "name": "No such resource in this store.", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.nembol.com/rest/v1" } ], "info": { "_postman_id": "d223a4ba-e45b-474e-839d-d6c7d744f294", "name": "Nembol API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Nembol API lets you manage products and images, publish listings to\nevery connected sales channel, sync stock and prices, read orders, and\nsubscribe to signed webhooks.\n\n## Base URL\n`https://api.nembol.com/rest/v1`\n\n## Authentication\nBearer API keys (`nbl_live_...` / `nbl_test_...`), created in the Nembol\ndashboard under Settings → Developers. Keys are store-scoped and carry\nscopes. Never use keys in browser code.\n\n## Object model\nFive nouns and one rule. **Product** — your canonical catalog item, with\nembedded `images[]` and `variants[]`. **Channel account** — one connected\nchannel account (two eBay accounts are two channel accounts); referenced\neverywhere by its opaque stable id. **Listing** — the projection of one\nproduct on one channel account, with per-channel overrides and issues.\n**Operation** — the tracker for asynchronous channel work. **Event** —\nthe durable log entry behind webhooks. The rule: local writes are applied\nimmediately; channel propagation is asynchronous and tracked by an\noperation.\n\n## Conventions\n- IDs are type-prefixed and opaque: `prod_`, `var_`, `img_`, `list_`,\n `chac_`, `ord_`, `op_`, `evt_`, `whe_`, `file_`. Every resource carries\n an `object` field naming its type.\n- JSON only, `snake_case`, timestamps ISO-8601 UTC.\n- Money amounts are decimal **strings** with 2 decimals (e.g. `\"19.90\"`).\n Product prices are in the store base currency (`GET /store` →\n `currency`); order amounts carry their own `currency`.\n- Cursor pagination: `?limit=` (max 100) and `?cursor=`; responses carry\n `has_more` and `next_cursor`. Ordering is stable (`updated_at` desc,\n `id` tiebreak).\n- `Idempotency-Key` accepted on every mutating request: replaying the\n same key with the same payload returns the stored original response;\n the same key with a different payload fails with `409`\n (`idempotency_key_reused`). Keys live 24h.\n- Enum extensibility: new enum values, event types and response fields\n are **non-breaking**. Clients must tolerate unknowns.\n- Error messages are English; the machine contract is `error.code`.\n\n## Rate limiting\nLeaky-bucket per API key. Every response carries `X-RateLimit-Limit`,\n`X-RateLimit-Remaining` and `X-RateLimit-Reset` (Unix epoch seconds).\n`429` responses include an exact `Retry-After`. A separate daily write\nquota applies to channel-mutating requests.\n\n\nContact Support:\n Name: Nembol API support\n Email: developer@nembol.com", "type": "text/plain" } } }