{ "openapi": "3.0.3", "info": { "title": "DIXENO Marketplace API", "description": "This API can be used to get/set various information from/to the DIXENO marketplace
(last modified on 2023-01-18 17:15)", "version": "1.0.3", "license": { "name": "DIXENO GmbH", "url": "https://www.dixeno.de" }, "contact": { "email": "info@dixeno.de" }, "termsOfService": " " }, "paths": { "/ping": { "get": { "summary": "check connection", "tags": [ "General" ], "description": "Check if API is in place, responding and apikey is accepted", "operationId": "ping", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespPing" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getAvailableLanguages": { "get": { "summary": "get installed languages in shop", "tags": [ "General" ], "description": "Get all installed languages in shop", "operationId": "getAvailableLanguages", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespAvailableLanguages" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getImportSettings": { "get": { "summary": "get FTP import-settings from you merchant-backend", "tags": [ "General" ], "description": "Get FTP import-settings from merchant-backend (except password!)", "operationId": "getImportSettings", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespImportSetting" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getExampleArticles": { "get": { "summary": "get article examples", "tags": [ "Articles" ], "description": "Get articles marked as example articles", "operationId": "getExampleArticles", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespExampleArticles" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/importArticleCsv": { "get": { "summary": "start article import configured in your merchant-backend", "tags": [ "Articles" ], "description": "Trigger CSV import from file configured in merchant-backend (get from FTP server)", "operationId": "importArticleCsv", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespImportArticleCsv" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/processCsvPictures": { "get": { "summary": "transfer pictures from imported URLs to corresponding articles", "tags": [ "Articles" ], "description": "Trigger process to download the configured number of article pictures into shop from previous article import (required after running importArticleCsv)", "operationId": "processCsvPictures", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespProcessCsvPictures" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/createOrUpdateArticle": { "put": { "summary": "create new or update existing articles", "tags": [ "Articles" ], "description": "Create or update existing article", "operationId": "createOrUpdateArticle", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "requestBody": { "description": "Create or update article[s]", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespcreateOrUpdateArticle" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getArticles": { "get": { "summary": "get merchant's article IDs", "tags": [ "Articles" ], "description": "Get your article IDs", "operationId": "getArticles", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespArticles" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getArticle": { "get": { "summary": "get details of a certain article or all your articles", "tags": [ "Articles" ], "description": "Get details for current merchant's articles", "operationId": "getArticle", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of article", "name": "article_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespArticle" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getCategories": { "get": { "summary": "get category IDs in shop", "tags": [ "Articles" ], "description": "Get category IDs available in shop", "operationId": "getCategories", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespCategories" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getCategory": { "get": { "summary": "get details of a certain or all categories", "tags": [ "Articles" ], "description": "Get details for category ID[s] available in shop", "operationId": "getCategory", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of category", "name": "category_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespCategory" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getAttributes": { "get": { "summary": "get attribute IDs in shop", "tags": [ "Articles" ], "description": "Get attribute IDs available in shop", "operationId": "getAttributes", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespAttributes" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getAttribute": { "get": { "summary": "get details of a certain or all attributes", "tags": [ "Articles" ], "description": "Get details for attribute ID[s] available in shop", "operationId": "getAttribute", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of attribute", "name": "attribute_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespAttribute" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getAttributeValues": { "get": { "summary": "get details of a certain or all attributes", "tags": [ "Articles" ], "description": "Get list of possible attribute values to be used for importing articles", "operationId": "getAttributeValues", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespAttributeValues" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getPaymentMethods": { "get": { "summary": "get payment methods available in shop", "tags": [ "Payment" ], "description": "Get payment methods available in shop", "operationId": "getPaymentMethods", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespPaymentMethods" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getDeliveryMethods": { "get": { "summary": "get delivery methods available in shop", "tags": [ "Delivery" ], "description": "Get delivery methods available in shop", "operationId": "getDeliveryMethods", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespDeliveryMethods" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getNewPayments": { "get": { "summary": "get your payments not marked as 'seen'", "tags": [ "Payment" ], "description": "Get your payments not yet marked as 'seen'", "operationId": "getNewPayments", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespNewPayments" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/markPaymentAsSeen": { "get": { "summary": "mark payment for certain order as 'seen'", "tags": [ "Payment" ], "description": "Mark payment for certain order as 'seen'", "operationId": "markPaymentAsSeen", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS - payment for order now marked as seen", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getNewOrders": { "get": { "summary": "get your orders not marked as 'seen'", "tags": [ "Orders" ], "description": "Get orders not yet marked as 'seen'", "operationId": "getNewOrders", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespNewOrders" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getOrderList": { "get": { "summary": "get your orders within a given timeframe", "tags": [ "Orders" ], "description": "Get orders in a given timeframe", "operationId": "getOrderList", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "start of timeframe ", "name": "from", "in": "query", "required": true, "schema": { "type": "string", "default": "2020-01-01 00:00:01", "pattern": "20[0-9]{2}-[0-1]{1}[0-9]{1}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}", "maxLength": 20 } }, { "description": "end of timeframe", "name": "to", "in": "query", "required": true, "schema": { "type": "string", "default": "2025-12-31 23:59:59", "pattern": "20[0-9]{2}-[0-1]{1}[0-9]{1}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}", "maxLength": 20 } }, { "description": "ordertype (1 = Regular order, 2=valid Offer, 3=Provision-Order, default: all)", "name": "order_type", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "1", "2", "3" ] } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespNewOrders" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getOrder": { "get": { "summary": "get details for a given order", "tags": [ "Orders" ], "description": "Get details for certain order", "operationId": "getOrder", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "schema": { "$ref": "#/components/schemas/InputOXID" } }, { "description": "Order number", "name": "orderNr", "in": "query", "schema": { "type": "number", "maximum": 99999, "minimum": 0, "format": "int32" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespOrder" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/markOrderAsSeen": { "get": { "summary": "mark certain order as 'seen'", "tags": [ "Orders" ], "description": "Mark certain order as seen by API", "operationId": "markOrderAsSeen", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS - order now marked as seen", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/unmarkAsFetched": { "get": { "summary": "mark certain order as 'not seen'", "tags": [ "Orders" ], "description": "Unmark certain order as not seen by API", "operationId": "unmarkAsFetched", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS - order not marked as seen", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/setOrderShippingTargetDate": { "get": { "summary": "set target shipping date for certain order or articles in it", "tags": [ "Orders" ], "description": "Set target shipping date for certain order / articles in that order", "operationId": "setOrderShippingTargetDate", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InputOXID" } }, { "description": "Target shipping date (time will be set to 00:00:00)", "name": "shipdate", "in": "query", "required": true, "schema": { "type": "string", "default": "2022-09-30", "pattern": "20[0-9]{2}-[0-1]{1}[0-9]{1}-[0-9]{2}", "maxLength": 10 } }, { "description": "[OX]ID of item - if item ID is not set, entire order will get that shipping date", "name": "item_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS - shipping date has been set", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/setOrderShipping": { "get": { "summary": "set shipping information for certain order or articles in it", "tags": [ "Orders" ], "description": "Sets the shipping-method, tracking-code /tracking-URL and shipping-date that was actually used to ship a specific item of an order (or all items for an order if you leave item_id blank)", "operationId": "setOrderShipping", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of order", "name": "order_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InputOXID" } }, { "description": "Shipping date (time will be set to 00:00:00)", "name": "shipdate", "in": "query", "required": true, "schema": { "type": "string", "default": "2022-09-30", "pattern": "20[0-9]{2}-[0-1]{1}[0-9]{1}-[0-9]{2}", "maxLength": 10 } }, { "description": "Tracking-code or tracking-URL (depending on shop configuration) used for tracking of shipment", "name": "trackingcode", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Shipper", "name": "shipper", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "[OX]ID of item - if item ID is not set, entire order will be marked as shipped", "name": "item_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } }, { "description": "Quantity of item shipped", "name": "quantity", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Estimated delivery date", "name": "deliverydate", "in": "query", "required": false, "schema": { "type": "string", "default": "2022-09-30" } }, { "description": "Weight in [kg]", "name": "weight", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SUCCESS - tracking information for order has been set", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getCustomers": { "get": { "summary": "get merchant's customer's IDs", "tags": [ "Customers" ], "description": "Get your customer's IDs", "operationId": "getCustomers", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespCustomers" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } }, "/getCustomer": { "get": { "summary": "get details of a certain customer or all your customers", "tags": [ "Customers" ], "description": "Get details for current merchant's customers", "operationId": "getCustomer", "parameters": [ { "name": "apikey", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/testAPIKey" } }, { "description": "[OX]ID of customer", "name": "customer_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InputOXID" } } ], "responses": { "200": { "description": "SUCCESS", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiRespCustomer" } } } }, "default": { "description": "General server error - Something went wrong", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResp" } } } } } } } }, "security": [ { "APIkey": [] } ], "servers": [ { "url": "{protocol}://{serverName}/{endPoint}", "description": "server/endpoint you are running against - build from the elements below", "variables": { "protocol": { "default": "https", "enum": [ "http", "https" ] }, "serverName": { "default": "www.example.de", "description": "please enter the url for your server" }, "endPoint": { "default": "marketplaceapi", "enum": [ "marketplaceapi" ] } } } ], "components": { "securitySchemes": { "Basic": { "type": "http", "scheme": "basic" }, "APIkey": { "type": "apiKey", "name": "apikey", "in": "query" } }, "schemas": { "ApiResp": { "type": "object", "properties": { "status": { "properties": { "status_code": { "type": "string" }, "status_message": { "type": "string" }, "server_time": { "type": "string" } } } }, "xml": { "name": "##default" } }, "ApiRespPing": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "ping": { "type": "string" } }, "xml": { "name": "##default" } } ] }, "ApiRespImportSetting": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "ImportSettings": { "type": "object" } }, "xml": { "name": "##default" } } ] }, "ApiRespAvailableLanguages": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "languages": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespExampleArticles": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "example_articles": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespImportArticleCsv": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "totalArticleRows": { "type": "integer" }, "newImportedArticles": { "type": "integer" }, "pictureURLs": { "type": "integer" } }, "xml": { "name": "##default" } } ] }, "ApiRespProcessCsvPictures": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "import_msg": { "type": "string" }, "has_more": { "type": "integer" }, "$iRemaining": { "type": "integer" } }, "xml": { "name": "##default" } } ] }, "ApiRespcreateOrUpdateArticle": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "new": { "type": "integer" }, "err": { "type": "integer" }, "total": { "type": "integer" }, "pics": { "type": "integer" } }, "xml": { "name": "##default" } } ] }, "ApiRespArticles": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "article_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespArticle": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "article": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespCategories": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "category_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespCategory": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "category": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespAttributes": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "attribute_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespAttribute": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "attribute": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespAttributeValues": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "AttributeValues": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespCustomers": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "customer_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespCustomer": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "customer_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespNewPayments": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "payment": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespPaymentMethods": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "payment": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespDeliveryMethods": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "deliveries": { "type": "array", "items": { "type": "object" } } }, "xml": { "name": "##default" } } ] }, "ApiRespNewOrders": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "order_ids": { "type": "array", "items": { "type": "number" } } }, "xml": { "name": "##default" } } ] }, "ApiRespOrder": { "allOf": [ { "$ref": "#/components/schemas/ApiResp" }, { "type": "object", "properties": { "order": { "type": "object" } }, "xml": { "name": "##default" } } ] }, "InputOXID": { "type": "string", "pattern": "^[a-fA-F0-9]*$", "maxLength": 32 }, "testAPIKey": { "type": "string", "example": "Please enter your API key here", "description": "Please use API key from merchant-backend", "pattern": "^[a-zA-Z0-9]*$", "maxLength": 150 } } } }