{ "item": [ { "name": "Store", "description": "", "item": [ { "id": "e0a7e928-1bd2-492d-94b2-a3ad6ee4aced", "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": "514ede30-368a-497b-be19-780def82ec10", "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\": \"ok\",\n \"time\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b6b49d4-0f10-488b-b277-2de9382cc977", "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": "ae483125-1791-4862-b7a6-c1daa188a1ec", "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": "bdedd08a-5d01-40f0-a8c5-904593b9045f", "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\": \"live\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb63280b-1c01-42c6-92e4-92df36a5c50b", "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\": \"rate_limit_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": "4c54470f-bfeb-4d17-9847-35bdf1bbf875", "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": "a9ca9ee2-097f-4a35-acd7-96e72144ae59", "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\": \"error\",\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\": \"error\",\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52520c0e-66c3-449f-a92b-a4af2fec12a3", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27cea0fa-2269-400a-b3c2-2c3bf870e66d", "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": "5d3f9547-6b9b-4f9f-b0f0-7b3e6d94ad7f", "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\": \"error\",\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce61f33-29d9-49b2-b910-97aa45ebb957", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a68903e-ef9e-46ec-b628-30c4a99ec124", "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": "9c6ef4b9-5dae-4ef4-b17c-be82db8bfd3f", "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": "aba1bd23-6681-4d1e-b2bb-7ace361036be", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b16a540e-bb96-486d-af16-5fd99e449f46", "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": "16effd98-871a-42e2-bec4-9978a896feef", "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\": 218.22513097722097,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aec1e505-f1b1-404f-ad72-de67a8e56450", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb0c02df-676b-47a7-bf2e-58a3249a1d65", "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": "2dc20812-2631-445f-bdd2-caf9f153b8ad", "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\": \"shipping\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5809c35-b0c1-43b8-ac8c-71c4eb645bfe", "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\": \"rate_limit_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": "8f208039-bdfa-47b8-8308-6435503c37b5", "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": "error" }, { "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": "bde5e2eb-2167-4377-89ff-1bc56daa6435", "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": "error" }, { "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 \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\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\": \"90.43\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"1.92\",\n \"quantity\": \"\",\n \"barcode\": \"\",\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\": \"listed\",\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 },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\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\": \"18.88\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"98242499.67\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"listings\": [\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"imported\",\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 }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eff030-08d1-4eb3-aa3e-7e67ebf9accf", "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": "error" }, { "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7db0dae9-c316-4edb-8888-f8dc6f5e1096", "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": "error" }, { "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96a663f3-f252-4262-ac7e-2720f59ebdd2", "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\": \"86131253.17\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"119.68\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"013325670.89\",\n \"quantity\": \"\",\n \"sku\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f496cce7-2342-4b8d-bb03-be92a97c4408", "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\": \"86131253.17\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"119.68\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"013325670.89\",\n \"quantity\": \"\",\n \"sku\": \"\"\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 \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\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\": \"5429919258.20\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"71.69\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"delisted\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59e68366-a0e6-4044-998e-4878b8a56688", "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\": \"86131253.17\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"119.68\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"013325670.89\",\n \"quantity\": \"\",\n \"sku\": \"\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bade074-d2a3-48df-a3f9-2ce5685321d0", "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\": \"86131253.17\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"119.68\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"013325670.89\",\n \"quantity\": \"\",\n \"sku\": \"\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c67684d-78cc-4b03-a1a1-23d362112ae3", "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\": \"2.82\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"7355591.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"756.40\",\n \"quantity\": \"\",\n \"sku\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "874a7bc2-95c4-4cc0-9677-07e3a21d536a", "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\": \"2.82\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"7355591.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"756.40\",\n \"quantity\": \"\",\n \"sku\": \"\"\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\": \"processing\",\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\": \"succeeded\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e81473-f744-40ed-837e-b5312cd77f45", "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\": \"2.82\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"7355591.01\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"price\": \"756.40\",\n \"quantity\": \"\",\n \"sku\": \"\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14e6d6e8-8aed-4ebd-bdf8-62e31a34dff4", "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": "42d57431-f106-4041-87b6-5f668b9c802e", "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 \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"ongoing\",\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\": \"5429919258.20\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"71.69\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"delisted\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb232278-8c4d-4899-849e-e76b103f29d1", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89fa518f-3e31-43b3-8c25-db97eb136eff", "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. New uploads count toward a daily quota of 500 images per store (`429` `upload_quota_exceeded`).\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 \"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": "f4867147-408a-414c-a990-0e845155a17a", "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 \"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 \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"listed\",\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\": \"774020.23\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"4831617.94\",\n \"quantity\": \"\",\n \"barcode\": \"\",\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\": \"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 \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c2e966-2d77-4f3b-aa15-7b99c005acfc", "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 \"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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c57fe2-79f7-4039-aae9-0a8dbf5a8c31", "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 \"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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5170251-33d5-4c28-ba00-a947af327375", "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 \"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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8087be3e-0178-489a-9efb-8d3866ef6ecc", "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": "f8951589-cd3c-4be3-9c7b-0ffa30f8e724", "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\": \"processing\",\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\": \"succeeded\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "083b4be7-4632-4568-9c98-7ba6dfe48922", "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\": \"rate_limit_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": "90654d92-fdc8-4e50-bd3c-fcdbb36b76da", "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": "bfffdff7-020d-46c0-83ac-5599ad5b4dd5", "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": "fca27b96-f0af-48d6-849b-a076b643c065", "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\": \"rate_limit_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": "da051807-639b-46a2-b2fe-0f00929074cf", "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": "250455b3-a818-4228-b3f0-487808dd7d7b", "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\": \"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\": \"string\",\n \"key_1\": false,\n \"key_2\": true\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\": \"error\",\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\": 6922.472854195906,\n \"key_1\": 1567,\n \"key_2\": true,\n \"key_3\": 8783,\n \"key_4\": \"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 }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66bd2773-3287-4eef-9480-9f1c2ae42504", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7624779-fa2c-444f-b552-80cc1378aeab", "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\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6c77c861-9156-4e5a-8943-a70b7e040cca", "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\": \"string\",\n \"key_1\": \"string\"\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\": \"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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 6841.709711008073\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8bc2ed9-eedc-4fa3-91ae-43f49e89828d", "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\": \"string\",\n \"key_1\": \"string\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776a8ac2-2313-49c5-b8c6-f82d9e23ddd7", "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\": \"string\",\n \"key_1\": \"string\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7b96c89-2022-464f-a68b-b4d06f58f800", "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\": false,\n \"key_1\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "49ef5807-fde9-4661-998c-6cead48236b5", "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\": false,\n \"key_1\": \"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\": \"processing\",\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\": \"succeeded\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abfea338-f02a-48a1-b22e-97a1a1de9a58", "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\": false,\n \"key_1\": \"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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86498503-7880-49a9-ae6c-bf8e11f7e26a", "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": "fff33c59-ccfb-45fe-a0ae-9fa37095545b", "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\": \"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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 6841.709711008073\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "950a55e2-5f8a-4bb9-bee8-ef94163919e1", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5458a56b-7f6f-454e-a2b2-0c65c78871ad", "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\": \"string\",\n \"key_1\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e31e040-bd67-4537-846f-d12f15f5fb43", "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\": \"string\",\n \"key_1\": 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\": \"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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 6841.709711008073\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cdf2352-1438-4146-86c6-3b6c15588cc7", "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\": \"string\",\n \"key_1\": 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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c83bdc08-013d-4d64-8a6f-7c6cd1706a95", "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\": \"string\",\n \"key_1\": 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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7694e84c-0d0d-4944-bc12-245894df5ed2", "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": "99fd7c1f-1662-4fed-9d33-84775348060f", "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\": \"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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 6841.709711008073\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf9f5569-3e9e-48b0-aa65-3625c836e2ba", "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\": \"rate_limit_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": "5531b326-6a80-4af4-a796-2023ec5175fb", "name": "Update one variant (quantity / price)", "request": { "name": "Update one variant (quantity / price)", "description": {}, "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\": \"5646497800.11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "38b6c94f-97bc-457f-807c-43f1a372807c", "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\": \"5646497800.11\"\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 \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"listed\",\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\": \"774020.23\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"4831617.94\",\n \"quantity\": \"\",\n \"barcode\": \"\",\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\": \"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 \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"simulated\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e5106c-4052-455f-9f01-857ff581e5af", "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\": \"5646497800.11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8ea6368-edae-4bc9-bd5c-00710e91b90b", "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\": \"5646497800.11\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abbfd8bd-a6cd-40c0-a9a4-2f7a27fbd807", "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\": \"68293883087.27\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d7d960bb-e4d3-4fc5-92c1-f2324a45b407", "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\": \"68293883087.27\"\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\": \"processing\",\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\": \"channel_rate_limited\",\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6d110b1-a30c-4d67-9ba4-b11859954dea", "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\": \"68293883087.27\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c61a32-5b7b-4b6d-95ef-87a6b311a00e", "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\": \"68293883087.27\"\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\": \"rate_limit_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": "44aa23b6-6776-42fa-a826-16dcf7cd930c", "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_payment" }, { "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": "6fbd38ac-a416-45dc-b642-e60055974655", "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_payment" }, { "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\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"49253095275.01\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"99.16\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"526400.74\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\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\": \"refunded\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"7.08\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"85246.24\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"32901906738.08\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18127b20-be98-42f3-bd2d-1e0e4cbb095d", "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_payment" }, { "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10ec01cf-dfec-4723-bb2d-1835fdf30cf7", "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": "32e5a4f4-f67d-4ba9-809a-4e0a6b90f6d0", "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\": \"canceled\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"73133186.39\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"464388704.95\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"53169.98\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed97b21e-b91e-4958-9fb3-e0873e42949a", "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\": \"rate_limit_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": "36287197-9170-4931-81a7-5222a8ff4b5e", "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": "pending" }, { "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": "6d3d7bfb-e5d2-44d9-b9a7-468ffec3709c", "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": "pending" }, { "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\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"channel_rate_limited\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"failed\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": null\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": "3681c58c-150a-4ad3-b9da-ec1af657f82b", "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": "291b49ed-7cf9-4a9f-bfe3-98d8d0455a74", "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\": \"processing\",\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\": \"succeeded\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c17714bd-16d1-4f0e-9f17-dc33e23d301f", "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\": \"rate_limit_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": "3935b181-210a-4020-a78f-a60f80822213", "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": "eab3ee2f-674e-46c1-9d88-5242233c359b", "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 \"order.status_changed\",\n \"product.deleted\"\n ],\n \"status\": \"disabled\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"order.status_changed\",\n \"order.created\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c10d9dd4-33c8-440f-98a8-e308873412bb", "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 \"product.deleted\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a72af836-10f0-4b1b-9f89-f533c852b6a1", "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 \"product.deleted\"\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 \"product.updated\",\n \"listing.status_changed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cbb9583-0e15-4aec-9485-fb5e9b750e12", "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 \"product.deleted\"\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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c69c3c4d-f498-4e4f-b380-e1d6c5ddd962", "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 \"product.updated\"\n ],\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a81f50d9-ce86-4cc7-b289-fc0dfce8dd23", "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 \"product.updated\"\n ],\n \"status\": \"disabled\"\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.updated\",\n \"order.status_changed\"\n ],\n \"status\": \"disabled\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac58353-fb97-4526-b599-597901c0a5d5", "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 \"product.updated\"\n ],\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54d7200b-5470-4e74-a113-b782c544c3d2", "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": "f53019fb-444e-45dc-94a4-6a0858f5f238", "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": "f0d83daa-6e7f-4cee-bb71-df5ceb85bd92", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20681ca5-b27f-4e10-ba9d-03ac557d9bba", "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": "225b2480-e4b6-4d42-a922-53e7bff8bbcd", "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 \"product.updated\",\n \"listing.status_changed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05f0222-f4af-4b56-874a-3762bcfd9656", "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\": \"rate_limit_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45fbe228-5dec-4197-8291-ec5239015409", "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": "06893614-5d2a-4472-8517-80b0e29e3325", "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": "aa834bd6-a440-4edd-b406-d5b2a808d4ac", "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\": \"rate_limit_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": "4aa469a1-d0fc-4aa8-bce0-26e442972349", "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": "listing.status_changed" }, { "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": "c991a2dd-ae3e-4845-b626-789f04908b8a", "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": "listing.status_changed" }, { "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\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"9416626.17\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"76238332335.15\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"6746430.36\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\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\": \"partially_refunded\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"00543858802.16\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"37302999966.49\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"89414.58\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "997eacde-4aaf-494f-b3a2-f545c77cae26", "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": "651ddd8e-dd1a-4e65-81c7-1906222b8ef9", "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\": \"refunded\",\n \"fulfillment_status\": \"unfulfilled\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"2.51\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"8995233.15\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"2.11\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be41f4a7-0a19-4612-8bbd-8799777ec1ce", "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\": \"rate_limit_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": "e395ae71-d6b9-4956-b85f-c516afbd5ccc", "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" } } }