{ "item": [ { "name": "Store", "description": "", "item": [ { "id": "02c06113-db17-40ef-9bff-5b0d15f2f241", "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": "8e682032-0514-4251-ae63-9168e0dc4446", "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": "69ce825e-52b3-4791-a0f7-3a35baf403a9", "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\": \"invalid_request_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": "60282f07-e42c-4c7d-9561-a0d2f880771a", "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": "a659264d-ec59-4309-bcef-3076f8dbc8b8", "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\": \"disconnected\",\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "576870d0-3939-4979-9aae-5d5eea3f9c34", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c719b24e-8afd-4a14-acd1-01b37109e43a", "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": "f5c71c5f-baee-4fb3-bb78-6d6ac9e65427", "name": "The channel account.", "originalRequest": { "url": { "path": [ "channel_accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Channel account id from `GET /channel_accounts` (e.g. `chac_...`). Never construct it.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"channel\": \"\",\n \"label\": \"\",\n \"shop_name\": \"\",\n \"status\": \"disconnected\",\n \"discovery\": {\n \"categories\": \"\",\n \"attribute_schema\": \"\",\n \"policies\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "187a64a7-6da8-4ce8-b7f2-c58970d2b76f", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bd3b51a-dafb-4d78-9b7e-13eb7703cf50", "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": "c36d88ee-edd5-458e-a70c-f1c19611392a", "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": "6d9ba505-5f47-402a-963c-12eb2480afb2", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d37a2238-5c49-437d-a37a-a16ee575c19d", "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": "e84bd356-6e5c-4b15-8890-a6ca43abd559", "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\": 6307,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd6fbb9-ad24-49e2-ae54-83bd449a4288", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dff703d-baef-4dce-bf5a-174ebd1e280f", "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": "5e5bdc46-1e3b-4397-b928-5c662bd0947c", "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": "fadb5405-5b36-4c1b-82a0-01e91fa1786b", "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\": \"invalid_request_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": "9d0ca2de-8d95-4daa-989f-165e3ce1ecb6", "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": "67d0df7a-aa57-4449-9ac1-c6d54de9268b", "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\": \"ready\",\n \"sync_status\": \"ok\",\n \"images\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"alt\": \"\",\n \"position\": \"\"\n }\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"426.25\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"77965856917.63\",\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\": \"imported\",\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 },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"status\": \"error\",\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\": \"0.98\",\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\": \"2021055759.26\",\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\": \"error\",\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 }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41a0be4e-3666-4189-a65a-35eda2919a30", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a1b69a4-4e20-4c10-ac26-7eeae66cf583", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "871a1b74-1785-40ce-906b-98f23b0d202f", "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\": \"51.99\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0291.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"price\": \"941913.09\",\n \"quantity\": \"\",\n \"sku\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d4e64d8c-9378-4dd1-9a74-5937c397c04a", "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\": \"51.99\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0291.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"price\": \"941913.09\",\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\": \"archived\",\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\": \"3771504.07\",\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\": \"915.71\",\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\": \"error\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c60f517e-5808-49a2-aef0-06b0faaf2e97", "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\": \"51.99\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0291.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"price\": \"941913.09\",\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "669eea03-8789-4433-b692-71e6e0ac59a5", "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\": \"51.99\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"0291.00\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ],\n \"price\": \"941913.09\",\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ec7a347-61a7-4c9e-975f-5cd7f52f2270", "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\": \"18040125863.59\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"93268.28\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n }\n ],\n \"price\": \"311.76\",\n \"quantity\": \"\",\n \"sku\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "35859337-6556-46c8-bd0e-754da87e7fa5", "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\": \"18040125863.59\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"93268.28\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n }\n ],\n \"price\": \"311.76\",\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\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830c7adf-4828-49d8-8802-ed1efc88281d", "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\": \"18040125863.59\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"price\": \"93268.28\",\n \"quantity\": \"\",\n \"barcode\": \"\",\n \"options\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n }\n ],\n \"price\": \"311.76\",\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ca74407-e003-437b-acec-ca758e84bd44", "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": "8aa2d300-0481-410f-9720-100a0959fd29", "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\": \"archived\",\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\": \"3771504.07\",\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\": \"915.71\",\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\": \"error\",\n \"url_on_channel\": \"\"\n },\n {\n \"id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"ongoing\",\n \"url_on_channel\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acdd767-6c5c-4073-8899-95e51206c69e", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8990d5e-0bb1-47ae-b1a9-f00828cb4acc", "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": "e3386532-f3d2-406e-b18a-2f4cf86d544d", "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\": \"archived\",\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\": \"967.63\",\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\": \"2740893745.75\",\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 \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"pending\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"ok\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ceeefe8-560a-43f1-a521-210012a44736", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54b1e376-9e5b-4eae-aa21-472252a476b5", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3722b8fa-6cf8-4a8b-90b6-fe12597280c4", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8977febc-e537-42fa-9984-e95536dc7d6f", "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": "23a5c83f-5b34-4e77-9e4b-d1be889b8511", "name": "Deletion accepted; channel delisting in progress.", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique client-generated key (max 255 chars), stored 24h.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3847497c-1ae6-4199-8829-a399a7077ab9", "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\": \"invalid_request_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": "547a959c-a80a-42b9-9a35-c229459bae6d", "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": "20e8bbe9-e127-4530-b3c0-a70116a1455f", "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": "f78b46fc-d513-4491-a251-9bdbdbe9ae41", "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\": \"invalid_request_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": "900eb698-1072-4c10-8cea-b13f97971514", "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": "ongoing" }, { "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": "2b934fb4-7e77-4ee6-8bf7-ad4e2482bc78", "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": "ongoing" }, { "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\": \"imported\",\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\": 1943\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"warning\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"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\": 2457,\n \"key_1\": 8833\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"warning\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f23569ac-6885-416b-8a4e-f7a0fe3f4934", "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": "ongoing" }, { "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0001aab2-0ce7-414a-b648-a22900e5c307", "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\": 1145.7138837185987,\n \"key_1\": \"string\",\n \"key_2\": 2732.8449672852316,\n \"key_3\": 1875\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8fa3be2e-c8cd-4e4b-9895-d9e3147bc68e", "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\": 1145.7138837185987,\n \"key_1\": \"string\",\n \"key_2\": 2732.8449672852316,\n \"key_3\": 1875\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\": 9440.133801034384,\n \"key_1\": 2303,\n \"key_2\": 3633\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "524bab2c-7aa5-4794-80d7-892aad523a0f", "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\": 1145.7138837185987,\n \"key_1\": \"string\",\n \"key_2\": 2732.8449672852316,\n \"key_3\": 1875\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8390f26-355e-4145-951d-246a0eaa19d5", "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\": 1145.7138837185987,\n \"key_1\": \"string\",\n \"key_2\": 2732.8449672852316,\n \"key_3\": 1875\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e16ddaff-c91f-4677-b11b-327dce5cd591", "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\": true,\n \"key_1\": 380.3033962527147\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9509e3df-7ffc-47dd-a360-4741432c6026", "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\": true,\n \"key_1\": 380.3033962527147\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "459e6bd4-c879-4145-9de6-d1755b1cc316", "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\": true,\n \"key_1\": 380.3033962527147\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5855597-f9e4-4846-9103-a8266fcb5219", "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": "e17b62b8-ad81-4ce0-9784-2e632a778c70", "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\": 9440.133801034384,\n \"key_1\": 2303,\n \"key_2\": 3633\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f572f2a0-cb8b-42d6-bbe0-930cb43c5eba", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e7ce30f-f894-430e-a56c-67164396b46e", "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\": 6989.151336015478,\n \"key_1\": 2907.6726188330595,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c6d08644-f8bf-4248-84f9-0af96775bcb7", "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\": 6989.151336015478,\n \"key_1\": 2907.6726188330595,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"product_id\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"status\": \"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\": 9440.133801034384,\n \"key_1\": 2303,\n \"key_2\": 3633\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea06a942-03fd-4147-9259-f63079e4de9c", "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\": 6989.151336015478,\n \"key_1\": 2907.6726188330595,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3619c331-4c67-4163-93aa-6eaac3f2187f", "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\": 6989.151336015478,\n \"key_1\": 2907.6726188330595,\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd21338a-5163-455c-bfbb-7f668c290816", "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": "c8b50a52-d5f2-43f4-83cd-49b14e94045a", "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\": 9440.133801034384,\n \"key_1\": 2303,\n \"key_2\": 3633\n },\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"sku\": \"\",\n \"id_on_channel\": \"\",\n \"status\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"severity\": \"error\",\n \"message\": \"\",\n \"attribute_names\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fa39616-f5d9-4e56-bd36-fa969f91d111", "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\": \"invalid_request_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": "abeff2b0-cc19-4094-affb-efeab5346510", "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\": \"91.65\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9f4f71e6-1643-41df-b74c-1c3aa399c0c5", "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\": \"91.65\"\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\": \"archived\",\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\": \"967.63\",\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\": \"2740893745.75\",\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 \"sync\": {\n \"operation_id\": \"\",\n \"channels\": [\n {\n \"channel_account_id\": \"\",\n \"status\": \"pending\"\n },\n {\n \"channel_account_id\": \"\",\n \"status\": \"ok\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f683cbd-f868-4fbd-a80f-2a44a5764f9a", "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\": \"91.65\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9970e7-e4dd-49cd-b03f-5739c8048d66", "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\": \"91.65\"\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e775ec1-2979-4a04-934c-c81df37a55b5", "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\": \"70183.99\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7af5f331-75f3-474b-8025-086dab4d4279", "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\": \"70183.99\"\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\": \"partial\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": null\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"channel_rate_limited\",\n \"error\": null\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"rejected_items\": [\n {\n \"sku\": \"\",\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n },\n {\n \"sku\": \"\",\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eae061a-2c0d-4b31-abaa-bdb60a717c15", "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\": \"70183.99\"\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4276eb88-2e8c-4434-80d7-76ba3ee32468", "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\": \"70183.99\"\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\": \"invalid_request_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": "51f9d736-f175-47ff-a00c-9c498db31a31", "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": "shipped" }, { "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": "307f3fd7-2128-49b2-9237-18f751aeabc3", "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": "shipped" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"has_more\": \"\",\n \"next_cursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"refunded\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"69.85\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"086725.85\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"7692321.83\",\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\": \"awaiting_shipment\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"3.68\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"4199018961.82\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"79.73\",\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": "f81f4fe1-bea9-4a03-87ad-f4515e72349f", "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": "shipped" }, { "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72eb1301-e61c-4080-8c5e-99dcbe11a490", "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": "a22ca133-7a23-4ce8-a9d6-4e32c2dff81d", "name": "The order.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"refunded\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"34.20\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"1339578475.51\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"0.26\",\n \"product_id\": \"\"\n }\n ],\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22288fea-02ed-4633-88df-7054b2af0ff9", "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\": \"invalid_request_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": "6afc7ad7-c2af-4406-9139-dd9c79fedd01", "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": "25aef0bb-596f-4a00-a740-60f1a03e09ba", "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\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"simulated\",\n \"error\": null\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"pending\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n },\n {\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\": \"channel_rate_limited\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"channel_rate_limited\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b2f1736-bc5c-4b07-a9aa-1dca76550ce1", "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": "707a707e-492d-4383-bea1-cd15916c82c4", "name": "The operation with per-item, per-channel results.", "originalRequest": { "url": { "path": [ "operations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"status\": \"succeeded\",\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"results\": [\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n },\n {\n \"channel_account_id\": \"\",\n \"listing_id\": \"\",\n \"sku\": \"\",\n \"status\": \"succeeded\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n }\n ],\n \"created_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b683259-f1b5-47fb-a03f-d427ba4af9b6", "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\": \"invalid_request_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": "e641648a-a34c-46dc-b329-5dad42472c88", "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": "3268a870-d4f3-4704-addd-81f076f99530", "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 \"listing.status_changed\",\n \"order.status_changed\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"order.status_changed\",\n \"inventory.updated\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c26ed97b-2922-48c8-a43c-63820c1e6179", "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 \"listing.status_changed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "50be6cac-21f1-4b1d-a926-44b2f47529dd", "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 \"listing.status_changed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"operation.completed\",\n \"inventory.updated\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a31de1b3-9ed2-413a-924d-1587895935da", "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 \"listing.status_changed\"\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abdfc6a0-b02d-43a0-8ded-d3722505b728", "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 \"operation.completed\"\n ],\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a105e907-b880-40f6-8fb6-57395336bddf", "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 \"operation.completed\"\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.deleted\",\n \"operation.completed\"\n ],\n \"status\": \"disabled\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a38862-18dc-4d2e-b998-3fd1b07d36a8", "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 \"operation.completed\"\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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f94cf05-f1e3-4ae2-8ed1-b5518bb81407", "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": "cd793883-c763-46f3-b28c-57ee350866a6", "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": "daeff459-f92d-406e-b19a-13de6f84dfb6", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b20a13b-a472-413c-9074-0aae9c0f052e", "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": "b938e299-c5e2-4c7a-970d-8fa245265249", "name": "New secret (shown once).", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "rotate_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"events\": [\n \"operation.completed\",\n \"inventory.updated\"\n ],\n \"status\": \"auto_disabled\",\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55e259eb-6f7c-491e-91d9-9fa172c58b24", "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\": \"invalid_request_error\",\n \"code\": \"\",\n \"message\": \"\",\n \"param\": \"\",\n \"doc_url\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3279ea4d-0113-4daa-9b5c-fa04c61dd195", "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\": \"operation.completed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "464f5ddf-4719-45ca-9dc9-62613028779a", "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\": \"operation.completed\"\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": "db3e0a03-1f66-4e7f-a51e-705a9730e0e6", "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\": \"operation.completed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_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": "4c84b844-e31d-4d04-b354-35bcc754d9fd", "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": "product.deleted" }, { "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": "5c9466c5-8993-4fa9-bd8e-652ebc1eac91", "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": "product.deleted" }, { "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\": \"awaiting_shipment\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"46109894377.70\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"0675569.10\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"5121178.90\",\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\": \"shipped\",\n \"fulfillment_status\": \"partial\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"90906878913.12\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"5.43\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"480737.62\",\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": "ab49ae36-4594-4e88-82fc-ba6d97f41bad", "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": "c89e402f-58ea-43fb-9501-a5b269431b8b", "name": "The event.", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"store_id\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"object\": {\n \"id\": \"\",\n \"object\": \"\",\n \"channel_account_id\": \"\",\n \"channel\": \"\",\n \"order_id_on_channel\": \"\",\n \"order_url\": \"\",\n \"status\": \"awaiting_payment\",\n \"fulfillment_status\": \"shipped\",\n \"source_status\": \"\",\n \"tracking\": {\n \"number\": \"\",\n \"carrier\": \"\",\n \"url\": \"\"\n },\n \"currency\": \"\",\n \"total\": \"758826734.93\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"516.91\",\n \"product_id\": \"\"\n },\n {\n \"sku\": \"\",\n \"title\": \"\",\n \"quantity\": \"\",\n \"price\": \"910759438.03\",\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": "1c61da98-b95c-4c54-b32d-d3415c1073f3", "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\": \"invalid_request_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": "5cecf611-a728-4e8b-95f7-9cab7acc7d97", "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" } } }