{ "openapi": "3.0.0", "info": { "title": "API Server", "description": "This is an awesome app!", "version": "1.0.0" }, "paths": { "/api/amazon/account": { "post": { "tags": [ "Amazon Accounts" ], "operationId": "post_api_amazon_account_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "sellerId", "mwsAuthToken", "region", "sites" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,50}" }, "sellerId": { "type": "string", "default": null, "pattern": "[a-zA-Z0-9\\-_]{1,32}" }, "mwsAuthToken": { "type": "string", "default": null, "pattern": "[a-zA-Z0-9\\-\\._]{1,75}" }, "region": { "type": "string", "default": null, "pattern": "(EU|NA|AU|SG|JP|PL|IN)" }, "sites": { "type": "array", "items": {}, "default": null, "pattern": "(UK|DE|IT|FR|ES|NL|PL|SE|EG|SA|TR|US|CA|MX|AU|SG|JP|AE|BE|BR|IE|IN|ZA)" } }, "type": "object" } } } }, "responses": { "201": { "description": "Returns Amazon account token" } } } }, "/api/amazon/account/status": { "get": { "tags": [ "Amazon Accounts" ], "operationId": "get_api_amazon_account_get_status", "responses": { "200": { "description": "Returns status Amazon account" } } } }, "/api/amazon/account/statistic": { "get": { "tags": [ "Amazon Accounts" ], "operationId": "get_api_amazon_account_get_statistic", "responses": { "default": { "description": "" } } } }, "/api/amazon/schema-validation": { "post": { "tags": [ "Amazon Product Type" ], "operationId": "post_api_amazon_schema_validation", "responses": { "200": { "description": "Returns list of validation error" } } } }, "/api/amazon/{marketplace}/categories/{node}/children": { "get": { "tags": [ "Amazon Category" ], "operationId": "get_api_amazon_categories_children", "parameters": [ { "name": "marketplace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "node", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns children subtree for product Category" } } } }, "/api/amazon/{marketplace}/categories/{node}/departments": { "get": { "tags": [ "Amazon Category" ], "operationId": "get_api_amazon_categories_departments", "parameters": [ { "name": "marketplace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "node", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns posiable departments for Category" } } } }, "/api/amazon/{marketplace}/departments/{department}/productTypes": { "get": { "tags": [ "Amazon Department" ], "operationId": "get_api_amazon_departments_productTypes", "parameters": [ { "name": "marketplace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns possible productTypes for department" } } } }, "/api/amazon/{marketplace}/departments/{department}/productTypes/{productType}/specification": { "get": { "tags": [ "Amazon Department" ], "operationId": "get_api_amazon_departments_specification", "parameters": [ { "name": "marketplace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns possible productTypes for department" } } } }, "/api/amazon/{marketplace}/parent-categories": { "get": { "tags": [ "Amazon Category" ], "operationId": "get_api_amazon_marketplace_parent_categories", "parameters": [ { "name": "marketplace", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\w+" } } ], "responses": { "200": { "description": "Returns tree of product categories" } } } }, "/api/amazon/marketplace": { "get": { "tags": [ "Amazon Marketplace" ], "operationId": "get_api_amazon_marketplace", "responses": { "default": { "description": "" } } } }, "/api/amazon/notifications/subscription": { "post": { "tags": [ "Amazon Notifications" ], "operationId": "post_api_amazon_notifications_subscribe", "responses": { "201": { "description": "Account subscribed to listing notifications" } } }, "delete": { "tags": [ "Amazon Notifications" ], "operationId": "delete_api_amazon_notifications_unsubscribe", "responses": { "200": { "description": "Account unsubscribed from listing notifications" } } } }, "/api/method/amazon.orders.getList": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_orders_index_deprecated", "parameters": [ { "name": "states[]", "in": "query", "description": "States in array format: e.g. states[]=Unshipped or states[]=Unshipped&states[]=Pending", "required": false, "allowEmptyValue": true, "explode": true, "schema": { "type": "array", "items": {}, "default": null, "pattern": "(Unshipped|PartiallyShipped|Canceled|Unfulfillable|Pending|Shipped)" } }, { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } }, { "name": "withoutItems", "in": "query", "description": "Indicates whether should (present in query) response contain order items or not", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "orderIds[]", "in": "query", "description": "OrderIds in array format: e.g. orderIds[]=1111 or orderIds[]=1111&orderIds[]=2222", "required": false, "allowEmptyValue": true, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns Amazon Orders" } } } }, "/api/amazon/orders": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_orders_index", "parameters": [ { "name": "states[]", "in": "query", "description": "States in array format: e.g. states[]=Unshipped or states[]=Unshipped&states[]=Pending", "required": false, "allowEmptyValue": true, "explode": true, "schema": { "type": "array", "items": {}, "default": null, "pattern": "(Unshipped|PartiallyShipped|Canceled|Unfulfillable|Pending|Shipped)" } }, { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } }, { "name": "withoutItems", "in": "query", "description": "Indicates whether should (present in query) response contain order items or not", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "orderIds[]", "in": "query", "description": "OrderIds in array format: e.g. orderIds[]=1111 or orderIds[]=1111&orderIds[]=2222", "required": false, "allowEmptyValue": true, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns Amazon Orders" } } } }, "/api/amazon/orders/{orderId}": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_orders_data", "parameters": [ { "name": "withItems", "in": "query", "description": "Indicates whether should (present in query) response contain order items or not", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Amazon Orders" } } }, "post": { "tags": [ "Amazon Orders" ], "operationId": "post_api_amazon_orders_data", "parameters": [ { "name": "withItems", "in": "query", "description": "Indicates whether should (present in query) response contain order items or not", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Amazon Orders" } } } }, "/api/amazon/orders-by-ids": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_orders_data_by_ids", "parameters": [ { "name": "orderIds[]", "in": "query", "description": "OrderIds in array format: e.g. orderIds[]=1111 or orderIds[]=1111&orderIds[]=2222", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns Amazon Orders" } } } }, "/api/amazon/refunded-orders": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_refunded_orders_index", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2026-05-29T14:30:45+02:00'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } } ], "responses": { "200": { "description": "Returns Amazon Order Ids" } } } }, "/api/amazon/orders-fee-by-ids": { "get": { "tags": [ "Amazon Orders" ], "operationId": "get_api_amazon_orders_fee_data_by_ids", "parameters": [ { "name": "orderIds[]", "in": "query", "description": "OrderIds in array format: e.g. orderIds[]=1111 or orderIds[]=1111&orderIds[]=2222", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns Amazon Orders Fee" } } } }, "/api/amazon/productTypes": { "get": { "tags": [ "Amazon Product Type" ], "operationId": "get_api_amazon_productTypes", "parameters": [ { "name": "marketplaceIds[]", "in": "query", "description": "Marketplace ids in array format: e.g. marketplaceIds[]=ATVPDKIKX0DER", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns possible productTypes for marketplaces" } } } }, "/api/amazon/productTypes/schema/{productType}": { "get": { "tags": [ "Amazon Product Type" ], "operationId": "get_api_amazon_definitions_product_type", "parameters": [ { "name": "marketplaceIds[]", "in": "query", "description": "Marketplace ids in array format: e.g. marketplaceIds[]=ATVPDKIKX0DER", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } }, { "name": "productType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns ProductTypeSchema for marketplaces and productType" } } } }, "/api/amazon/product/{asin}": { "get": { "tags": [ "Amazon Products" ], "operationId": "get_api_amazon_product_info", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "Marketplace id e.g. marketplaceId=ATVPDKIKX0DER", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "includePricing", "in": "query", "description": "Indicates whether pricing data should be returned for items", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "asin", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/amazon/product-issues": { "get": { "tags": [ "Amazon Products" ], "operationId": "get_api_amazon_product_issues", "parameters": [ { "name": "skus[]", "in": "query", "description": "Skus in array format: e.g. skus[]=parent-sku", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } }, { "name": "marketplaceId", "in": "query", "description": "Marketplace id e.g. marketplaceId=ATVPDKIKX0DER", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } } } }, "/api/amazon/oauth/begin": { "post": { "operationId": "post_api_amazon_oauth_begin", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "region", "marketplaces" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,255}" }, "region": { "type": "string", "default": null, "pattern": "(EU|NA|AU|SG|JP|PL|IN)" }, "marketplaces": { "type": "array", "items": {}, "default": null, "pattern": "(UK|DE|IT|FR|ES|NL|PL|SE|EG|SA|TR|US|CA|MX|AU|SG|JP|AE|BE|BR|IE|IN|ZA)" }, "redirectUrl": { "type": "string", "default": null, "pattern": ".{1,255}" }, "accountHash": { "type": "string", "default": null, "pattern": ".{1,255}" }, "type": { "type": "string", "default": null, "pattern": ".{1,255}" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns url for authorizing access to amazon seller api" } } } }, "/api/amazon/pending-account": { "get": { "operationId": "get_api_amazon_pending_account_get", "parameters": [ { "name": "state", "in": "query", "description": "State", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".{1,255}" } } ], "responses": { "default": { "description": "" } } } }, "/api/amazon/pending-account/{id}": { "delete": { "operationId": "delete_api_amazon_pending_account_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/amazon/shipping_templates": { "get": { "tags": [ "Amazon Shipping templates" ], "operationId": "get_api_amazon_shipping_templates", "parameters": [ { "name": "marketplaceIds[]", "in": "query", "description": "Marketplace ids in array format: e.g. marketplaceIds[]=ATVPDKIKX0DER", "required": true, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "200": { "description": "Returns possible shipping templates for marketplaces" } } } }, "/api/amazon/specification/{department}": { "get": { "tags": [ "Amazon Category Specification" ], "operationId": "get_api_amazon_specification_get", "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns possiable attributes(specification) for product by department" } } } }, "/api/amazon/statistic": { "get": { "tags": [ "Amazon Statistic" ], "operationId": "get_api_amazon_statistic", "responses": { "200": { "description": "Returns Amazon Statistic" } } } }, "/api/amazon/statistic/{token}": { "post": { "tags": [ "Amazon Statistic" ], "operationId": "post_api_amazon_statistic_create", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Create new AmazonStatisticStatus in active status" } } } }, "/api/amazon/variations/{departmentName}": { "get": { "tags": [ "Amazon Variations" ], "operationId": "get_api_amazon_variations", "parameters": [ { "name": "departmentName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of variations by department name" } } } }, "/api/jobs": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_core_job_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "action" ], "properties": { "action": { "type": "string", "default": null }, "command": { "type": "string", "default": null }, "data": { "type": "string", "default": null }, "start": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Create new job in reserved status" } } } }, "/api/jobs/{jobId}": { "get": { "tags": [ "API jobs" ], "operationId": "get_api_job_result", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get result for Job" } } } }, "/api/method/api.job.add": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_job_add_deprecated", "requestBody": { "content": { "application/json": { "schema": { "required": [ "jobId", "command" ], "properties": { "jobId": { "type": "string", "default": null }, "command": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Add serviceCall to job" } }, "deprecated": true } }, "/api/method/api.job.start": { "patch": { "tags": [ "API jobs" ], "operationId": "patch_api_job_start_deprecated", "requestBody": { "content": { "application/json": { "schema": { "required": [ "jobId" ], "properties": { "jobId": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Update state for Job to started" } }, "deprecated": true } }, "/api/method/api.job.cancel": { "patch": { "tags": [ "API jobs" ], "operationId": "patch_api_job_cancel_deprecated", "requestBody": { "content": { "application/json": { "schema": { "required": [ "jobId" ], "properties": { "jobId": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Update state for Job to canceled" } }, "deprecated": true } }, "/api/method/api.job.status": { "get": { "tags": [ "API jobs" ], "operationId": "get_api_job_status_deprecated", "parameters": [ { "name": "jobId", "in": "query", "description": "Job id", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get status for Job" } }, "deprecated": true } }, "/api/method/api.job.result": { "get": { "tags": [ "API jobs" ], "operationId": "get_api_job_result_deprecated", "parameters": [ { "name": "jobId", "in": "query", "description": "Job id", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get result for Job" } }, "deprecated": true } }, "/api/method/api.job.create": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_job_create_deprecated", "requestBody": { "content": { "application/json": { "schema": { "required": [ "action" ], "properties": { "action": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Create new job in reserved status" } }, "deprecated": true } }, "/api/method/api.job.insert": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_job_insert_deprecated", "requestBody": { "content": { "application/json": { "schema": { "required": [ "action", "command", "data" ], "properties": { "action": { "type": "string", "default": null }, "command": { "type": "string", "default": null }, "data": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Create new job in reserved status, add service call and start it" } }, "deprecated": true } }, "/api/jobs/{jobId}/service-calls": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_job_service_calls_create", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "command", "uniqueKey" ], "properties": { "command": { "type": "string", "default": null }, "uniqueKey": { "type": "string", "default": null }, "data": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Add serviceCall to job" } } } }, "/api/jobs/{jobId}/status": { "get": { "tags": [ "API jobs" ], "operationId": "get_api_job_status", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get status for Job" } } }, "patch": { "tags": [ "API jobs" ], "operationId": "patch_api_job_patch", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "status" ], "properties": { "status": { "type": "string", "default": null, "pattern": "^(start|cancel)$" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update state for Job to started or canceled state" } } } }, "/api/method/api-keys-check": { "post": { "tags": [ "license" ], "operationId": "post_api_core_api_key_check_deprecated", "parameters": [ { "name": "order", "in": "path", "description": "The field is example", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Example Api response for key check" } } } }, "/api/keys/check": { "post": { "tags": [ "license" ], "operationId": "post_api_core_api_keys_check", "parameters": [ { "name": "order", "in": "path", "description": "The field is example", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Example Api response for key check" } } } }, "/api/ebay/account": { "post": { "tags": [ "Ebay Accounts" ], "operationId": "post_api_ebay_account_create", "responses": { "201": { "description": "Returns Ebay account token and redirectUrl for connect" } } } }, "/api/ebay/account/verify/{token}": { "get": { "tags": [ "Ebay Accounts" ], "operationId": "get_api_ebay_account_verify", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Ebay account status" } } } }, "/api/ebay/account/{token}/user": { "get": { "tags": [ "Ebay Accounts" ], "operationId": "get_api_ebay_account_details", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Ebay account user info" } } } }, "/api/ebay/{marketplaceId}/categories": { "get": { "tags": [ "Ebay Categories" ], "operationId": "get_api_ebay_categories_list_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of categories with structure identical to the old GetCategories trading api call" } } } }, "/api/ebay/{marketplaceId}/{categoryId}/category-details": { "get": { "tags": [ "Ebay Category Details" ], "operationId": "get_api_ebay_category_details_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns ebay category details needed for product creation" } } } }, "/api/ebay/{marketplaceId}/version": { "get": { "tags": [ "Ebay Marketplace" ], "operationId": "get_api_ebay_marketplace_version_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns version of an ebay marketplace" } } } }, "/api/ebay/{marketplaceId}/info": { "get": { "tags": [ "Ebay Marketplace" ], "operationId": "get_api_ebay_marketplace_info_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns MarketplaceInfo with list of categories" } } } }, "/api/ebay/{marketplaceId}/{categoryId}/property": { "get": { "tags": [ "Ebay Category Details" ], "operationId": "get_api_ebay_category_properties_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns ebay category property needed for product creation" } } } }, "/api/ebay/{marketplaceId}/{categoryId}/property-values": { "get": { "tags": [ "Ebay Category Details" ], "operationId": "get_api_ebay_category_property_values_get", "parameters": [ { "name": "properties", "in": "query", "description": "Names of property separated by comma delimiter", "required": false, "schema": { "$ref": "#/components/schemas/string" } }, { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns ebay category property values needed for product creation" } } } }, "/api/ebay/inventory": { "post": { "tags": [ "API jobs" ], "operationId": "post_api_ebay_inventory_update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns possible attributes(specification) for product" } } } }, "/api/ebay/orders": { "get": { "tags": [ "Ebay Orders" ], "operationId": "get_api_ebay_orders_get", "parameters": [ { "name": "updateTime", "in": "query", "description": "Return orders modified after the specified date and time (ISO 8601 format)", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Returns list of orders from eBay Trading API" } } } }, "/api/ebay/{marketplaceId}/{categoryId}/specification": { "get": { "tags": [ "Ebay Category Specification" ], "operationId": "get_api_ebay_specification_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns possible attributes(specification) for product" } } } }, "/api/ebay/{marketplaceId}/{categoryId}/gpsr": { "get": { "tags": [ "Ebay Category GPSR" ], "operationId": "get_api_ebay_gpsr_get", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns possible gpsr for product" } } } }, "/api/ebay/statistic": { "get": { "tags": [ "Ebay Statistic" ], "operationId": "get_api_ebay_statistic", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } } ], "responses": { "200": { "description": "Returns Ebay Statistic" } } } }, "/api/etsy/account": { "post": { "tags": [ "Etsy Accounts" ], "operationId": "post_api_etsy_account_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,50}" } }, "type": "object" } } } }, "responses": { "201": { "description": "Returns Etsy account token and redirectUrl for connect" } } } }, "/api/etsy/account/verify/{token}": { "get": { "tags": [ "Etsy Accounts" ], "operationId": "get_api_etsy_account_verify", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Etsy account status" } } } }, "/api/etsy/account-shop/verify": { "get": { "tags": [ "Etsy Accounts" ], "operationId": "get_api_etsy_account_shop_verify", "responses": { "200": { "description": "Returns Etsy account shop status" } } } }, "/api/etsy/parent-categories": { "get": { "tags": [ "Etsy Category" ], "operationId": "get_api_etsy_category_parent", "responses": { "200": { "description": "Returns tree of product categories" } } } }, "/api/etsy/categories/{node}/children": { "get": { "tags": [ "Etsy Category" ], "operationId": "get_api_etsy_category_children", "parameters": [ { "name": "node", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns children subtree for product Category" } } } }, "/api/etsy/categories/{node}/properties": { "get": { "tags": [ "Etsy Category" ], "operationId": "get_api_etsy_category_properties", "parameters": [ { "name": "node", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns properties for product Category" } } } }, "/api/etsy/return-policies": { "get": { "tags": [ "Etsy return policies" ], "operationId": "get_api_etsy_return_policies", "responses": { "200": { "description": "Returns list of return policies" } } } }, "/api/etsy/shipping-profiles": { "get": { "tags": [ "Etsy Shipping profiles" ], "operationId": "get_api_etsy_shipping_profiles", "responses": { "200": { "description": "Returns list of Shipping profiles" } } } }, "/api/etsy/fulfillment": { "post": { "tags": [ "Etsy Orders" ], "operationId": "post_api_etsy_fulfillment_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "feed" ], "properties": { "feed": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns Etsy Order" } } } }, "/api/etsy/listings": { "put": { "tags": [ "Etsy Listings" ], "operationId": "put_api_etsy_listings_update", "responses": { "201": { "description": "Returns result of creation listing" } } }, "post": { "tags": [ "Etsy Listings" ], "operationId": "post_api_etsy_listings_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopListing" } } } }, "responses": { "201": { "description": "Returns result of creation listing" } } } }, "/api/etsy/listings/{listingId}": { "get": { "tags": [ "Etsy Listings" ], "operationId": "get_api_etsy_listings_get", "parameters": [ { "name": "includeInventory", "in": "query", "description": "Fetch the listing inventory from Etsy and include it in the response. Requires X-ACCOUNT-TOKEN", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "0|1|true|false" } }, { "name": "listingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns listing details" } } } }, "/api/etsy/orders": { "get": { "tags": [ "Etsy Orders" ], "operationId": "get_api_etsy_orders_get", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } }, { "name": "wasCanceled", "in": "query", "description": "When true, the endpoint will only return the canceled orders", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Returns Etsy Orders" } } } }, "/api/etsy/processing-profiles": { "get": { "tags": [ "Etsy Processing profiles" ], "operationId": "get_api_etsy_processing_profiles", "responses": { "200": { "description": "Returns list of Processing profiles" } } } }, "/api/etsy/production-partners": { "get": { "tags": [ "Etsy Listings" ], "operationId": "get_api_etsy_get_production_partners", "responses": { "200": { "description": "Returns a list of production partners" } } } }, "/api/etsy/shop-sections": { "get": { "tags": [ "Etsy Shop Sections" ], "operationId": "get_api_etsy_shop_sections", "responses": { "200": { "description": "Returns list of Shop Sections from etsy" } } } }, "/api/walmart/account": { "post": { "tags": [ "Walmart Accounts" ], "operationId": "post_api_walmart_account_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "walmartClientId", "walmartClientSecret", "marketplace", "isSandbox" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,50}" }, "walmartClientId": { "type": "string", "default": null, "pattern": ".{1,255}" }, "walmartClientSecret": { "type": "string", "default": null, "pattern": ".{1,255}" }, "marketplace": { "type": "string", "default": null, "pattern": ".{1,50}" }, "isSandbox": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "/api/walmart/orders": { "get": { "tags": [ "Walmart Orders" ], "operationId": "get_api_walmart_orders_index", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } }, { "name": "shipNodeTypes[]", "in": "query", "description": "Filter by fulfillment type. Allowed: SellerFulfilled, WFSFulfilled, 3PLFulfilled", "required": false, "allowEmptyValue": true, "explode": true, "schema": { "type": "array", "items": {}, "default": null } } ], "responses": { "default": { "description": "" } } } }, "/api/walmart/shipment/{orderId}": { "post": { "tags": [ "Walmart Orders" ], "operationId": "post_api_walmart_fulfillment_create", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns Walmart Order" } } } }, "/api/walmart/orders/{orderId}": { "get": { "tags": [ "Walmart Orders" ], "operationId": "get_api_walmart_orders_get", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/tiktok/orders": { "get": { "tags": [ "TikTok" ], "operationId": "get_api_tiktok_orders_get", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders after the specified date and time in UTC. e.g. '2016-11-21T13:53:49.000000Z'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } } ], "responses": { "200": { "description": "Returns TikTok Orders" } } } }, "/api/tiktok/oauth/begin": { "post": { "operationId": "post_api_tiktok_oauth_begin", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "marketplace" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,255}" }, "marketplace": { "type": "string", "default": null }, "accountHash": { "type": "string", "default": null, "pattern": ".{1,255}" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns url for authorizing access to tiktok api" } } } }, "/api/tiktok/pending-account": { "get": { "operationId": "get_api_tiktok_pending_account_get", "parameters": [ { "name": "state", "in": "query", "description": "State", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".{1,255}" } } ], "responses": { "default": { "description": "" } } } }, "/api/tiktok/pending-account/{id}": { "delete": { "operationId": "delete_api_tiktok_pending_account_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/tiktok/shops": { "get": { "tags": [ "TikTok" ], "operationId": "get_api_tiktok_shops_get", "responses": { "200": { "description": "Returns TikTok shops" } } } }, "/api/google/account": { "post": { "tags": [ "Google Accounts" ], "operationId": "post_api_google_account_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,50}" } }, "type": "object" } } } }, "responses": { "201": { "description": "Returns Google account token and redirectUrl for connect" } } } }, "/api/google/account/verify/{token}": { "get": { "tags": [ "Google Accounts" ], "operationId": "get_api_google_account_verify", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Google account status" } } } }, "/api/google/product-categories": { "get": { "tags": [ "Google Product Categories" ], "operationId": "get_api_google_product_categories", "responses": { "default": { "description": "" } } } }, "/api/kaufland/account": { "post": { "tags": [ "Kaufland Accounts" ], "operationId": "post_api_kaufland_account_create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "kauflandClientKey", "kauflandSecretKey", "isSandbox" ], "properties": { "name": { "type": "string", "default": null, "pattern": ".{1,50}" }, "kauflandClientKey": { "type": "string", "default": null, "pattern": ".{1,255}" }, "kauflandSecretKey": { "type": "string", "default": null, "pattern": ".{1,255}" }, "isSandbox": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "/api/kaufland/orders": { "get": { "tags": [ "Kaufland Orders" ], "operationId": "get_api_kaufland_orders_get", "parameters": [ { "name": "fromDate", "in": "query", "description": "Return Orders updated after the specified date and time. e.g. '2026-01-21T13:53:49+00:00'", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d" } } ], "responses": { "default": { "description": "" } } } }, "/api/kaufland/shipment": { "post": { "tags": [ "Kaufland Shipments" ], "operationId": "post_api_kaufland_shipment_post", "requestBody": { "content": { "application/json": { "schema": { "required": [ "items" ], "properties": { "items": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } } }, "components": { "schemas": { "Client": { "type": "object" }, "string": {}, "ShopListing": { "properties": { "quantity": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "who_made": { "type": "string" }, "when_made": { "type": "string" }, "taxonomy_id": { "type": "integer" }, "state": { "type": "string", "default": "active" }, "type": { "type": "string", "default": "physical" }, "shipping_profile_id": { "type": "integer", "default": null, "nullable": true }, "return_policy_id": { "type": "integer", "default": null, "nullable": true }, "readiness_state_id": { "type": "integer", "default": null, "nullable": true }, "materials": { "type": "array", "items": { "type": "string" }, "default": [] }, "shop_section_id": { "type": "integer", "default": null, "nullable": true }, "processing_min": { "type": "integer", "default": null, "nullable": true }, "processing_max": { "type": "integer", "default": null, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] }, "styles": { "type": "array", "items": { "type": "string" }, "default": [] }, "item_weight": { "type": "number", "format": "float", "default": null, "nullable": true }, "item_length": { "type": "number", "format": "float", "default": null, "nullable": true }, "item_width": { "type": "number", "format": "float", "default": null, "nullable": true }, "item_height": { "type": "number", "format": "float", "default": null, "nullable": true }, "item_weight_unit": { "type": "string", "default": null, "nullable": true }, "item_dimensions_unit": { "type": "string", "default": null, "nullable": true }, "is_personalizable": { "type": "boolean" }, "personalization_is_required": { "type": "boolean", "default": null, "nullable": true }, "personalization_char_count_max": { "type": "integer", "default": null, "nullable": true }, "personalization_instructions": { "type": "string", "default": null, "nullable": true }, "production_partner_ids": { "type": "array", "items": { "type": "integer" }, "default": [] }, "image_ids": { "type": "array", "items": { "type": "integer" }, "default": [] }, "is_supply": { "type": "boolean" }, "is_customizable": { "type": "boolean" }, "should_auto_renew": { "type": "boolean", "default": null, "nullable": true }, "is_taxable": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" }, "default": [] }, "sku": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "authToken": { "type": "apiKey", "name": "X-API-AUTH-TOKEN", "in": "header" }, "host": { "type": "apiKey", "name": "X-API-HOST", "in": "header" }, "apiKey": { "type": "apiKey", "name": "X-API-KEY", "in": "header" }, "version": { "type": "apiKey", "name": "X-API-VERSION", "in": "header" }, "userAgent": { "type": "apiKey", "name": "USER_AGENT", "in": "header" } } }, "security": [ { "authToken": [], "host": [], "apiKey": [], "version": [], "userAgent": [] } ], "tags": [ { "name": "Amazon Accounts" }, { "name": "Amazon Product Type" }, { "name": "Amazon Category" }, { "name": "Amazon Department" }, { "name": "Amazon Marketplace" }, { "name": "Amazon Notifications" }, { "name": "Amazon Orders" }, { "name": "Amazon Products" }, { "name": "Amazon Shipping templates" }, { "name": "Amazon Category Specification" }, { "name": "Amazon Statistic" }, { "name": "Amazon Variations" }, { "name": "API jobs" }, { "name": "license" }, { "name": "Ebay Accounts" }, { "name": "Ebay Categories" }, { "name": "Ebay Category Details" }, { "name": "Ebay Marketplace" }, { "name": "Ebay Orders" }, { "name": "Ebay Category Specification" }, { "name": "Ebay Category GPSR" }, { "name": "Ebay Statistic" }, { "name": "Etsy Accounts" }, { "name": "Etsy Category" }, { "name": "Etsy return policies" }, { "name": "Etsy Shipping profiles" }, { "name": "Etsy Orders" }, { "name": "Etsy Listings" }, { "name": "Etsy Processing profiles" }, { "name": "Etsy Shop Sections" }, { "name": "Walmart Accounts" }, { "name": "Walmart Orders" }, { "name": "TikTok" }, { "name": "Google Accounts" }, { "name": "Google Product Categories" }, { "name": "Kaufland Accounts" }, { "name": "Kaufland Orders" }, { "name": "Kaufland Shipments" } ] }