{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "plentymarkets REST-API", "x-logo": { "url": "https:\/\/www.plentymarkets.eu\/layout\/plenty_responsive\/img\/plentymarkets-logo-claim.svg", "backgroundColor": "#FFFFFF" }, "description": "The plentymarkets REST API expands the functionality of the plentymarkets CMS and allows access to resources, i.e. data records, via unique URI paths", "contact": { "name": "plentymarkets", "url": "https:\/\/forum.plentymarkets.com\/c\/rest-api" } }, "schemes": [ "https" ], "consumes": [ "application\/json" ], "host": "example.com", "basePath": "\/", "tags": [ { "name": "Account", "description": "Routes for Account", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/account" } }, { "name": "Accounting", "description": "Routes for Accounting", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/accounting" } }, { "name": "AddressDesign", "description": "Routes for AddressDesign", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/address_design" } }, { "name": "Authentication", "description": "Routes for Authentication", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/authentication" } }, { "name": "Authorization", "description": "Routes for Authorization", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/authorization" } }, { "name": "Basket", "description": "Routes for Basket", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/basket" } }, { "name": "Batch", "description": "Routes for Batch", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/batch" } }, { "name": "Blog", "description": "Routes for Blog", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/blog" } }, { "name": "Board", "description": "Routes for Board", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/board" } }, { "name": "Boards", "description": "Routes for Boards", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/boards" } }, { "name": "Category", "description": "Routes for Category", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/category" } }, { "name": "Cloud", "description": "Routes for Cloud", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/cloud" } }, { "name": "Comment", "description": "Routes for Comment", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/comment" } }, { "name": "Configuration", "description": "Routes for Configuration", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/configuration" } }, { "name": "Contact", "description": "Routes for Contact", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/contact" } }, { "name": "ContactAnonymization", "description": "Routes for ContactAnonymization", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/contact_anonymization" } }, { "name": "ConvertGuests", "description": "Routes for ConvertGuests", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/convert_guests" } }, { "name": "CustomerContract", "description": "Routes for CustomerContract", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/customer_contract" } }, { "name": "Document", "description": "Routes for Document", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/document" } }, { "name": "ElasticSync", "description": "Routes for ElasticSync", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/elastic_sync" } }, { "name": "Export", "description": "Routes for Export", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/export" } }, { "name": "ExportSettings", "description": "Routes for ExportSettings", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/export_settings" } }, { "name": "Feedback", "description": "Routes for Feedback", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/feedback" } }, { "name": "Fulfillment", "description": "Routes for Fulfillment", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/fulfillment" } }, { "name": "Item", "description": "Routes for Item", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/item" } }, { "name": "LegalInformation", "description": "Routes for LegalInformation", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/legal_information" } }, { "name": "Listing", "description": "Routes for Listing", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/listing" } }, { "name": "Log", "description": "Routes for Log", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/log" } }, { "name": "Market", "description": "Routes for Market", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/market" } }, { "name": "Messenger", "description": "Routes for Messenger", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/messenger" } }, { "name": "Newsletter", "description": "Routes for Newsletter", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/newsletter" } }, { "name": "Order", "description": "Routes for Order", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/order" } }, { "name": "OrderSummary", "description": "Routes for OrderSummary", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/order_summary" } }, { "name": "Payment", "description": "Routes for Payment", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/payment" } }, { "name": "Pim", "description": "Routes for Pim", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/pim" } }, { "name": "PluginMultilingualism", "description": "Routes for PluginMultilingualism", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/plugin_multilingualism" } }, { "name": "PluginSet", "description": "Routes for PluginSet", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/plugin_set" } }, { "name": "Plugins", "description": "Routes for Plugins", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/plugins" } }, { "name": "Property", "description": "Routes for Property", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/property" } }, { "name": "Report", "description": "Routes for Report", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/report" } }, { "name": "Returns", "description": "Routes for Returns", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/returns" } }, { "name": "SalesRepresentativeRegion", "description": "Routes for SalesRepresentativeRegion", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/sales_representative_region" } }, { "name": "Shop", "description": "Routes for Shop", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/shop" } }, { "name": "StockManagement", "description": "Routes for StockManagement", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/stock_management" } }, { "name": "Sync", "description": "Routes for Sync", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/sync" } }, { "name": "Tag", "description": "Routes for Tag", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/tag" } }, { "name": "Ticket", "description": "Routes for Ticket", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/ticket" } }, { "name": "TicketMessage", "description": "Routes for TicketMessage", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/ticket_message" } }, { "name": "User", "description": "Routes for User", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/user" } }, { "name": "Warehouse", "description": "Routes for Warehouse", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/warehouse" } }, { "name": "Webstore", "description": "Routes for Webstore", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/webstore" } }, { "name": "Wizard", "description": "Routes for Wizard", "externalDocs": { "description": "For the old documentation click here", "url": "https:\/\/developers.plentymarkets.com\/rest-doc\/wizard" } }, { "name": "plentyMarketplace", "description": "Routes for plentyMarketplace" } ], "paths": { "\/export\/{exportKey}": { "get": { "summary": "", "description": "", "tags": [ "Export" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/mixed" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "exportKey", "type": "integer", "required": true, "description": "", "format": "integer", "in": "path" } ] } }, "\/export\/{exportKey}\/{token}": { "get": { "summary": "", "description": "", "tags": [ "Export" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/mixed" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "exportKey", "type": "integer", "required": true, "description": "", "format": "integer", "in": "path" }, { "name": "token", "type": "integer", "required": true, "description": "", "format": "integer", "in": "path" } ] } }, "\/rest\/account\/login": { "post": { "summary": "Login", "description": "Logs in to the online store with front end user credentials. The login call returns a JSON object that contains information, such as the access token and the refresh token.", "tags": [ "Account" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/TokenData" } } }, "parameters": [ { "in": "body", "name": "\/rest\/account\/login", "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "description": "Password of the front end user" }, "email": { "type": "string", "description": "Email address of the front end user" }, "id": { "type": "integer", "description": "ID of the front end user" } } } } ] } }, "\/rest\/account\/login\/refresh": { "post": { "summary": "Refresh", "description": "Refreshes the access token using the refresh token. The refresh token is part of the login call response.", "tags": [ "Account" ], "responses": { "200": { "description": "OK" } } } }, "\/rest\/account\/logout": { "post": { "summary": "Logout", "description": "Logs out the front end user from the online store. The access token expires.", "tags": [ "Account" ], "responses": { "200": { "description": "OK" } } } }, "\/rest\/accounting\/locations": { "post": { "summary": "Create an accounting location", "description": "Creates an accounting location for a client. The plenty ID of the client must be specified.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/AccountingLocation" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "in": "body", "name": "\/rest\/accounting\/locations", "schema": { "type": "object", "required": [ "countryId", "name", "plentyId" ], "properties": { "countryId": { "type": "integer", "description": "The ID of the country of the accounting location" }, "name": { "type": "string", "description": "The name of the accounting location" }, "plentyId": { "type": "integer", "description": "The plenty ID of the client that the accounting location belongs to" } } } } ] } }, "\/rest\/accounting\/locations\/existing_accounts": { "get": { "summary": "Get all unique posting accounts", "description": "", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/PostingAccounts" } } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } } } }, "\/rest\/accounting\/locations\/posting_accounts": { "get": { "summary": "Get all posting accounts", "description": "", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/PostingAccounts" } } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } } }, "post": { "summary": "Save posting accounts", "description": "", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/PostingAccounts" } } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } } } }, "\/rest\/accounting\/locations\/posting_accounts\/{id}": { "delete": { "summary": "Delete an posting account", "description": "", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK" }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "id", "type": "integer", "required": true, "description": "The ID of the posting account", "format": "integer", "in": "path" } ] }, "get": { "summary": "Gets posting account by the unique id", "description": "", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/PostingAccounts" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "id", "type": "integer", "required": true, "description": "", "format": "integer", "in": "path" } ] } }, "\/rest\/accounting\/locations\/revenue_account_configurations": { "get": { "summary": "List revenue account configurations", "description": "Lists revenue account configurations of a system. The revenue accounts are returned as paginated result. By default 50 revenue accounts are on one page.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page of the response" }, "totalsCount": { "type": "integer", "description": "The total number of entries in the response" }, "isLastPage": { "type": "boolean", "description": "Flag that indicates if the page shown is the last page of the response" }, "lastPageNumber": { "type": "integer", "description": "The last page number" }, "firstOnPage": { "type": "integer", "description": "The index of the first item of the current page result" }, "lastOnPage": { "type": "integer", "description": "The index of the last item of the current page result" }, "itemsPerPage": { "type": "integer", "description": "The requested amount of items per result page" }, "entries": { "type": "array", "description": "List of RevenueAccountLocationConfiguration", "items": { "$ref": "#\/definitions\/RevenueAccountLocationConfiguration" } } } } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "page", "type": "integer", "required": false, "description": "The page to get. The default page that will be returned is page 1.", "format": "integer", "in": "query" }, { "name": "itemsPerPage", "type": "integer", "required": false, "description": "The number of revenue accounts to be displayed per page. The default number of orders per page is 50.", "format": "integer", "in": "query" } ] } }, "\/rest\/accounting\/locations\/{locationId}": { "delete": { "summary": "Delete an accounting location", "description": "Deletes an accounting location. The ID of the accounting location must be specified. Standard accounting locations can not be deleted.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK" }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location", "format": "integer", "in": "path" } ] }, "get": { "summary": "Get an accounting location", "description": "Gets an accounting location. The ID of the accounting location must be specified.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/AccountingLocation" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location", "format": "integer", "in": "path" } ] }, "put": { "summary": "Update an accounting location", "description": "Updates an accounting location. The ID of the accounting location must be specified.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/AccountingLocation" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location", "format": "integer", "in": "path" }, { "in": "body", "name": "\/rest\/accounting\/locations\/{locationId}", "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the accounting location optional" } } } } ] } }, "\/rest\/accounting\/locations\/{locationId}\/countries\/{countryId}\/revenue_accounts": { "get": { "summary": "Get the revenue account configuration of a country", "description": "Get the revenue account configuration of a country. The ID of the accounting location that the country is associated with as well as the ID of the country must be specified.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/RevenueAccountCountryConfiguration" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location.", "format": "integer", "in": "path" }, { "name": "countryId", "type": "integer", "required": true, "description": "The ID of the country.", "format": "integer", "in": "path" } ] } }, "\/rest\/accounting\/locations\/{locationId}\/debtor_account_configurations": { "get": { "summary": "Get debtor account configuration of an accounting location", "description": "Gets the debtor account configuration of an accounting location. The ID of the accounting location has to be specified. The debtor account configuration can contain one standard debtor account only or e.g. several accounts for each country of delivery.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/DebtorAccountConfiguration" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location.", "format": "integer", "in": "path" } ] } }, "\/rest\/accounting\/locations\/{locationId}\/debtor_accounts\/{mode}": { "get": { "summary": "Lists the debtor accounts by mode.", "description": "Lists the debtor accounts of an accounting location by mode. The ID of the accounting location and the mode have to be specified.", "tags": [ "Accounting" ], "security": [ { "oAuth2": [] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#\/definitions\/Collection" } }, "401": { "description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter." } }, "parameters": [ { "name": "locationId", "type": "integer", "required": true, "description": "The ID of the accounting location.", "format": "integer", "in": "path" }, { "name": "mode", "type": "string", "required": true, "description": "The mode defines how pending amounts are assigned to debtor accounts. The following modes are available:\n
OutputParam<\/code> entry.",
"tags": [
"Export"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/exports\/{exportId}": {
"delete": {
"summary": "Delete export",
"description": "Deletes an export. The ID of the export must be specified.",
"tags": [
"ExportSettings"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "exportId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get export",
"description": "Gets detailed information about an export. The ID of the export must be specified.",
"tags": [
"ExportSettings"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Export"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "exportId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an export",
"description": "Updates an export. The ID of the export must be specified.",
"tags": [
"ExportSettings"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Export"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "exportId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/exports\/{exportId}",
"schema": {
"type": "object",
"required": [
"id",
"name",
"formatKey",
"type",
"outputType",
"key"
],
"properties": {
"id": {
"type": "integer",
"description": "export id"
},
"name": {
"type": "string",
"description": "export name"
},
"limit": {
"type": "integer",
"description": "maximum number of entries optional"
},
"formatKey": {
"type": "string",
"description": "the format key"
},
"type": {
"type": "string",
"description": "export type allowed values are item, order, order_item, contact, contactNewsletter, warehouse, attribute, category, property, item_image, manufacturer, stock_movement, stock, facet, facetValue, facetValueReference, listing, listingMarketHistory"
},
"outputType": {
"type": "string",
"description": "the output type allowed values are admin, download, ftp, sftp, ftps"
},
"filters": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Filter"
}
},
"key": {
"type": "string",
"description": "output param key with outputParams"
},
"value": {
"type": "string",
"description": "output param value optional"
},
"formatSettings": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FormatSetting"
}
},
"outputParams": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OutputParam"
}
}
}
}
}
]
}
},
"\/rest\/exports\/{exportId}\/filters\/{key}": {
"delete": {
"summary": "Delete filter from the export",
"description": "Deletes filter from the export. The ID of the export and the ID of the filter must be specified.",
"tags": [
"ExportSettings"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "exportId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "key",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/comment": {
"post": {
"summary": "Create a feedback comment",
"description": "Creates a comment for a review.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/FeedbackComment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "message",
"type": "string",
"required": true,
"description": "Feedback comment message",
"format": "string",
"in": "query"
},
{
"name": "commentRelationTargetTypeId",
"type": "integer",
"required": true,
"description": "The type ID of the comment's target",
"format": "integer",
"in": "query"
},
{
"name": "commentRelationTargetId",
"type": "integer",
"required": true,
"description": "The ID of the comment's target",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/feedbacks\/comment\/{commentId}": {
"delete": {
"summary": "Delete a feedback comment",
"description": "Deletes a feedback comment. The ID of the feedback comment must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackCommentId",
"type": "integer",
"required": true,
"description": "The ID of the feedback comment",
"format": "integer",
"in": "query"
},
{
"name": "commentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a feedback comment",
"description": "Gets a feedback comment. The ID of the feedback comment must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/FeedbackComment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackCommentId",
"type": "integer",
"required": true,
"description": "The ID of the feedback comment",
"format": "integer",
"in": "query"
},
{
"name": "commentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/comments": {
"get": {
"summary": "List feedback comments",
"description": "Lists all feedback comments.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FeedbackComment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/feedbacks\/delete_feedbacks\/{feedbackIds}": {
"delete": {
"summary": "Delete multiple feedbacks",
"description": "Deletes multiple feedbacks. A list with IDs of feedbacks must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackIds",
"type": "string",
"required": true,
"description": "The list of feedback IDs, separated by commas",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/feedback": {
"post": {
"summary": "Create a feedback",
"description": "Creates a feedback.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Feedback"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "title",
"type": "string",
"required": false,
"description": "Feedback title",
"format": "string",
"in": "query"
},
{
"name": "feedbackRelationTargetId",
"type": "string",
"required": false,
"description": "The ID of the feedback's target",
"format": "string",
"in": "query"
},
{
"name": "feedbackRelationTargetTypeId",
"type": "string",
"required": false,
"description": "The type ID of the feedback's target",
"format": "string",
"in": "query"
},
{
"name": "feedbackRelationSourceTypeId",
"type": "string",
"required": false,
"description": "The type ID of the feedback's source",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/feedbacks\/feedback\/replies\/{feedbackId}": {
"get": {
"summary": "List feedback replies",
"description": "Lists feedback replies. The ID of the feedback must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Feedback"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackId",
"type": "integer",
"required": true,
"description": "The ID of the feedback",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/feedback\/{feedbackId}": {
"delete": {
"summary": "Delete a feedback",
"description": "Deletes a feedback. The ID of the feedback must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackId",
"type": "integer",
"required": true,
"description": "The ID of the feedback",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a feedback",
"description": "Gets a feedback. The ID of the feedback must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Feedback"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackId",
"type": "integer",
"required": true,
"description": "The ID of the feedback",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a feedback",
"description": "Updates a feedback. The ID of the feedback must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Feedback"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackId",
"type": "integer",
"required": true,
"description": "The ID of the feedback",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/feedbacks": {
"get": {
"summary": "List feedbacks",
"description": "Lists feedbacks. The reference type and the reference value must be specified (e.g. the reference type is 'order' and the reference value is the ID of the order).",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Feedback"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/feedbacks\/feedbacks_visibility": {
"put": {
"summary": "Update the visibility of multiple feedbacks",
"description": "Updates the visibility of multiple feedbacks. A list with IDs of feedbacks must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Feedback"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackIds",
"type": "string",
"required": true,
"description": "The list of feedback IDs, separated by commas",
"format": "string",
"in": "query"
},
{
"name": "isVisible",
"type": "boolean",
"required": true,
"description": "The visibility value",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/feedbacks\/migrate": {
"post": {
"summary": "Migrate legacy feedbacks",
"description": " @return \\Plenty\\Modules\\Feedback\\Models\\Feedback[]",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/feedbacks\/rating": {
"post": {
"summary": "Create a feedback rating",
"description": "Creates a feedback rating.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/FeedbackRating"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ratingValue",
"type": "integer",
"required": true,
"description": "The feedback's comment message",
"format": "integer",
"in": "query"
},
{
"name": "ratingRelationTargetTypeId",
"type": "integer",
"required": true,
"description": "The type ID of the rating's target",
"format": "integer",
"in": "query"
},
{
"name": "ratingRelationTargetId",
"type": "integer",
"required": true,
"description": "The ID of the rating's target",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/feedbacks\/rating\/{ratingId}": {
"delete": {
"summary": "Delete a feedback rating",
"description": "Deletes a feedback rating. The ID of the feedback rating must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackRatingId",
"type": "integer",
"required": true,
"description": "The ID of the feedback rating",
"format": "integer",
"in": "query"
},
{
"name": "ratingId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a feedback rating",
"description": "Gets a feedback rating. The ID of the feedback rating must be specified.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/FeedbackRating"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "feedbackRatingId",
"type": "integer",
"required": true,
"description": "The ID of the feedback rating",
"format": "integer",
"in": "query"
},
{
"name": "ratingId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/feedbacks\/ratings": {
"get": {
"summary": "List feedback ratings",
"description": "Lists feedback ratings.",
"tags": [
"Feedback"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FeedbackRating"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/fulfillment\/picklist\/picking_order_item": {
"get": {
"summary": "",
"description": "",
"tags": [
"Fulfillment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PickingOrderItem"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/fulfillment\/picklist\/picking_order_item\/{pickingOrderItemId}": {
"get": {
"summary": "",
"description": "",
"tags": [
"Fulfillment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PickingOrderItem"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pickingOrderItemId",
"type": "integer",
"required": true,
"description": "The PickingOrderItemId",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/item_sets": {
"delete": {
"summary": "Delete item sets",
"description": "",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemSet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "List item sets",
"description": "Lists all item sets.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemSet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create item sets",
"description": "Creates item Sets",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "params",
"type": "integer",
"required": false,
"description": "includes the item sets that have to be created",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update item sets",
"description": "Updates item sets",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemSet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/item_sets\/{id}": {
"delete": {
"summary": "Delete an item set",
"description": "Deletes an item set. The item ID of the item set must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an item set",
"description": "Gets the configuration of an item set. The item ID of the item set must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an item set",
"description": "Updates an item set. The item ID of the item set must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/item_sets\/{setId}\/components": {
"delete": {
"summary": "Delete item set components",
"description": "Deletes item set components. The ID of the set and the component must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetComponent"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List item set components of an item set",
"description": "Lists the item set components of an item set. The ID of the item set must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemSetComponent"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create item set components",
"description": "Creates item set components. The id of the set must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetComponent"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update item set components",
"description": "Updates item set components. The id of the set must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetComponent"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/item_sets\/{setId}\/components\/{id}": {
"delete": {
"summary": "Delete an item set component",
"description": "Deletes an item set component. The item set component ID of the item set component must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an item set component",
"description": "Gets an item set component. The ID of the component and the set must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetComponent"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an item set component",
"description": "Updates an item set component. The ID of the set and the component must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetComponent"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/item_sets\/{setId}\/config": {
"get": {
"summary": "Get the item set configuration of an item set",
"description": "Gets the item set configuration of an item set",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an item set configuration",
"description": "Updates an item set configuration. The id of the item set must be specified",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemSetConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items": {
"get": {
"summary": "Search item",
"description": "Search item",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Item",
"items": {
"$ref": "#\/definitions\/Item"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified variation information in the results. The following parameters are available: itemProperties, itemCrossSelling, variations, itemImages, itemShippingProfiles, ebayTitles",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "The language<\/a> of the variation information.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Limits the results to a specific page. The page number must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Limits the number of results listed per page to a specific number. The number of variations to be listed per page must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items with the specified item name. An item name must be specified.",
"format": "string",
"in": "query"
},
{
"name": "manufacturerId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items with the specified manufacturerId.",
"format": "string",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to items with the specified ID. More than one ID should be separated by commas.",
"format": "integer",
"in": "query"
},
{
"name": "flagOne",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to items with the specified flagOne.",
"format": "integer",
"in": "query"
},
{
"name": "flagTwo",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to items with the specified flagTwo.",
"format": "integer",
"in": "query"
},
{
"name": "updatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated during the specified period. The end date (to) is optional. If no end date is specified, items updated between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/items?updatedBetween=1451606400,1456790400 will list items updated between 2016-01-01 and 2016-03-01. ...\/items?updatedBetween=1451606400 will list items updated since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "variationUpdatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items with variations that were updated during the specified period. The end date (to) is optional. If no end date is specified, items with variations updated between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/items?updatedBetween=1451606400,1456790400 will list items with variations that were updated between 2016-01-01 and 2016-03-01. ...\/items?updatedBetween=1451606400 will list items with variations that were updated since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "variationRelatedUpdatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items with variations for which related information was updated during the specified period. Related information is defined as information linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. See variationUpdatedBetween for supported formats.",
"format": "string",
"in": "query"
},
{
"name": "or",
"type": "string",
"required": false,
"description": "Filters can be defined in this param to link them via OR instead of AND. The syntax looks like the following: or=(updatedBetween=1573050718&varitionUpdatedBetween=1573050718). Everything in the brackets is written in the normal URL-Syntax. The or-param can be used multiple times if it is used like this: or[]=(...)&or[]=(...)",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create new items",
"description": "Create new items",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Item"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items",
"schema": {
"type": "object",
"required": [
"ageRestriction",
"title",
"profileId",
"propertyId",
"variations"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the item optional"
},
"stockType": {
"type": "integer",
"description": "The stock type of the item. Possible values:0 = Stocked item (default)1 = Production item2 = Colli3 = Special order item optional allowed values are 0, 1, 2, 3"
},
"storeSpecial": {
"type": "integer",
"description": "Option to present items more prominently in the online store.1 = Special offer2 = New items3 = Top items optional allowed values are 0, 1, 2, 3"
},
"ownerId": {
"type": "integer",
"description": "The plentymarkets user that is assigned as owner of this item. optional"
},
"manufacturerId": {
"type": "integer",
"description": "The ID of the manufacturer of the item optional"
},
"createdAt": {
"type": "string",
"description": "Timestamp of the date and time the item was created. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "Deprecated: The customs tariff number of the item; usually a 11 digit code number based on the Harmonised System optional"
},
"revenueAccount": {
"type": "integer",
"description": "The revenue account the item is linked to. An individual revenue account can be saved for each item in plentymarkets. If this is not done, plentymarkets automatically determines a revenue account based on the VAT rate. optional"
},
"couponRestriction": {
"type": "integer",
"description": "Indicates if the item can be purchased using a promotional coupon.0 = Permitted1 = Not permitted2 = Purchasable with coupon only optional allowed values are 0, 1, 2"
},
"condition": {
"type": "integer",
"description": "The condition of the item. Possible values:0 = New1 = Used2 = Boxed as new3 = New with label4 = Factory seconds optional allowed values are 0, 1, 2, 3, 4"
},
"conditionApi": {
"type": "integer",
"description": "The condition of the item that is transferred to markets via API.0 = New1 = Used but as new2 = Used but very good3 = Used but good4 = Used but acceptable5 = Factory seconds optional allowed values are 0, 1, 2, 3, 4, 5"
},
"isSubscribable": {
"type": "boolean",
"description": "Flag that indicates if the item can be ordered as a subscription item. If yes, the item can be ordered for delivery at regular intervals. optional"
},
"isShippingPackage": {
"type": "boolean",
"description": "Flag that indicates if a shipping package is to be used for this item. If yes and the variation's dimensions are entered in the Settings tab of a variation, the correct shipping package is assigned automatically. optional"
},
"amazonFbaPlatform": {
"type": "integer",
"description": "Indicates the platform used for Fulfilment by Amazon (FBA). 0 = Do not use1 = AMAZON EU (Europe)2 = AMAZON FE (Far East)3 = AMAZON NA (North America) optional allowed values are 0, 1, 2, 3"
},
"isShippableByAmazon": {
"type": "boolean",
"description": "Flag that indicates if the item can be shipped with Amazon Multi-Channel. Amazon Multi-Channel Fulfillment is a service for fulfilling orders from sales channels other than Amazon platforms using inventory stored in the Amazon fulfillment center. optional"
},
"amazonProductType": {
"type": "integer",
"description": "The Amazon product type of the item. List of IDs: https:\/\/www.plentymarkets.co.uk\/manual\/data-exchange\/data-formats\/item\/ optional"
},
"amazonFedas": {
"type": "string",
"description": "The FEDAS product classification key of the item. optional"
},
"ebayPresetId": {
"type": "integer",
"description": "The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2. optional"
},
"ebayCategory": {
"type": "integer",
"description": "The eBay category 1 of the item. This category is used when a new listing is created. optional"
},
"ebayCategory2": {
"type": "integer",
"description": "The eBay category 2 of the item. This category is used when a new listing is created. optional"
},
"ebayStoreCategory": {
"type": "integer",
"description": "The ID of the eBay store category 1 of the item. This value is used for new listings. optional"
},
"ebayStoreCategory2": {
"type": "integer",
"description": "The ID of the eBay store category 2 of the item. This value is used for new listings. optional"
},
"rakutenCategoryId": {
"type": "integer",
"description": "The ID of the Rakuten category of this item. optional"
},
"flagOne": {
"type": "integer",
"description": "Flag 1 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31"
},
"flagTwo": {
"type": "integer",
"description": "Flag 2 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11"
},
"ageRestriction": {
"type": "integer",
"description": "The age customers must be to purchase the item. Items with an age rating of 18+ must be linked to a shipping profile for which the PostIdent option is activated.0 = None available3 = Released for ages 3 and up6 = Ages 6 and up9 = Ages 9 and up12 = Ages 12 and up14 = Ages 14 and up16 = Ages 16 and up18 = Ages 18 and up50 = Not marked88 = Not 99 = Unknown optional allowed values are 0, 3, 6, 9, 12, 14, 16, 18, 50, 88, 99"
},
"feedback": {
"type": "integer",
"description": "The feedback, i.e. rating, that this item received. Possible values are 1 to 5 or 1 to 10 depending on the maximum rating setting. An initial feedback can be saved for items. The saved value will then be displayed as the initial feedback. Every time new feedback is submitted, the average value will be recalculated automatically. optional"
},
"ebayTitles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemEbayTitle"
}
},
"title": {
"type": "string",
"description": "The title."
},
"itemShippingProfiles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
},
"profileId": {
"type": "integer",
"description": "The unique ID of the shipping profile"
},
"itemProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemProperty"
}
},
"propertyId": {
"type": "integer",
"description": "The id of the property item"
},
"propertySelectionId": {
"type": "integer",
"description": "The id of the property selection optional"
},
"id": {
"type": "integer",
"description": "The ID of the item. The ID must be unique. optional"
},
"variations": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Variation"
}
}
}
}
}
]
},
"put": {
"summary": "Bulk update items",
"description": "Updates up to 50 items. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items",
"schema": {
"type": "object",
"required": [
"id",
"ageRestriction",
"title",
"profileId",
"propertyId"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the item. The ID must be unique."
},
"position": {
"type": "integer",
"description": "The position of the item optional"
},
"stockType": {
"type": "integer",
"description": "The stock type of the item. Possible values:0 = Stocked item (default)1 = Production item2 = Colli3 = Special order item optional allowed values are 0, 1, 2, 3"
},
"storeSpecial": {
"type": "integer",
"description": "Option to present items more prominently in the online store.1 = Special offer2 = New items3 = Top items optional allowed values are 0, 1, 2, 3"
},
"ownerId": {
"type": "integer",
"description": "The plentymarkets user that is assigned as owner of this item. optional"
},
"manufacturerId": {
"type": "integer",
"description": "The ID of the manufacturer of the item optional"
},
"createdAt": {
"type": "string",
"description": "Timestamp of the date and time the item was created. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "Deprecated: The customs tariff number of the item; usually a 11 digit code number based on the Harmonised System optional"
},
"revenueAccount": {
"type": "integer",
"description": "The revenue account the item is linked to. An individual revenue account can be saved for each item in plentymarkets. If this is not done, plentymarkets automatically determines a revenue account based on the VAT rate. optional"
},
"couponRestriction": {
"type": "integer",
"description": "Indicates if the item can be purchased using a promotional coupon.0 = Permitted1 = Not permitted2 = Purchasable with coupon only optional allowed values are 0, 1, 2"
},
"condition": {
"type": "integer",
"description": "The condition of the item. Possible values:0 = New1 = Used2 = Boxed as new3 = New with label4 = Factory seconds optional allowed values are 0, 1, 2, 3, 4"
},
"conditionApi": {
"type": "integer",
"description": "The condition of the item that is transferred to markets via API.0 = New1 = Used but as new2 = Used but very good3 = Used but good4 = Used but acceptable5 = Factory seconds optional allowed values are 0, 1, 2, 3, 4, 5"
},
"isSubscribable": {
"type": "boolean",
"description": "Flag that indicates if the item can be ordered as a subscription item. If yes, the item can be ordered for delivery at regular intervals. optional"
},
"isShippingPackage": {
"type": "boolean",
"description": "Flag that indicates if a shipping package is to be used for this item. If yes and the variation's dimensions are entered in the Settings tab of a variation, the correct shipping package is assigned automatically. optional"
},
"amazonFbaPlatform": {
"type": "integer",
"description": "Indicates the platform used for Fulfilment by Amazon (FBA). 0 = Do not use1 = AMAZON EU (Europe)2 = AMAZON FE (Far East)3 = AMAZON NA (North America) optional allowed values are 0, 1, 2, 3"
},
"isShippableByAmazon": {
"type": "boolean",
"description": "Flag that indicates if the item can be shipped with Amazon Multi-Channel. Amazon Multi-Channel Fulfillment is a service for fulfilling orders from sales channels other than Amazon platforms using inventory stored in the Amazon fulfillment center. optional"
},
"amazonProductType": {
"type": "integer",
"description": "The Amazon product type of the item. List of IDs: https:\/\/www.plentymarkets.co.uk\/manual\/data-exchange\/data-formats\/item\/ optional"
},
"amazonFedas": {
"type": "string",
"description": "The FEDAS product classification key of the item. optional"
},
"ebayPresetId": {
"type": "integer",
"description": "The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2. optional"
},
"ebayCategory": {
"type": "integer",
"description": "The eBay category 1 of the item. This category is used when a new listing is created. optional"
},
"ebayCategory2": {
"type": "integer",
"description": "The eBay category 2 of the item. This category is used when a new listing is created. optional"
},
"ebayStoreCategory": {
"type": "integer",
"description": "The ID of the eBay store category 1 of the item. This value is used for new listings. optional"
},
"ebayStoreCategory2": {
"type": "integer",
"description": "The ID of the eBay store category 2 of the item. This value is used for new listings. optional"
},
"rakutenCategoryId": {
"type": "integer",
"description": "The ID of the Rakuten category of this item. optional"
},
"flagOne": {
"type": "integer",
"description": "Flag 1 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31"
},
"flagTwo": {
"type": "integer",
"description": "Flag 2 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11"
},
"ageRestriction": {
"type": "integer",
"description": "The age customers must be to purchase the item. Items with an age rating of 18+ must be linked to a shipping profile for which the PostIdent option is activated.0 = None available3 = Released for ages 3 and up6 = Ages 6 and up9 = Ages 9 and up12 = Ages 12 and up14 = Ages 14 and up16 = Ages 16 and up18 = Ages 18 and up50 = Not marked88 = Not 99 = Unknown optional allowed values are 0, 3, 6, 9, 12, 14, 16, 18, 50, 88, 99"
},
"feedback": {
"type": "integer",
"description": "The feedback, i.e. rating, that this item received. Possible values are 1 to 5 or 1 to 10 depending on the maximum rating setting. An initial feedback can be saved for items. The saved value will then be displayed as the initial feedback. Every time new feedback is submitted, the average value will be recalculated automatically. optional"
},
"ebayTitles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemEbayTitle"
}
},
"title": {
"type": "string",
"description": "The title."
},
"itemShippingProfiles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
},
"profileId": {
"type": "integer",
"description": "The unique ID of the shipping profile"
},
"itemProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemProperty"
}
},
"propertyId": {
"type": "integer",
"description": "The id of the property item"
},
"propertySelectionId": {
"type": "integer",
"description": "The id of the property selection optional"
}
}
}
}
]
}
},
"\/rest\/items\/attribute_values\/{valueId}\/names": {
"get": {
"summary": "Get name and language for an attribute value ID",
"description": "Gets name and language for an attribute value ID. The attribute value ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AttributeValueName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an attribute value name",
"description": "Creates an attribute value name.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attribute_values\/{valueId}\/names",
"schema": {
"type": "object",
"required": [
"valueId",
"lang",
"name"
],
"properties": {
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value."
},
"lang": {
"type": "string",
"description": "The language of the attribute value."
},
"name": {
"type": "string",
"description": "The name of the attribute value. This attribute value name is displayed in the online store."
}
}
}
}
]
}
},
"\/rest\/items\/attribute_values\/{valueId}\/names\/{lang}": {
"delete": {
"summary": "Delete an attribute value name",
"description": "Deletes an attribute value name. The attribute value ID and language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an attribute value name",
"description": "Gets the attribute value name. The attribute value ID and language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute value name",
"description": "Updates an attribute value name.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attribute_values\/{valueId}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"valueId",
"lang",
"name"
],
"properties": {
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value."
},
"lang": {
"type": "string",
"description": "The language of the attribute value."
},
"name": {
"type": "string",
"description": "The name of the attribute value. This attribute value name is displayed in the online store."
}
}
}
}
]
}
},
"\/rest\/items\/attributes": {
"get": {
"summary": "List attributes",
"description": "Lists all attributes.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Attribute",
"items": {
"$ref": "#\/definitions\/Attribute"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified attribute information in the results. The following parameters are available: - names<\/b> = The names of the attribute<\/li>
- values<\/b> = The values of the attribute<\/li>
- maps<\/b> = The market maps of the attribute<\/li><\/ul> More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create an attribute",
"description": "Creates an attribute.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Attribute"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/attributes",
"schema": {
"type": "object",
"properties": {
"backendName": {
"type": "string",
"description": "The back end name of the attribute. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. optional"
},
"position": {
"type": "integer",
"description": "The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position. optional"
},
"isSurchargePercental": {
"type": "boolean",
"description": "Flag that indicates if the surcharge is percental. optional"
},
"isLinkableToImage": {
"type": "boolean",
"description": "Flag that indicates if an image can be linked to the attribute. optional"
},
"amazonAttribute": {
"type": "string",
"description": "The attribute of the market Amazon that this attribute is liked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"fruugoAttribute": {
"type": "string",
"description": "The attribute of the market Fruugo that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are null, color, size"
},
"pixmaniaAttribute": {
"type": "integer",
"description": "The attribute of the market PIXmania that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"ottoAttribute": {
"type": "string",
"description": "The attribute of the market OTTO that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are none, Dimension1, Dimension2, Dimension3, Dimension4"
},
"googleShoppingAttribute": {
"type": "string",
"description": "The attribute of the market Google Shopping that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are none, size, color, material, pattern"
},
"neckermannAtEpAttribute": {
"type": "integer",
"description": "The component of the market neckermann AT EP that this attribute is linked to. To list variations on this market, attributes must be linked to one of the components specified by the market. Check documentation of the market for permitted values. optional"
},
"typeOfSelectionInOnlineStore": {
"type": "string",
"description": "How customers can select the attribute in the front end of a client. To allow attribute selection by check mark, attribute availability must be checked on the client side. optional allowed values are dropdown, image, box"
},
"laRedouteAttribute": {
"type": "integer",
"description": "The attribute of the market La Redoute that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"isGroupable": {
"type": "boolean",
"description": "Flag that indicates if the attribute can be grouped in item lists. If yes, variations with this attribute can be shown in the ItemViewCategoriesList template first. Other attributes are nested and can only be selected after this attribute has been selected. optional"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/maps": {
"get": {
"summary": "Lists all attribute maps.",
"description": "Lists all attribute maps.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/items\/attributes\/markets\/maps": {
"post": {
"summary": "Creates a new attribute map.",
"description": "Creates a new attribute map.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/attributes\/markets\/maps",
"schema": {
"type": "object",
"required": [
"marketId",
"attributeId"
],
"properties": {
"marketId": {
"type": "number",
"description": "The unique ID of the market."
},
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute."
},
"name": {
"type": "string",
"description": "The name of the attribute map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. optional"
},
"marketInformation1": {
"type": "string",
"description": "The information regarding the marketplace. optional"
},
"marketInformation2": {
"type": "string",
"description": "The information regarding the marketplace. optional"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/values\/maps": {
"get": {
"summary": "Lists all attribute value maps.",
"description": "Lists all attribute value maps.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/items\/attributes\/values\/markets\/maps": {
"post": {
"summary": "Creates a new attribute value map.",
"description": "Creates a new attribute value map.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/attributes\/values\/markets\/maps",
"schema": {
"type": "object",
"required": [
"marketId",
"attributeId",
"attributeValueId"
],
"properties": {
"marketId": {
"type": "number",
"description": "The unique ID of the market."
},
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute."
},
"attributeValueId": {
"type": "integer",
"description": "The unique ID of the attribute value."
},
"name": {
"type": "string",
"description": "The name of the attribute value map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. optional"
},
"marketInformation1": {
"type": "string",
"description": "The information regarding the marketplace. optional"
},
"marketInformation2": {
"type": "string",
"description": "The information regarding the marketplace. optional"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/markets\/{marketId}\/maps": {
"delete": {
"summary": "Deletes an attribute map.",
"description": "Deletes an attribute map. The ID of the attribute and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets an attribute map.",
"description": "Gets an attribute map. The ID of the attribute and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Updates an attribute map.",
"description": "Updates an attribute map. The ID of the attribute and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/names": {
"get": {
"summary": "Get an attribute name",
"description": "Gets the attribute name in the specified language. The language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AttributeName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an attribute name",
"description": "Creates an attribute name in the specified language. The language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/names",
"schema": {
"type": "object",
"required": [
"lang",
"name"
],
"properties": {
"attributeId": {
"type": "integer",
"description": "The id of the attribute. optional"
},
"lang": {
"type": "string",
"description": "The language of the attribute."
},
"name": {
"type": "string",
"description": "The name of the attribute. This attribute name is displayed in the online store."
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/names\/{lang}": {
"delete": {
"summary": "Delete an attribute name",
"description": "Deletes the attribute name in the specified language. The language code and attribute name must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List attribute names",
"description": "Lists the attribute names of an attribute.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute name",
"description": "Updates the attribute name in the specified language. The language code and attribute name must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"lang",
"name"
],
"properties": {
"attributeId": {
"type": "integer",
"description": "The id of the attribute. optional"
},
"lang": {
"type": "string",
"description": "The language of the attribute."
},
"name": {
"type": "string",
"description": "The name of the attribute. This attribute name is displayed in the online store."
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/value_market_names": {
"get": {
"summary": "Search attribute value market names",
"description": "Searches the delete log.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of AttributeValueMarketName",
"items": {
"$ref": "#\/definitions\/AttributeValueMarketName"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "referenceType",
"type": "string",
"required": false,
"description": "",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an attribute value market name",
"description": "Creates an attribute value market name.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueMarketName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/value_market_names",
"schema": {
"type": "object",
"required": [
"attributeId",
"valueId",
"lang",
"name",
"referenceType"
],
"properties": {
"attributeId": {
"type": "integer",
"description": ""
},
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value."
},
"lang": {
"type": "string",
"description": "The language of the attribute value market."
},
"name": {
"type": "string",
"description": "The name of the attribute value market."
},
"name2": {
"type": "string",
"description": "The name2 of the attribute value market. optional"
},
"referenceType": {
"type": "string",
"description": "allowed values are amazon"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/value_market_names\/{valueId}\/{lang}\/{referenceType}": {
"delete": {
"summary": "Delete an attribute value market name",
"description": "Deletes an attribute value market name. The attribute value ID and language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "referenceType",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute value market name",
"description": "Updates an attribute value market name. The attribute value ID and language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueMarketName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "referenceType",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/value_market_names\/{valueId}\/{lang}\/{referenceType}",
"schema": {
"type": "object",
"required": [
"attributeId",
"valueId",
"lang",
"name",
"referenceType"
],
"properties": {
"attributeId": {
"type": "integer",
"description": ""
},
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value."
},
"lang": {
"type": "string",
"description": "The language of the attribute value market."
},
"name": {
"type": "string",
"description": "The name of the attribute value market."
},
"name2": {
"type": "string",
"description": "The name2 of the attribute value market. optional"
},
"referenceType": {
"type": "string",
"description": "allowed values are amazon"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/values": {
"get": {
"summary": "List attribute values",
"description": "Lists the attribute values for an attribute. The attribute ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of AttributeValue",
"items": {
"$ref": "#\/definitions\/AttributeValue"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified attribute value information in the results. The following parameters are available:
- attribute = The attribute of the value<\/li>
- names = The attribute value names in all languages<\/li>
- marketNames = The market attribute value links (amazon only)<\/li>
- valueMaps = The market attribute value links (amazon excluded)<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an attribute value",
"description": "Creates an attribute value.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/values",
"schema": {
"type": "object",
"required": [
"attributeId",
"backendName"
],
"properties": {
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute associated with the attribute value."
},
"backendName": {
"type": "string",
"description": "The back end name of the attribute value. This name can only be assigned once per attribute. It is not visible in the plentymarkets front end."
},
"position": {
"type": "integer",
"description": "The position of the attribute value. Attribute values are sorted in ascending order by position. optional"
},
"image": {
"type": "string",
"description": "The name of the image associated with the attribute value; naming pattern is attr\\_\\{valueId\\}. optional"
},
"comment": {
"type": "string",
"description": "Optional comment on the attribute value. Comments are not visible in the plentymarkets front end. optional"
},
"amazonValue": {
"type": "string",
"description": "The attribute value of the market Amazon that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the values specified by the market. Check documentation of the market for permitted values. optional"
},
"ottoValue": {
"type": "string",
"description": "The attribute value of the market OTTO that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. optional"
},
"neckermannAtEpValue": {
"type": "string",
"description": "The attribute value of the market Neckermann AT EP that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. optional"
},
"laRedouteValue": {
"type": "string",
"description": "The attribute value of the market La Redoute that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. optional"
},
"tracdelightValue": {
"type": "string",
"description": "optional"
},
"percentageDistribution": {
"type": "integer",
"description": "The percentage for automatic stock distribution of attribute values. When reordering an item, the quantities of attribute values is automatically distributed among the total quantity. optional"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/values\/{attributeValueId}\/markets\/{marketId}\/maps": {
"delete": {
"summary": "Deletes an attribute value map.",
"description": "Deletes an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "attributeValueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets an attribute value map.",
"description": "Gets an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "attributeValueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Updates an attribute value map.",
"description": "Updates an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueMap"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "attributeValueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/attributes\/{attributeId}\/values\/{id}": {
"delete": {
"summary": "Delete an attribute value",
"description": "Deletes an attribute value. The attribute ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an attribute value",
"description": "Get an attribute value. The ID of the attribute value must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified attribute value information in the results. The following parameters are available:
- attribute = The attribute of the value<\/li>
- names = The attribute value names in all languages<\/li>
- marketNames = The market attribute value links (amazon only)<\/li>
- valueMaps = The market attribute links (amazon excluded)<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute value",
"description": "Updates an attribute value. The attribute value must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{attributeId}\/values\/{id}",
"schema": {
"type": "object",
"required": [
"attributeId",
"backendName"
],
"properties": {
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute associated with the attribute value."
},
"backendName": {
"type": "string",
"description": "The back end name of the attribute value. This name can only be assigned once per attribute. It is not visible in the plentymarkets front end."
},
"position": {
"type": "integer",
"description": "The position of the attribute value. Attribute values are sorted in ascending order by position. optional"
},
"image": {
"type": "string",
"description": "The name of the image associated with the attribute value; naming pattern is attr\\_\\{valueId\\}. optional"
},
"comment": {
"type": "string",
"description": "Optional comment on the attribute value. Comments are not visible in the plentymarkets front end. optional"
},
"amazonValue": {
"type": "string",
"description": "The attribute value of the market Amazon that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the values specified by the market. Check documentation of the market for permitted values. optional"
},
"ottoValue": {
"type": "string",
"description": "The attribute value of the market OTTO that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. optional"
},
"neckermannAtEpValue": {
"type": "string",
"description": "The attribute value of the market Neckermann AT EP that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. optional"
},
"laRedouteValue": {
"type": "string",
"description": "The attribute value of the market La Redoute that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. optional"
},
"tracdelightValue": {
"type": "string",
"description": "optional"
},
"percentageDistribution": {
"type": "integer",
"description": "The percentage for automatic stock distribution of attribute values. When reordering an item, the quantities of attribute values is automatically distributed among the total quantity. optional"
}
}
}
}
]
}
},
"\/rest\/items\/attributes\/{id}": {
"delete": {
"summary": "Delete an attribute",
"description": "Deletes an attribute. The ID of the attribute must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an attribute",
"description": "Gets an attribute. The ID of the attribute must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Attribute"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified attribute information in the results. The following parameters are available:
- names<\/b> = The names of the attribute<\/li>
- values<\/b> = The values of the attribute<\/li>
- maps<\/b> = The market maps of the attribute<\/li><\/ul> More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute",
"description": "Updates an attribute. The ID of the attribute must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Attribute"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/attributes\/{id}",
"schema": {
"type": "object",
"properties": {
"backendName": {
"type": "string",
"description": "The back end name of the attribute. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. optional"
},
"position": {
"type": "integer",
"description": "The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position. optional"
},
"isSurchargePercental": {
"type": "boolean",
"description": "Flag that indicates if the surcharge is percental. optional"
},
"isLinkableToImage": {
"type": "boolean",
"description": "Flag that indicates if an image can be linked to the attribute. optional"
},
"amazonAttribute": {
"type": "string",
"description": "The attribute of the market Amazon that this attribute is liked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"fruugoAttribute": {
"type": "string",
"description": "The attribute of the market Fruugo that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are null, color, size"
},
"pixmaniaAttribute": {
"type": "integer",
"description": "The attribute of the market PIXmania that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"ottoAttribute": {
"type": "string",
"description": "The attribute of the market OTTO that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are none, Dimension1, Dimension2, Dimension3, Dimension4"
},
"googleShoppingAttribute": {
"type": "string",
"description": "The attribute of the market Google Shopping that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. optional allowed values are none, size, color, material, pattern"
},
"neckermannAtEpAttribute": {
"type": "integer",
"description": "The component of the market neckermann AT EP that this attribute is linked to. To list variations on this market, attributes must be linked to one of the components specified by the market. Check documentation of the market for permitted values. optional"
},
"typeOfSelectionInOnlineStore": {
"type": "string",
"description": "How customers can select the attribute in the front end of a client. To allow attribute selection by check mark, attribute availability must be checked on the client side. optional allowed values are dropdown, image, box"
},
"laRedouteAttribute": {
"type": "integer",
"description": "The attribute of the market La Redoute that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. optional"
},
"isGroupable": {
"type": "boolean",
"description": "Flag that indicates if the attribute can be grouped in item lists. If yes, variations with this attribute can be shown in the ItemViewCategoriesList template first. Other attributes are nested and can only be selected after this attribute has been selected. optional"
}
}
}
}
]
}
},
"\/rest\/items\/barcodes": {
"get": {
"summary": "List barcodes",
"description": "Lists all barcodes.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Barcode",
"items": {
"$ref": "#\/definitions\/Barcode"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a barcode",
"description": "Creates a barcode.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Barcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/barcodes",
"schema": {
"type": "object",
"required": [
"name",
"type",
"referrerId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the barcode"
},
"type": {
"type": "string",
"description": "The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC allowed values are GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC"
},
"referrers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/BarcodeLinkReferrer"
}
},
"referrerId": {
"type": "number",
"description": "The unique ID of the referrer. To activate all referrers, the value -1 must be specified. This value activates all referrers in the system by default, including any referrers added at a later stage."
}
}
}
}
]
}
},
"\/rest\/items\/barcodes\/referrer\/{referrerId}": {
"get": {
"summary": "List barcodes by referrer",
"description": "Lists barcodes linked to the specified referrer. The ID of the referrer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Barcode"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "referrerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/barcodes\/type\/{type}": {
"get": {
"summary": "List barcodes by type",
"description": "Lists all barcodes of a specific type. The type must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Barcode"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "type",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/barcodes\/{barcodeId}": {
"delete": {
"summary": "Delete a barcode",
"description": "Deletes a barcode. The ID of the barcode must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a barcode",
"description": "Gets a barcode. The ID of the barcode must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Barcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a barcode",
"description": "Updates a barcode. The ID of the barcode must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Barcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/barcodes\/{barcodeId}",
"schema": {
"type": "object",
"required": [
"name",
"type",
"referrerId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the barcode"
},
"type": {
"type": "string",
"description": "The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC allowed values are GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC"
},
"referrers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/BarcodeLinkReferrer"
}
},
"referrerId": {
"type": "number",
"description": "The unique ID of the referrer. To activate all referrers, the value -1 must be specified. This value activates all referrers in the system by default, including any referrers added at a later stage."
}
}
}
}
]
}
},
"\/rest\/items\/barcodes\/{barcodeId}\/referrer": {
"post": {
"summary": "Activate a referrer",
"description": "Activate a referrer for a barcode.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/BarcodeLinkReferrer"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/barcodes\/{barcodeId}\/referrer\/{referrerId}": {
"delete": {
"summary": "Deactivate a referrer",
"description": "Deactivate a referrer for a barcode. The ID of the barcode and the ID of the referrer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "referrerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/item_shipping_profiles": {
"get": {
"summary": "List all shipping profiles of all items",
"description": "Lists all shipping profiles of all items. Results can be filtered by the timestamp of the link between items and shipping profiles (eq, lt, lte, gt, gte, between).\n
\n- eq = Equal to<\/li>\n
- gte = Greater than or equal to<\/li>\n
- gt = Greater than<\/li>\n
- lte = Less than or equal to<\/li>\n
- lt = Less than<\/li>\n
- between = Date range<\/li>\n<\/ul>\nExample: updated=gt:2018-04-16 16:00:00 returns all items with shipping profiles that were activated after 4pm on the 16th of April 2018.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Bulk activate shipping profiles",
"description": "Activates up to 50 shipping profiles for items",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/items\/labels": {
"get": {
"summary": "List item label templates",
"description": "Lists the ID and name of all item label templates saved in the system.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/items\/manufacturers": {
"get": {
"summary": "List manufacturers",
"description": "Lists all manufacturers in the system.\n\nDisplay a listing of the resource.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Manufacturer",
"items": {
"$ref": "#\/definitions\/Manufacturer"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified manufacturer information in the results. The following parameters are available: commissions, externals",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to records updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to records with specified name.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a manufacturer",
"description": "Creates a manufacturer.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Manufacturer"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/items\/manufacturers\/{id}": {
"delete": {
"summary": "Delete a manufacturer",
"description": "Deletes a manufacturer. The ID of the manufacturer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a manufacturer",
"description": "Gets a manufacturer. The ID of the manufacturer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Manufacturer"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a manufacturer",
"description": "Updates a manufacturer. The ID of the manufacturer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Manufacturer"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/manufacturers\/{id}\/commissions": {
"get": {
"summary": "List commissions",
"description": "Lists all commissions associated with a manufacturer. The ID of the manufacturer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ManufacturerCommission"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a commission",
"description": "Creates a commission for a manufacturer. The ID of the manufacturer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ManufacturerCommission"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/manufacturers\/{id}\/commissions\/{manufacturerId}": {
"delete": {
"summary": "Delete a commission",
"description": "Delete a commission. The ID of the commission must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "manufacturerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a commission",
"description": "Gets a commission for a manufacturer. The ID of the commission must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ManufacturerCommission"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "manufacturerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a commission",
"description": "Updates a commission. The ID of the commission must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ManufacturerCommission"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "manufacturerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/packing_units": {
"get": {
"summary": "Get the item variation packing units",
"description": "Returns the packing units for the item variations based on the language wanted",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PackingUnit"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "language",
"type": "string",
"required": false,
"description": "The language to return the unit name for. If no language is provided, all the languages will be returned",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/items\/packing_units\/{id}": {
"get": {
"summary": "Get the item variation packing unit for a specific given id",
"description": "Returns the packing unit for the item variations based on the given ID, the language wanted and the flag to say if the ID provided is the a unit ID",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PackingUnit"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the packing unit",
"format": "integer",
"in": "path"
},
{
"name": "language",
"type": "string",
"required": false,
"description": "The language to return the unit name for. If no language is provided, all the languages will be returned",
"format": "string",
"in": "query"
},
{
"name": "isUnitId",
"type": "boolean",
"required": false,
"description": "A flag to say if the ID provided is the unit ID or not. If true, the unit ID will be taken into account to get the result",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/items\/properties": {
"get": {
"summary": "List properties",
"description": "Lists all properties.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Property",
"items": {
"$ref": "#\/definitions\/Property"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified property information in the results. The following parameters are available:
- names<\/b> = The names of the property<\/li>
- group<\/b> = The property group assigned to the property<\/li>
- marketComponents<\/b> = Lists the markets where the property is available <\/li>
- selections<\/b> = Lists the selections of the property<\/li><\/ul> More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "groupId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items linked to a specified property group",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Limits the results to a specific page. The page number must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Limits the number of results listed per page to a specific number. The number of properties to be listed per page must be specified.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a property",
"description": "Creates a property.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/properties",
"schema": {
"type": "object",
"required": [
"backendName"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the property optional"
},
"unit": {
"type": "string",
"description": "The unit of measurement of the property. Value is null if no unit is associated. optional"
},
"propertyGroupId": {
"type": "integer",
"description": "The ID of the property group the property is assigned to. Value is null if property is not assigned to a property group. optional"
},
"backendName": {
"type": "string",
"description": "The backend name of the property. The back end name is not visible to customers."
},
"valueType": {
"type": "string",
"description": "Permitted property values are: empty = No property typeint = A whole number can be saved for an item, e.g. a size.float = A number with decimal places can be saved for an item, e.g. a measurement.selection = One of several options can be saved for the item. The values of the property value Selection can be managed using the route PropertySelection.text = Text can be saved for an item.file = A file can be saved for an item. optional allowed values are empty, int, float, selection, text, file"
},
"isSearchable": {
"type": "boolean",
"description": "Flag that indicates if items can be found by entering the property name as a search term. optional"
},
"isOderProperty": {
"type": "boolean",
"description": "Flag that indicates if the property is available in the order process. Depending on the property type, customers e.g. can enter a text or value or select an option from a drop-down list. optional"
},
"isShownOnItemPage": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown on the item's page in the online store- optional"
},
"isShownOnItemList": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in the item listing in the online store. optional"
},
"isShownAtCheckout": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in the order process. optional"
},
"isShownInPdf": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in PDF documents. optional"
},
"isShownAsAdditionalCosts": {
"type": "boolean",
"description": "Display as additional costs optional"
},
"comment": {
"type": "string",
"description": "Internal comment\/note saved for the property. Internal comments are not visible to customers. optional"
},
"surcharge": {
"type": "number",
"description": "The surcharge for the property. Surcharges will automatically be added to the item price in the detailed view of an item and in the order process. The default value is 0.00, i.e. no surcharge. In the plentymarkets front end, the template variable PriceDynamic displays the price of a variation including the surcharge. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{id}": {
"delete": {
"summary": "Delete a property",
"description": "Deletes a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property",
"description": "Gets a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property",
"description": "Updates a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{id}",
"schema": {
"type": "object",
"required": [
"backendName"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the property optional"
},
"unit": {
"type": "string",
"description": "The unit of measurement of the property. Value is null if no unit is associated. optional"
},
"propertyGroupId": {
"type": "integer",
"description": "The ID of the property group the property is assigned to. Value is null if property is not assigned to a property group. optional"
},
"backendName": {
"type": "string",
"description": "The backend name of the property. The back end name is not visible to customers."
},
"valueType": {
"type": "string",
"description": "Permitted property values are: empty = No property typeint = A whole number can be saved for an item, e.g. a size.float = A number with decimal places can be saved for an item, e.g. a measurement.selection = One of several options can be saved for the item. The values of the property value Selection can be managed using the route PropertySelection.text = Text can be saved for an item.file = A file can be saved for an item. optional allowed values are empty, int, float, selection, text, file"
},
"isSearchable": {
"type": "boolean",
"description": "Flag that indicates if items can be found by entering the property name as a search term. optional"
},
"isOderProperty": {
"type": "boolean",
"description": "Flag that indicates if the property is available in the order process. Depending on the property type, customers e.g. can enter a text or value or select an option from a drop-down list. optional"
},
"isShownOnItemPage": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown on the item's page in the online store- optional"
},
"isShownOnItemList": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in the item listing in the online store. optional"
},
"isShownAtCheckout": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in the order process. optional"
},
"isShownInPdf": {
"type": "boolean",
"description": "Flag that indicates if the property will be shown in PDF documents. optional"
},
"isShownAsAdditionalCosts": {
"type": "boolean",
"description": "Display as additional costs optional"
},
"comment": {
"type": "string",
"description": "Internal comment\/note saved for the property. Internal comments are not visible to customers. optional"
},
"surcharge": {
"type": "number",
"description": "The surcharge for the property. Surcharges will automatically be added to the item price in the detailed view of an item and in the order process. The default value is 0.00, i.e. no surcharge. In the plentymarkets front end, the template variable PriceDynamic displays the price of a variation including the surcharge. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{id}\/market_references": {
"get": {
"summary": "List property market references",
"description": "Lists the property market references of a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyMarketReference"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a property market reference",
"description": "Creates a property market reference.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarketReference"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{id}\/market_references",
"schema": {
"type": "object",
"required": [
"componentId",
"marketId"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property optional"
},
"componentId": {
"type": "integer",
"description": "The unique ID of the reference for the market"
},
"marketId": {
"type": "number",
"description": "The unique ID of the market"
},
"externalComponent": {
"type": "string",
"description": "The external reference of the property optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{id}\/market_references\/{marketId}": {
"delete": {
"summary": "Delete a property market reference",
"description": "Deletes a property market reference. The ID of the property and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property market reference",
"description": "Gets a property market reference. The market ID and the property ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarketReference"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property market reference",
"description": "Updates a property market reference.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarketReference"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{id}\/market_references\/{marketId}",
"schema": {
"type": "object",
"required": [
"componentId",
"marketId"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property optional"
},
"componentId": {
"type": "integer",
"description": "The unique ID of the reference for the market"
},
"marketId": {
"type": "number",
"description": "The unique ID of the market"
},
"externalComponent": {
"type": "string",
"description": "The external reference of the property optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{id}\/names": {
"get": {
"summary": "List the property names",
"description": "Lists the names of a property in all languages. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a property name",
"description": "Creates a property name. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{id}\/names",
"schema": {
"type": "object",
"required": [
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property optional"
},
"lang": {
"type": "string",
"description": "The language code of the property name"
},
"name": {
"type": "string",
"description": "The name of the property. The property name is displayed in the online store."
},
"description": {
"type": "string",
"description": "The description of the property. The property description is displayed in the online store. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{id}\/names\/{lang}": {
"delete": {
"summary": "Delete a property name",
"description": "Deletes a property name. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property name",
"description": "Gets a property name in a specified language. The ID of the property and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property name",
"description": "Updates a property name. The ID of the property and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{id}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property optional"
},
"lang": {
"type": "string",
"description": "The language code of the property name"
},
"name": {
"type": "string",
"description": "The name of the property. The property name is displayed in the online store."
},
"description": {
"type": "string",
"description": "The description of the property. The property description is displayed in the online store. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{propertyId}\/selections": {
"get": {
"summary": "List property selections",
"description": "Lists the property selections of a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertySelection"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a property selection",
"description": "Creates a property selection.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{propertyId}\/selections",
"schema": {
"type": "object",
"required": [
"propertyId",
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"lang": {
"type": "string",
"description": "The code of the language for which name and description of the selection were saved."
},
"name": {
"type": "string",
"description": "The name of the selection. The name is displayed in the online store."
},
"description": {
"type": "string",
"description": "The description of the selection. This description is displayed in the online store. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{propertyId}\/selections\/{id}": {
"delete": {
"summary": "Delete a property selection",
"description": "Deletes a property selection. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property selection",
"description": "Gets a property selection of a property.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertySelection"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Creates a property selection lang",
"description": "Creates a property selection lang.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{propertyId}\/selections\/{id}",
"schema": {
"type": "object",
"required": [
"propertyId",
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"lang": {
"type": "string",
"description": "The code of the language for which name and description of the selection were saved."
},
"name": {
"type": "string",
"description": "The name of the selection. The name is displayed in the online store."
},
"description": {
"type": "string",
"description": "The description of the selection. This description is displayed in the online store. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{propertyId}\/selections\/{id}\/{lang}": {
"delete": {
"summary": "Delete a property selection language",
"description": "Deletes a property selection language. The ID of the selection and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List property selections by language",
"description": "Lists the property selections of a property for a specific language. The ID and language of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property selection",
"description": "Updates a property selection.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/properties\/{propertyId}\/selections\/{id}\/{lang}",
"schema": {
"type": "object",
"required": [
"propertyId",
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"lang": {
"type": "string",
"description": "The code of the language for which name and description of the selection were saved."
},
"name": {
"type": "string",
"description": "The name of the selection. The name is displayed in the online store."
},
"description": {
"type": "string",
"description": "The description of the selection. This description is displayed in the online store. optional"
}
}
}
}
]
}
},
"\/rest\/items\/properties\/{propertyId}\/selections\/{lang}": {
"get": {
"summary": "List property selections",
"description": "Lists the property selections of a property. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertySelection"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/property_groups": {
"get": {
"summary": "List property groups",
"description": "Lists the property groups.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of PropertyGroup",
"items": {
"$ref": "#\/definitions\/PropertyGroup"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified property group information in the results. The following parameters are available:
- names<\/b> = The names of the property group<\/li>
- properties<\/b> = The properties that are assigned to the property group<\/li><\/ul> More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a property group",
"description": "Creates a property group.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/property_groups",
"schema": {
"type": "object",
"required": [
"backendName"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the property group optional"
},
"backendName": {
"type": "string",
"description": "The back end name of the property group. This name is not visible to customers."
},
"orderPropertyGroupingType": {
"type": "string",
"description": "Indicates how order properties are grouped for selection in the order process. This parameter is applicable to order properties of the type None only.none = Order properties are not grouped.single = One of the grouped order properties can be selected from the drop-down list.multi = Multiple order properties can be selected. optional allowed values are none, single, multi"
},
"isSurchargePercental": {
"type": "boolean",
"description": "Flag that indicates if surcharge values are calculated in percent. optional"
},
"ottoComponentId": {
"type": "integer",
"description": "optional"
},
"updatedAt": {
"type": "string",
"description": "The time the property group was last updated. optional"
}
}
}
}
]
}
},
"\/rest\/items\/property_groups\/{id}": {
"delete": {
"summary": "Delete a property group",
"description": "Deletes a property group. The ID of the property group must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property group",
"description": "Gets a property group. The ID of the property group must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property group",
"description": "Updates an existing property group.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/property_groups\/{id}",
"schema": {
"type": "object",
"required": [
"backendName"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the property group optional"
},
"backendName": {
"type": "string",
"description": "The back end name of the property group. This name is not visible to customers."
},
"orderPropertyGroupingType": {
"type": "string",
"description": "Indicates how order properties are grouped for selection in the order process. This parameter is applicable to order properties of the type None only.none = Order properties are not grouped.single = One of the grouped order properties can be selected from the drop-down list.multi = Multiple order properties can be selected. optional allowed values are none, single, multi"
},
"isSurchargePercental": {
"type": "boolean",
"description": "Flag that indicates if surcharge values are calculated in percent. optional"
},
"ottoComponentId": {
"type": "integer",
"description": "optional"
},
"updatedAt": {
"type": "string",
"description": "The time the property group was last updated. optional"
}
}
}
}
]
}
},
"\/rest\/items\/property_groups\/{id}\/names": {
"get": {
"summary": "List the property group names of a property group",
"description": "Lists the property group names of a property group in all languages. The ID of the property group must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyGroupName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a property group name",
"description": "Creates a property group name. The ID of the property group must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/property_groups\/{id}\/names",
"schema": {
"type": "object",
"required": [
"propertyGroupId",
"lang",
"name"
],
"properties": {
"propertyGroupId": {
"type": "integer",
"description": ""
},
"lang": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": "optional"
}
}
}
}
]
}
},
"\/rest\/items\/property_groups\/{id}\/names\/{lang}": {
"delete": {
"summary": "Delete a property group name",
"description": "Deletes a property group name. The ID of the property group must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property group name in a language",
"description": "Gets a property group name in the specified language. The ID of the property group name and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property group name",
"description": "Updates a property group name. The ID of the property group and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/property_groups\/{id}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"propertyGroupId",
"lang",
"name"
],
"properties": {
"propertyGroupId": {
"type": "integer",
"description": ""
},
"lang": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": "optional"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices": {
"get": {
"summary": "List sales prices",
"description": "Lists all sales prices.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of SalesPrice",
"items": {
"$ref": "#\/definitions\/SalesPrice"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a sales price",
"description": "Creates a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/sales_prices",
"schema": {
"type": "object",
"required": [
"position",
"minimumOrderQuantity",
"type",
"isCustomerPrice",
"isDisplayedByDefault",
"isLiveConversion",
"names",
"lang",
"nameInternal",
"nameExternal",
"countries",
"countryId",
"currencies",
"currency",
"customerClasses",
"referrers",
"referrerId",
"clients",
"plentyId",
"accountId"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the sales price"
},
"minimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity of the sales price. Sales prices with different minimum quantities can be used to create a quantity based graduation of prices in plentymarkets."
},
"type": {
"type": "string",
"description": "The price type of the sales price.RRP = Sales price is the recommended retail price (RRP). If the RRP and another sales price are linked with a variation, the RRP will be displayed in the online store as red strike-through text next to the sales price.Special offer = Sales price as a special offer. Special offers are used for markets, e.g. Amazon and Hitmeister. allowed values are default, rrp, specialOffer, subscription"
},
"isCustomerPrice": {
"type": "boolean",
"description": "Flag that indicates if the sales price is a customer price. Currently, this setting is not in use."
},
"isDisplayedByDefault": {
"type": "boolean",
"description": "Flag that indicates if the sales price is displayed automatically in the Sales Prices area of the plentymarkets backend when a new item is created. When false, the sales price can still be added manually when a new item is created."
},
"isLiveConversion": {
"type": "boolean",
"description": "Flag that indicates if the sales price is converted live in the online store. When true, the default currency price will be converted into the active currencies based on the conversion rates saved in plentymarkets."
},
"interval": {
"type": "string",
"description": "The interval of the price. Possible values are: daily, weekly, monthly, quarterly, semi-annual and annual. optional allowed values are none, daily, weekly, monthly, quarterly, semi-annual, annual"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceName"
}
},
"lang": {
"type": "string",
"description": "The language code of the sales price name"
},
"nameInternal": {
"type": "string",
"description": "The internal name of the sales price. The internal name is used in the plentymarkets back end only."
},
"nameExternal": {
"type": "string",
"description": "The external name of the sales price. The external name is displayed in the online store and as such is visible for customers."
},
"countries": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCountry"
}
},
"countryId": {
"type": "integer",
"description": "The unique ID of the country"
},
"currencies": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCurrency"
}
},
"currency": {
"type": "string",
"description": "The ISO code of the currency; -1 = all currencies."
},
"customerClasses": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCustomerClass"
}
},
"referrers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceReferrer"
}
},
"referrerId": {
"type": "integer",
"description": "The ID of the referrer linked to the sales price"
},
"clients": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceOnlineStore"
}
},
"plentyId": {
"type": "integer",
"description": "The unique ID of the client (store)"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceAccount"
}
},
"accountId": {
"type": "integer",
"description": "The ID of the referrer account linked to the sales price"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}": {
"delete": {
"summary": "Delete a sales price",
"description": "Deletes a sales price. The ID of the sales price must be specified.\n\nDelete salesPrice",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a sales price",
"description": "Gets the data for a specific sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a sales price",
"description": "Updates a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}",
"schema": {
"type": "object",
"required": [
"position",
"minimumOrderQuantity",
"type",
"isCustomerPrice",
"isDisplayedByDefault",
"isLiveConversion",
"names",
"lang",
"nameInternal",
"nameExternal",
"countries",
"countryId",
"currencies",
"currency",
"customerClasses",
"referrers",
"referrerId",
"clients",
"plentyId",
"accountId"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the sales price"
},
"minimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity of the sales price. Sales prices with different minimum quantities can be used to create a quantity based graduation of prices in plentymarkets."
},
"type": {
"type": "string",
"description": "The price type of the sales price.RRP = Sales price is the recommended retail price (RRP). If the RRP and another sales price are linked with a variation, the RRP will be displayed in the online store as red strike-through text next to the sales price.Special offer = Sales price as a special offer. Special offers are used for markets, e.g. Amazon and Hitmeister. allowed values are default, rrp, specialOffer, subscription"
},
"isCustomerPrice": {
"type": "boolean",
"description": "Flag that indicates if the sales price is a customer price. Currently, this setting is not in use."
},
"isDisplayedByDefault": {
"type": "boolean",
"description": "Flag that indicates if the sales price is displayed automatically in the Sales Prices area of the plentymarkets backend when a new item is created. When false, the sales price can still be added manually when a new item is created."
},
"isLiveConversion": {
"type": "boolean",
"description": "Flag that indicates if the sales price is converted live in the online store. When true, the default currency price will be converted into the active currencies based on the conversion rates saved in plentymarkets."
},
"interval": {
"type": "string",
"description": "The interval of the price. Possible values are: daily, weekly, monthly, quarterly, semi-annual and annual. optional allowed values are none, daily, weekly, monthly, quarterly, semi-annual, annual"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceName"
}
},
"lang": {
"type": "string",
"description": "The language code of the sales price name"
},
"nameInternal": {
"type": "string",
"description": "The internal name of the sales price. The internal name is used in the plentymarkets back end only."
},
"nameExternal": {
"type": "string",
"description": "The external name of the sales price. The external name is displayed in the online store and as such is visible for customers."
},
"countries": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCountry"
}
},
"countryId": {
"type": "integer",
"description": "The unique ID of the country"
},
"currencies": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCurrency"
}
},
"currency": {
"type": "string",
"description": "The ISO code of the currency; -1 = all currencies."
},
"customerClasses": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCustomerClass"
}
},
"referrers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceReferrer"
}
},
"referrerId": {
"type": "integer",
"description": "The ID of the referrer linked to the sales price"
},
"clients": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceOnlineStore"
}
},
"plentyId": {
"type": "integer",
"description": "The unique ID of the client (store)"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceAccount"
}
},
"accountId": {
"type": "integer",
"description": "The ID of the referrer account linked to the sales price"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/accounts": {
"get": {
"summary": "List referrer accounts",
"description": "Lists all activated referrer accounts of a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceAccount"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a referrer account",
"description": "Activates a referrer account for a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceAccount"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/accounts",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"referrerId",
"accountId"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"referrerId": {
"type": "integer",
"description": "The ID of the referrer linked to the sales price"
},
"accountId": {
"type": "integer",
"description": "The ID of the referrer account linked to the sales price"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/accounts\/{accountType}\/{accountId}": {
"delete": {
"summary": "Deactivate a referrer account",
"description": "Deactivates a referrer account for a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "accountType",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "accountId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/countries": {
"get": {
"summary": "List countries by sales price",
"description": "Lists active countries for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCountry"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a country",
"description": "Activates a country for a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceCountry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/countries",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"countryId"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"countryId": {
"type": "integer",
"description": "The unique ID of the country"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/countries\/{countryId}": {
"delete": {
"summary": "Deactivate a country",
"description": "Deactivates a country for a sales price.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/currencies": {
"get": {
"summary": "List activated currencies",
"description": "List all currencies activated for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCurrency"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a currency",
"description": "Activates a currency for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceCurrency"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/currencies",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"currency"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"currency": {
"type": "string",
"description": "The ISO code of the currency; -1 = all currencies."
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/currencies\/{currency}": {
"delete": {
"summary": "Deactivate a currency",
"description": "Deactivate a currency for a sales price. The ID of the sales price and the ISO code of the currency must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "currency",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/customer_classes": {
"get": {
"summary": "List activated customer classes",
"description": "Lists the activated customer classes for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceCustomerClass"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a customer class",
"description": "Activates a customer class for a sales price. The ID of the sales price and the ID of the customer class must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceCustomerClass"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/customer_classes",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"customerClassId"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"customerClassId": {
"type": "integer",
"description": "The unique ID of the customer class"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/customer_classes\/{customerClassId}": {
"delete": {
"summary": "Activate a customer class",
"description": "Activates a customer class for a sales price. The ID of the sales price and the ID of the customer class must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "customerClassId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/names": {
"get": {
"summary": "List names of a sales price",
"description": "Lists the names of a sales price in all languages. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a sales price name",
"description": "Creates a name for a sales price in the specified language. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/names",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"lang",
"nameInternal",
"nameExternal"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"lang": {
"type": "string",
"description": "The language code of the sales price name"
},
"nameInternal": {
"type": "string",
"description": "The internal name of the sales price. The internal name is used in the plentymarkets back end only."
},
"nameExternal": {
"type": "string",
"description": "The external name of the sales price. The external name is displayed in the online store and as such is visible for customers."
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/names\/{lang}": {
"delete": {
"summary": "Delete a sales price name",
"description": "Deletes the name of a sales price in the specified language. The ID of the sales price and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets a sales price name",
"description": "Gets the sales price name of a sales price in the specified langauge. The ID of the sales price and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a sales price name",
"description": "Updates a sales price name in the specified language. The ID of the sales price and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"lang",
"nameInternal",
"nameExternal"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"lang": {
"type": "string",
"description": "The language code of the sales price name"
},
"nameInternal": {
"type": "string",
"description": "The internal name of the sales price. The internal name is used in the plentymarkets back end only."
},
"nameExternal": {
"type": "string",
"description": "The external name of the sales price. The external name is displayed in the online store and as such is visible for customers."
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/online_stores": {
"get": {
"summary": "List activated clients (stores)",
"description": "Lists all activated clients (stores) for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceOnlineStore"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a client (store)",
"description": "Activates a client (store) for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceOnlineStore"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/online_stores",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"plentyId"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"plentyId": {
"type": "integer",
"description": "The unique ID of the client (store)"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/online_stores\/{webstoreId}": {
"delete": {
"summary": "Deactivate a client (store)",
"description": "Deactivates a client (store) for a sales price. The ID of the sales price and the ID of the client (store) must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "webstoreId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/referrers": {
"get": {
"summary": "List activated referrers",
"description": "Lists all activated referrers for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SalesPriceReferrer"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a referrer",
"description": "Activates a referrer for a sales price. The ID of the sales price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SalesPriceReferrer"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/sales_prices\/{id}\/referrers",
"schema": {
"type": "object",
"required": [
"salesPriceId",
"referrerId"
],
"properties": {
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"referrerId": {
"type": "number",
"description": "The unique ID of the referrer"
}
}
}
}
]
}
},
"\/rest\/items\/sales_prices\/{id}\/referrers\/{referrerId}": {
"delete": {
"summary": "Deactivates a referrer",
"description": "Deactivates a referrer for a sales price. The ID of the sales price and the ID of the referrer must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "referrerId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/units": {
"get": {
"summary": "List units",
"description": "Lists all units.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Unit",
"items": {
"$ref": "#\/definitions\/Unit"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a unit",
"description": "Creates a unit.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Unit"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/units",
"schema": {
"type": "object",
"required": [
"unitOfMeasurement",
"isDecimalPlacesAllowed"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the unit optional"
},
"unitOfMeasurement": {
"type": "string",
"description": "The International System of Units (ISO) code of the unit"
},
"isDecimalPlacesAllowed": {
"type": "boolean",
"description": "Flag that indicates if decimal places are allowed for this unit of measurement. If false, only integer values are allowed for the unit."
}
}
}
}
]
}
},
"\/rest\/items\/units\/{id}": {
"delete": {
"summary": "Delete a unit",
"description": "Deletes a unit. The ID of the unit must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a unit",
"description": "Gets a unit. The ID of the unit must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Unit"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a unit",
"description": "Updates a unit. The ID of the unit must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Unit"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/units\/{id}",
"schema": {
"type": "object",
"required": [
"unitOfMeasurement",
"isDecimalPlacesAllowed"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the unit optional"
},
"unitOfMeasurement": {
"type": "string",
"description": "The International System of Units (ISO) code of the unit"
},
"isDecimalPlacesAllowed": {
"type": "boolean",
"description": "Flag that indicates if decimal places are allowed for this unit of measurement. If false, only integer values are allowed for the unit."
}
}
}
}
]
}
},
"\/rest\/items\/units\/{id}\/names": {
"get": {
"summary": "List unit names",
"description": "Lists the unit names of a unit. The ID of the unit must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/UnitName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a unit name",
"description": "Creates a unit name. The ID of the unit and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/UnitName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/units\/{id}\/names\/{lang}": {
"delete": {
"summary": "Delete a unit name",
"description": "Deletes a unit name. The ID of the unit and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a unit name",
"description": "Gets a unit name. The ID of the unit and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/UnitName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a unit name",
"description": "Updates a unit name. The ID of the unit and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/UnitName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/variations": {
"get": {
"summary": "Search variations",
"description": "Search variations by different filters",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Variation",
"items": {
"$ref": "#\/definitions\/Variation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified variation information in the results. The following parameters are available:
- properties<\/b> = The properties linked to the variation<\/li>
- variationProperties<\/b> = The properties linked to the variation<\/li>
- variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li>
- variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li>
- variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li>
- variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li>
- marketItemNumbers<\/b> = The market ident number of the variation<\/li>
- variationCategories<\/b> = The categories linked to the variation<\/li>
- variationClients<\/b> = The clients (stores) for which the variation is activated<\/li>
- variationMarkets<\/b> = The markets for which the variation is activated <\/li>
- variationDefaultCategory<\/b> = The default category of the variation<\/li>
- variationSuppliers<\/b> = The supplier data associated with the variation<\/li>
- variationWarehouses<\/b> = The warehouse data associated with the variation<\/li>
- images<\/b> = The images linked to the variation<\/li>
- itemImages<\/b> = The images linked to the item<\/li>
- variationAttributeValues<\/b> = The attribute values of the variation<\/li>
- variationSkus<\/b> = The SKU data associated with the variation<\/li>
- variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li>
- unit<\/b> = The unit assigned to the variation<\/li>
- parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li>
- item<\/b> = The item of the variation<\/li>
- stock<\/b> = The stock data of the variation<\/li><\/ul> For example, specifying the parameters variationCategories and variationDefaultCategory will include the default category and all other categories the variations are linked to. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "The language<\/a> of the variation information.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Limits the results to a specific page. The page number must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Limits the number of results listed per page to a specific number. The number of variations to be listed per page must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified variation ID. An variation ID must be specified. More than one ID should be separated by commas.",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified item ID. An item ID must be specified. More than one ID should be separated by commas.",
"format": "integer",
"in": "query"
},
{
"name": "variationTagId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified tag ID. An tag ID must be specified. More than one ID should be separated by commas.",
"format": "integer",
"in": "query"
},
{
"name": "itemName",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified item name. An item name must be specified.",
"format": "string",
"in": "query"
},
{
"name": "flagOne",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations of items with the flag one. The flag one must be specified.",
"format": "string",
"in": "query"
},
{
"name": "flagTwo",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations of items with the flag two. The flag two must be specified.",
"format": "string",
"in": "query"
},
{
"name": "storeSpecial",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations of items with the specified store special. The following values are allowed: 0 (None), 1 (Special offer), 2 (New item), 3(Top item).",
"format": "integer",
"in": "query"
},
{
"name": "categoryId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified category id",
"format": "integer",
"in": "query"
},
{
"name": "isMain",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations that are main variations.",
"format": "boolean",
"in": "query"
},
{
"name": "isActive",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations that are active.",
"format": "boolean",
"in": "query"
},
{
"name": "barcode",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified barcode. A barcode must be specified.",
"format": "string",
"in": "query"
},
{
"name": "numberExact",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to the variation with the variation number specified.",
"format": "string",
"in": "query"
},
{
"name": "numberFuzzy",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with numbers that contain the variation number specified (SQL LIKE operator). For example, if variations with variation numbers 1 to 400 exist in the system, filtering by 12 will list variation numbers 12, 112, 120-129, 212 and 312.",
"format": "string",
"in": "query"
},
{
"name": "isBundle",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations to which variations were added to create a bundle.",
"format": "boolean",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations that are visible in specified clients. Separate more than one client by commas.",
"format": "integer",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations that are visible in specified markets. Separate more than one referrer by commas.",
"format": "integer",
"in": "query"
},
{
"name": "supplierNumber",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified supplier number. A supplier number must be specified.",
"format": "string",
"in": "query"
},
{
"name": "sku",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified SKU. In additional, results can also be restricted to a specific referrer by specifying the referrer ID after a colon. Example: L0R3MIP5UM:104.1",
"format": "string",
"in": "query"
},
{
"name": "manufacturerId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified manufacturer ID.",
"format": "integer",
"in": "query"
},
{
"name": "updatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations updated during the specified period. The end date (to) is optional. If no end date is specified, variations updated between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/variations?updatedBetween=1451606400,1456790400 will list variations updated between 2016-01-01 and 2016-03-01. ...\/variations?updatedBetween=1451606400 will list variations updated since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "createdBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations created during the specified period. The end date (to) is optional. If no end date is specified, variations created between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/variations?createdBetween=1451606400,1456790400 will list variations created between 2016-01-01 and 2016-03-01. ...\/variations?createdBetween=1451606400 will list variations created since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "relatedUpdatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to those variations for which related information was updated during the specified period. Related information is defined as information linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. See variationUpdatedBetween for supported formats.",
"format": "string",
"in": "query"
},
{
"name": "itemDescription",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with descriptions that contain the specified string.",
"format": "string",
"in": "query"
},
{
"name": "stockWarehouseId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have physical stock on the given warehouse.",
"format": "string",
"in": "query"
},
{
"name": "supplierId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified supplier ID.",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update up to 50 variations",
"description": "Updates up to 50 variations. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations",
"schema": {
"type": "object",
"required": [
"itemId",
"valueId",
"unit"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the variation. The ID must be unique. optional"
},
"isMain": {
"type": "boolean",
"description": "Flag that indicates if the variation is the main variation of the item. optional"
},
"mainVariationId": {
"type": "integer",
"description": "The variation ID of the item's main variation. Value is NULL if this variation is the item's main variation. optional"
},
"itemId": {
"type": "integer",
"description": "The item ID of the item that this variation belongs to."
},
"position": {
"type": "integer",
"description": "The position of the variation. Value is inherited from the item's main variation if inheritance is active. optional"
},
"isActive": {
"type": "boolean",
"description": "Flag that indicates if the variation is active. Only active variations can be offered in the online store and\/or on markets. optional"
},
"number": {
"type": "string",
"description": "The unique variation number of the variation. The variation number must be specified. optional value must be unique"
},
"model": {
"type": "string",
"description": "The model of the variation. Value is inherited from the item's main variation if inheritance is active. optional"
},
"externalId": {
"type": "string",
"description": "The external variation ID of this variation. The external variation number is optional and allows importing items and variations from external systems to plentymarkets. optional"
},
"availability": {
"type": "integer",
"description": "The availability of the variation. Possible values: 1 to 10, null = Variation inherits value of main variation. optional"
},
"estimatedAvailableAt": {
"type": "string",
"description": "The estimated delivery date of variations on reorder. optional"
},
"purchasePrice": {
"type": "number",
"description": "The net purchase price. Value e.g. is used for price calculations. optional"
},
"movingAveragePrice": {
"type": "number",
"description": "The moving average purchase price of the variation. optional"
},
"createdAt": {
"type": "string",
"description": "The time the variation was created. optional"
},
"updatedAt": {
"type": "string",
"description": "The time the variation was last updated. optional"
},
"relatedUpdatedAt": {
"type": "string",
"description": "The time at which related information for this variation was last updated. Related information is defined as information that is linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. optional"
},
"priceCalculationId": {
"type": "integer",
"description": "The ID of the price calculation linked to the variation. optional"
},
"picking": {
"type": "string",
"description": "The order picking type of the variation. Possible values: single_picking, no_single_picking, exclude_from_picklist, null (no order picking type) optional allowed values are single_picking, no_single_picking, exclude_from_picklist"
},
"stockLimitation": {
"type": "integer",
"description": "The stock limitation for the variation. Possible values: 0 = No limitation, i.e. stock is not limited. The variations's availability is not checked automatically.1 = Stock is limited to net stock. The variation's availability is checked automatically.2 = Do not administer stock for this variation. optional allowed values are 0, 1, 2"
},
"isVisibleIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is visible in the online store if net stock is positive. If true, the variation automatically becomes visible when the net stock changes to positive. optional"
},
"isInvisibleIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is invisible in the online store if net stock is not positive. If true, the variation automatically becomes invisible when the net stock changes to 0 or negative. optional"
},
"isAvailableIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is available in the online store if net stock is positive. If true, the variation automatically becomes available when the net stock changes to positive. optional"
},
"isUnavailableIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is unavailable in the online store if net stock is not positive. If true, the variation automatically becomes available when the net stock changes to 0 or negative. optional"
},
"mainWarehouseId": {
"type": "integer",
"description": "The ID of the main warehouse of the variation. optional"
},
"maximumOrderQuantity": {
"type": "number",
"description": "The maximum order quantity permitted per order. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited. optional"
},
"minimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity. Decimal values are possible to allow orders by weight or length. optional"
},
"intervalOrderQuantity": {
"type": "number",
"description": "The quantity intervals the variation can be ordered in. Decimal values are possible to allow orders by weight or length. optional"
},
"availableUntil": {
"type": "string",
"description": "The last date the item will be available for sale. optional"
},
"releasedAt": {
"type": "string",
"description": "The release date of the variation. This is the date on which the variation will become available. The variation can be visible in the online store before this date, e.g. for preorders. optional"
},
"name": {
"type": "string",
"description": "The name of the variation optional"
},
"weightG": {
"type": "integer",
"description": "The gross weight of the variation in gramms (g). This weight includes the packaging for variations that are packaged separately. This value is used for calculating shipping packages and weight-based shipping costs. optional"
},
"weightNetG": {
"type": "integer",
"description": "The net weight of the variation in gramms (g). This is the weight of the variation without packaging. optional"
},
"widthMM": {
"type": "integer",
"description": "The width of the variation in millimetres (mm) optional"
},
"lengthMM": {
"type": "integer",
"description": "The length of the variation in millimeters (mm) optional"
},
"heightMM": {
"type": "integer",
"description": "The height of the variation in millimetres (mm) optional"
},
"extraShippingCharge1": {
"type": "number",
"description": "The extra shipping charge 1 for the variation. Extra shipping charges are useful for large or bulky items that are particularly expensive to ship. Charge 1 is added to the regular shipping costs for the first item of an order. If different variations are ordered, the extra shipping charge 1 of the variation with the highest charge 1 is selected. optional"
},
"extraShippingCharge2": {
"type": "number",
"description": "The extra shipping charge 2 for the variation. Extra shipping charges are useful for large or bulky items that are expensive to ship. Charge 2 is added to the shipping costs for any additional items of an order. optional"
},
"unitsContained": {
"type": "integer",
"description": "The number of sales units contained in one package. Default value is 1. optional"
},
"palletTypeId": {
"type": "integer",
"description": "The ID of the pallet type optional"
},
"packingUnits": {
"type": "integer",
"description": "The number of packing units if the item consists of multiple packages. Value is 0 if an item is sent as one package. All items of an order that have the value 0 will be packed into one package. optional"
},
"packingUnitTypeId": {
"type": "integer",
"description": "The ID of the packing unit type. optional"
},
"transportationCosts": {
"type": "number",
"description": "The net transportation costs for the variation. This value is used for price calculations and for calculating the acquisition price. optional"
},
"storageCosts": {
"type": "number",
"description": "The net storage costs for the variation optional"
},
"customs": {
"type": "number",
"description": "The customs rate in percent optional"
},
"operatingCosts": {
"type": "number",
"description": "The operating costs for the variation in percent optional"
},
"vatId": {
"type": "integer",
"description": "The ID of the VAT rate of the variation. VAT rates are created for each client (store) and linked to the variation. optional allowed values are 0, 1, 2, 3"
},
"bundleType": {
"type": "string",
"description": "Indicates the bundle type of the variation. Possible values:bundle = The variation is a bundlebundle_item = The variation is a bundle component.Null = The variation is not associated with a bundle optional allowed values are bundle, bundle_item"
},
"automaticClientVisibility": {
"type": "integer",
"description": "Indicates if the variation is set as available for any clients (stores). Possible values:0 \/ -1 (GET) or 0 (POST) = Variation is not available in any client (store).1 \/ 2 (GET) or 1 (POST) = Variation is available in at least one client (store).The variation's actual visibility depends on the settings for net stock dependency. optional allowed values are -1, 0, 1, 2"
},
"isHiddenInCategoryList": {
"type": "boolean",
"description": "Flag that indicates if the variation is hidden in the category list. If true, the variation will not be shown in any item category and will not be returned as a search result. The variation can only be accessed via its URL. optional"
},
"mayShowUnitPrice": {
"type": "boolean",
"description": "Display unit price in the online store optional"
},
"hasCalculatedBundleWeight": {
"type": "boolean",
"description": "Indicates if the gross bundle weight is calculated by its components. optional"
},
"hasCalculatedBundleNetWeight": {
"type": "boolean",
"description": "Indicates if the net bundle weight is calculated by its components. optional"
},
"hasCalculatedBundlePurchasePrice": {
"type": "boolean",
"description": "Indicates if the net purchase price is calculated by its components. optional"
},
"hasCalculatedBundleMovingAveragePrice": {
"type": "boolean",
"description": "Indicates if the moving average net purchase price is calculated by its components. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "The customs tariff number of the variation; usually a 11 digit code number based on the Harmonised System optional"
},
"categoryVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Categories are not inherited from the main variation.ID of the item's main variation = Inheritance of categories is active. optional"
},
"marketVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Markets are not inherited from the main variation.ID of the item's main variation = Inheritance of markets is active. optional"
},
"clientVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Clients (stores) are not inherited from the main variation.ID of the item's main variation = Inheritance of clients (stores) is active. optional"
},
"salesPriceVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Sales prices are not inherited from the main variation.ID of the item's main variation = Inheritance of sales prices is active. optional"
},
"supplierVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Suppliers are not inherited from the main variation.ID of the item's main variation = Inheritance of suppliers is active. optional"
},
"warehouseVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Warehouses are not inherited from the main variation.ID of the item's main variation = Inheritance of warehouses is active. optional"
},
"variationBarcodes": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"variationSalesPrices": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"variationCategories": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"variationClients": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationClient"
}
},
"variationMarkets": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarket"
}
},
"variationDefaultCategory": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
},
"variationSuppliers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"variationWarehouses": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"variationAttributeValues": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AttributeValueSet"
}
},
"valueId": {
"type": "integer",
"description": "The ID of the attribute value"
},
"unit": {
"type": "array",
"items": {
"$ref": "#\/definitions\/UnitCombination"
}
},
"parentVariationId": {
"type": "integer",
"description": "optional"
},
"parentVariationQuantity": {
"type": "number",
"description": "optional"
}
}
}
}
]
}
},
"\/rest\/items\/variations\/variation_categories": {
"post": {
"summary": "Bulk create category links",
"description": "Creates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_categories",
"schema": {
"type": "object",
"required": [
"variationId",
"categoryId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"categoryId": {
"type": "integer",
"description": "The unique ID of the category"
},
"position": {
"type": "integer",
"description": "The position of the category optional"
},
"isNeckermannPrimary": {
"type": "string",
"description": "Flag that indicates if the category is the primary category for the market Neckermann for this variation. optional"
}
}
}
}
]
},
"put": {
"summary": "Bulk update category links",
"description": "Updates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_categories",
"schema": {
"type": "object",
"required": [
"variationId",
"categoryId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"categoryId": {
"type": "integer",
"description": "The unique ID of the category"
},
"position": {
"type": "integer",
"description": "The position of the category optional"
},
"isNeckermannPrimary": {
"type": "string",
"description": "Flag that indicates if the category is the primary category for the market Neckermann for this variation. optional"
}
}
}
}
]
}
},
"\/rest\/items\/variations\/variation_markets": {
"get": {
"summary": "List all links between variations and markets",
"description": "Lists all links between variations and markets.\nResults can be filtered by the ID of the variation and by the ID of the market, e.g. \"variationId=1030\"\nlists all links of the variation with the ID 1030.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of VariationMarket",
"items": {
"$ref": "#\/definitions\/VariationMarket"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create up to 50 links between variations and markets",
"description": "Creates up to 50 links between variations and markets. The ID of the variation and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_markets",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"marketId": {
"type": "integer",
"description": "The unique ID of the market"
}
}
}
}
]
}
},
"\/rest\/items\/variations\/variation_properties": {
"post": {
"summary": "Bulk update properties",
"description": "Creates up to 50 properties of variations.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_properties",
"schema": {
"type": "object",
"required": [
"variationId",
"propertyId",
"lang"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property value optional"
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"propertySelectionId": {
"type": "integer",
"description": "The unique ID of the property selection of the variation optional"
},
"valueInt": {
"type": "integer",
"description": "The int value of the property value of the variation optional"
},
"valueFloat": {
"type": "number",
"description": "The float value of the property value of the variation optional"
},
"valueFile": {
"type": "string",
"description": "The file value of the property value of the variation optional"
},
"valueTexts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
},
"put": {
"summary": "Bulk update properties",
"description": "Updates up to 50 properties of variations.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_properties",
"schema": {
"type": "object",
"required": [
"variationId",
"propertyId",
"lang"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property value optional"
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"propertySelectionId": {
"type": "integer",
"description": "The unique ID of the property selection of the variation optional"
},
"valueInt": {
"type": "integer",
"description": "The int value of the property value of the variation optional"
},
"valueFloat": {
"type": "number",
"description": "The float value of the property value of the variation optional"
},
"valueFile": {
"type": "string",
"description": "The file value of the property value of the variation optional"
},
"valueTexts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
}
},
"\/rest\/items\/variations\/variation_sales_prices": {
"get": {
"summary": "Get all sales price relations",
"description": "Gets all links between variations and sales prices including sales price data.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to the sales price data of a specific variation.",
"format": "integer",
"in": "query"
},
{
"name": "salesPriceId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to the sales price data of variations linked to a specific sales price.",
"format": "integer",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to links between variations and sales prices updated after a specific point in time.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Bulk create prices",
"description": "Creates up to 50 prices of variations. The ID of the variation, the ID of the sales price and a price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_sales_prices",
"schema": {
"type": "object",
"required": [
"variationId",
"salesPriceId",
"price"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"price": {
"type": "number",
"description": "The price of the variation saved for this sales price"
}
}
}
}
]
},
"put": {
"summary": "Bulk update prices",
"description": "Updates up to 50 prices of variations. The ID of the variation, the ID of the sales price and a price must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/items\/variations\/variation_sales_prices",
"schema": {
"type": "object",
"required": [
"variationId",
"salesPriceId",
"price"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"price": {
"type": "number",
"description": "The price of the variation saved for this sales price"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images": {
"get": {
"summary": "List images of an item",
"description": "Lists all images of an item. The item ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to items updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/images\/attribute_value_markets": {
"get": {
"summary": "List attribute value image link",
"description": "Lists the images linked to an attribute value.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "imageId",
"type": "integer",
"required": false,
"description": "The unique ID of the image",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "The unique ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "valueId",
"type": "integer",
"required": false,
"description": "The unique ID of the attribute value",
"format": "integer",
"in": "query"
},
{
"name": "attributeId",
"type": "integer",
"required": false,
"description": "The unique ID of the attribute",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/images\/upload": {
"post": {
"summary": "Upload a new image",
"description": "Uploads an image. The item ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/upload",
"schema": {
"type": "object",
"required": [
"itemId",
"uploadFileName",
"lang",
"name",
"type",
"value"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The ID of the item the image is associated with"
},
"position": {
"type": "integer",
"description": "The position of the image. The position is used for sorting images in the online store. optional"
},
"fileType": {
"type": "string",
"description": "The file format of the image. Possible file formats: JPG, JPEG, PNG, GIF, SVG optional"
},
"uploadFileName": {
"type": "string",
"description": "The file name assigned to the uploaded image. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_). with uploadImageData"
},
"uploadImageData": {
"type": "string",
"description": "The base64 encoded image data of the image"
},
"uploadUrl": {
"type": "string",
"description": "The URL under which the image can be accessed for uploading. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_)."
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImageName"
}
},
"lang": {
"type": "string",
"description": "The language of the image name"
},
"name": {
"type": "string",
"description": "The name of the image in the specified language"
},
"alternate": {
"type": "string",
"description": "The alternative name of the image in the specified language optional"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImageAvailability"
}
},
"type": {
"type": "string",
"description": "The type of referrer for which the image is available. Possible types: mandant = The image can be made available for clients (stores).marketplace = The image can be made available for markets.listing = The image can be made available for listings. allowed values are mandant, marketplace, listing"
},
"value": {
"type": "number",
"description": "For the type mandant, this is the plentyID of the client (store) for which the image is available. For the types marketplace and listing, this is the ID of the referrer for which the image is available. -1.00 = The image is available for all referrers of this type."
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}": {
"delete": {
"summary": "Delete an image",
"description": "Delete an image. The ID of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an image",
"description": "Gets an image. The ID of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an image",
"description": "Updates an image. The ID of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}",
"schema": {
"type": "object",
"required": [
"itemId"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The unique ID of the item the image is associated with"
},
"position": {
"type": "integer",
"description": "The position of the image. The position is used for sorting images in the online store. optional"
},
"fileType": {
"type": "string",
"description": "The file format of the image. Possible file formats: jpg, jpeg, png, gif, svg optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/attribute_value_markets": {
"post": {
"summary": "Create an attribute value image link",
"description": "Creates a link between an image and an attribute value.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/attribute_value_markets",
"schema": {
"type": "object",
"required": [
"imageId",
"itemId",
"attributeId",
"valueId"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The unique ID of the image"
},
"itemId": {
"type": "integer",
"description": "The unique ID of the item"
},
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute"
},
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/attribute_value_markets\/{valueId}": {
"delete": {
"summary": "Delete an attribute value image link",
"description": "Deletes the link between an image and an attribute value. The attribute ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "The unique ID of the image",
"format": "integer",
"in": "path"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The unique ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "The unique ID of the attribute value",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an attribute value image link",
"description": "Gets an attribute value image link. The following IDs must be specified: image ID, item ID and value ID.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "The unique ID of the image",
"format": "integer",
"in": "path"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The unique ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "The unique ID of the value",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an attribute value image link",
"description": "Updates the link between an image and an attribute value. The following IDs must be specified: image ID, item ID and value ID.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValueImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "The unique ID of the image",
"format": "integer",
"in": "path"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The unique ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "valueId",
"type": "integer",
"required": true,
"description": "The unique ID of the attribute value",
"format": "integer",
"in": "path"
},
{
"name": "attributeId",
"type": "integer",
"required": true,
"description": "The unique ID of the attribute",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/attribute_value_markets\/{valueId}",
"schema": {
"type": "object",
"required": [
"imageId",
"itemId",
"attributeId",
"valueId"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The unique ID of the image"
},
"itemId": {
"type": "integer",
"description": "The unique ID of the item"
},
"attributeId": {
"type": "integer",
"description": "The unique ID of the attribute"
},
"valueId": {
"type": "integer",
"description": "The unique ID of the attribute value"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/availabilities": {
"delete": {
"summary": "Delete an availability",
"description": "Delete an availability for a specified value.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/availabilities",
"schema": {
"type": "object",
"required": [
"imageId",
"type"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The ID of the image. The ID must be unique."
},
"type": {
"type": "string",
"description": "The type of referrer for which the image is available. Possible types: mandant = The image can be made available for clients (stores).marketplace = The image can be made available for markets.listing = The image can be made available for listings. allowed values are mandant, marketplace, listing"
},
"value": {
"type": "number",
"description": "For the type mandant, this is the plentyID of the client (store) for which the image is available. For the types marketplace and listing, this is the ID of the referrer for which the image is available. -1.00 = The image is available for all referrers of this type."
}
}
}
}
]
},
"get": {
"summary": "List availabilities",
"description": "List all availabilities of an image. The image ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImageAvailability"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an availability",
"description": "Create an availability. The image ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImageAvailability"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/availabilities",
"schema": {
"type": "object",
"required": [
"imageId",
"type"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The ID of the image. The ID must be unique."
},
"type": {
"type": "string",
"description": "The type of referrer for which the image is available. Possible types: mandant = The image can be made available for clients (stores).marketplace = The image can be made available for markets.listing = The image can be made available for listings. allowed values are mandant, marketplace, listing"
},
"value": {
"type": "number",
"description": "For the type mandant, this is the plentyID of the client (store) for which the image is available. For the types marketplace and listing, this is the ID of the referrer for which the image is available. -1.00 = The image is available for all referrers of this type."
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/names": {
"get": {
"summary": "List names of an image",
"description": "Lists all names of an image. The image ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImageName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an image name",
"description": "Create an image name. The ID, language and name of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImageName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/names",
"schema": {
"type": "object",
"required": [
"imageId",
"lang",
"name"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The ID of the image. The ID must be unique."
},
"lang": {
"type": "string",
"description": "The language of the image name"
},
"name": {
"type": "string",
"description": "The name of the image in the specified language"
},
"alternate": {
"type": "string",
"description": "The alternative name of the image in the specified language optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/names\/{lang}": {
"delete": {
"summary": "Delete an image name",
"description": "Delete an image name. The ID and language of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an image name",
"description": "Gets an image name. The image ID and language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImageName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an image name",
"description": "Update an image name. The ID, language and name of the image must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemImageName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/images\/{imageId}\/names\/{lang}",
"schema": {
"type": "object",
"required": [
"imageId",
"lang",
"name"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The ID of the image. The ID must be unique."
},
"lang": {
"type": "string",
"description": "The language of the image name"
},
"name": {
"type": "string",
"description": "The name of the image in the specified language"
},
"alternate": {
"type": "string",
"description": "The alternative name of the image in the specified language optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/images\/{imageId}\/variation_images": {
"get": {
"summary": "List image links of an image",
"description": "Lists all variations linked to an image. The image ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/item_cross_selling": {
"get": {
"summary": "List cross-selling links",
"description": "Lists all cross-selling items linked to an item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemCrossSelling"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a cross-selling link",
"description": "Creates a cross-selling link.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemCrossSelling"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/item_cross_selling",
"schema": {
"type": "object",
"required": [
"itemId",
"crossItemId",
"relationship"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The unique ID of the item to which cross-selling items are linked"
},
"crossItemId": {
"type": "integer",
"description": "The unique ID of the cross-selling item that is linked to the item"
},
"relationship": {
"type": "string",
"description": "The cross-selling relationship between item and cross-selling item. Possible values:Accessory = The cross-selling item is an accessory of the item.ReplacementPart = The cross-selling item is a replacement part for the item.Similar = The cross-selling item is similar to the item.Bundle = The cross-selling item is suitable to be sold as a bundle with the item. allowed values are Variation, DisplaySet, Collection, Accessory, Customized, Part, Complements, Piece, Necessary, ReplacementPart, Similar, Episode, Season, Bundle, Component"
},
"isDynamic": {
"type": "boolean",
"description": "Flag that indicates if the cross-selling link was generated automatically. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/item_cross_selling\/{crossItemId}": {
"delete": {
"summary": "Delete a cross-selling link",
"description": "Deletes a cross-selling link. The ID of the item and the ID of the cross-selling item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "crossItemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variation_images": {
"get": {
"summary": "List image links of an item",
"description": "Lists all images linked to an item. The item ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/descriptions": {
"get": {
"summary": "List texts",
"description": "Lists the texts for an item in all available languages. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDescription"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create texts",
"description": "Creates texts for an item. The ID of the variation and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationDescription"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/descriptions",
"schema": {
"type": "object",
"required": [
"itemId",
"lang"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The unique ID of the item that this description belongs to"
},
"lang": {
"type": "string",
"description": "The language code of the description"
},
"name": {
"type": "string",
"description": "The default name of the item. By default, this name is displayed in the online store. For Default items, this name is also used for markets. Character limit: max. 240 characters. optional"
},
"name2": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"name3": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"previewDescription": {
"type": "string",
"description": "The preview text. The preview text is a short description that can be displayed in item lists. optional"
},
"metaDescription": {
"type": "string",
"description": "The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters. optional"
},
"description": {
"type": "string",
"description": "The item description. This is a detailed description displayed in the item layout of the online store. optional"
},
"technicalData": {
"type": "string",
"description": "The technical data for the item. To display the technical data in the online store, insert the template variable TechnicalData and an optional title into the template ItemViewSingleItem. optional"
},
"urlPath": {
"type": "string",
"description": "The URL path of the item in the online store. By default, the URL path consists of the categories and the item name. The path will be assigned automatically by plentymarkets when the item is created and will be displayed as part of the URL when the item is selected in the online store. optional"
},
"metaKeywords": {
"type": "string",
"description": "Meta keywords to tag the item for search engines. More than one keyword can be separated by commas. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/descriptions\/{lang}": {
"delete": {
"summary": "Delete texts",
"description": "Deletes texts for an item in the specified language. The ID of the variation and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get texts",
"description": "Gets the texts for an item in the specified language. The ID of the variation and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationDescription"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update texts",
"description": "Updates texts for an item in the specified language. The ID of the variation and the language code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationDescription"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/descriptions\/{lang}",
"schema": {
"type": "object",
"required": [
"itemId",
"lang"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The unique ID of the item that this description belongs to"
},
"lang": {
"type": "string",
"description": "The language code of the description"
},
"name": {
"type": "string",
"description": "The default name of the item. By default, this name is displayed in the online store. For Default items, this name is also used for markets. Character limit: max. 240 characters. optional"
},
"name2": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"name3": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"previewDescription": {
"type": "string",
"description": "The preview text. The preview text is a short description that can be displayed in item lists. optional"
},
"metaDescription": {
"type": "string",
"description": "The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters. optional"
},
"description": {
"type": "string",
"description": "The item description. This is a detailed description displayed in the item layout of the online store. optional"
},
"technicalData": {
"type": "string",
"description": "The technical data for the item. To display the technical data in the online store, insert the template variable TechnicalData and an optional title into the template ItemViewSingleItem. optional"
},
"urlPath": {
"type": "string",
"description": "The URL path of the item in the online store. By default, the URL path consists of the categories and the item name. The path will be assigned automatically by plentymarkets when the item is created and will be displayed as part of the URL when the item is selected in the online store. optional"
},
"metaKeywords": {
"type": "string",
"description": "Meta keywords to tag the item for search engines. More than one keyword can be separated by commas. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/images": {
"get": {
"summary": "List images of a variation",
"description": "Lists all images of a variation. The variation ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/labels": {
"post": {
"summary": "Get a variation label",
"description": "Gets a base64 encoded label for the specified variation ID. The labelId of the label template must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/market_ident_numbers": {
"get": {
"summary": "List ident number of a variation",
"description": "Lists the ident number (ASIN\/ePID) of a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarketIdentNumber"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a market ident number",
"description": "Creates a market ident number (ASIN\/ePID) for a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationMarketIdentNumber"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/market_ident_numbers",
"schema": {
"type": "object",
"required": [
"variationId",
"countryId",
"type"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"countryId": {
"type": "integer",
"description": "The country code of the market ident number (ASIN\/ePID)"
},
"type": {
"type": "string",
"description": "The type of market ident number (ASIN\/ePID) allowed values are ASIN, EPID, UPC, RSIN"
},
"position": {
"type": "integer",
"description": "The position of the market ident number (ASIN\/ePID) optional"
},
"value": {
"type": "string",
"description": "The value of the market ident number (ASIN\/ePID) optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/market_ident_numbers\/{marketIdentNumberId}": {
"delete": {
"summary": "Deletes a market ident number",
"description": "Deletes a market ident number (ASIN\/ePID) of a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketIdentNumberId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a market ident number",
"description": "Gets a market ident number (ASIN\/ePID) of a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationMarketIdentNumber"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketIdentNumberId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Updates a market ident number",
"description": "Updates a market ident number (ASIN\/ePID) of a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationMarketIdentNumber"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketIdentNumberId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/market_ident_numbers\/{marketIdentNumberId}",
"schema": {
"type": "object",
"required": [
"variationId",
"countryId",
"type"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"countryId": {
"type": "integer",
"description": "The country code of the market ident number (ASIN\/ePID)"
},
"type": {
"type": "string",
"description": "The type of market ident number (ASIN\/ePID) allowed values are ASIN, EPID, UPC, RSIN"
},
"position": {
"type": "integer",
"description": "The position of the market ident number (ASIN\/ePID) optional"
},
"value": {
"type": "string",
"description": "The value of the market ident number (ASIN\/ePID) optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock": {
"get": {
"summary": "List stock of a variation per warehouse",
"description": "Lists stock of a variation per warehouse. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStock"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/bookIncomingItems": {
"put": {
"summary": "Book incoming stock",
"description": "Books incoming stock for a variation. The incoming stock will be added to the existing stock. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStock"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/stock\/bookIncomingItems",
"schema": {
"type": "object",
"required": [
"warehouseId",
"deliveredAt",
"currency",
"quantity",
"reasonId"
],
"properties": {
"warehouseId": {
"type": "integer",
"description": "The ID of the warehouse"
},
"deliveredAt": {
"type": "string",
"description": "The date when stock was booked in. The date is given in W3C format."
},
"orderNumber": {
"type": "string",
"description": "The order number optional"
},
"currency": {
"type": "string",
"description": "The currency"
},
"quantity": {
"type": "number",
"description": "The quantity of a variation"
},
"purchasePrice": {
"type": "number",
"description": "The purchase price optional"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location optional"
},
"reasonId": {
"type": "integer",
"description": "The ID of the reason. The following IDs are available:\n\n101: Incoming items\n102: Booked in by stocktaking\n104: Rebooked into stock because no production errors were found\n106: Maculation canceled\n107: Packing error, items are re-booked\n109: Incoming items (logistics)\n115: Incoming items (second choice)\n116: Booked in by correction\n117: Unpacked item\n180: Incoming items (purchase order)\n181: Incoming items (warehousing)"
},
"supplierId": {
"type": "integer",
"description": "The ID of the supplier optional"
},
"exchangeRate": {
"type": "number",
"description": "The exchange rate optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/bookOutgoingItems": {
"put": {
"summary": "Book outgoing stock",
"description": "Books outgoing stock for a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStock"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/stock\/bookOutgoingItems",
"schema": {
"type": "object",
"required": [
"warehouseId",
"deliveredAt",
"currency",
"quantity",
"reasonId"
],
"properties": {
"warehouseId": {
"type": "integer",
"description": "The ID of the warehouse"
},
"deliveredAt": {
"type": "string",
"description": "The date when stock was booked in. The date is given in W3C format."
},
"orderNumber": {
"type": "string",
"description": "The order number optional"
},
"currency": {
"type": "string",
"description": "The currency"
},
"quantity": {
"type": "number",
"description": "The quantity of a variation"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location optional"
},
"reasonId": {
"type": "integer",
"description": "The ID of the reason. The following IDs are available:\n\n201: Outbound items\n202: Outbound inventur\n205: Outbound rubbish\n206: Outbound packing error\n207: Outbound defect\n208: Outbound complaint\n209: Outbound logistic\n214: Outbound warehouse movement\n215: Outbound second choise\n216: Outbound correction\n280: Outbound purchase order\n281: Outbound loss"
},
"supplierId": {
"type": "integer",
"description": "The ID of the supplier optional"
},
"exchangeRate": {
"type": "number",
"description": "The exchange rate optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/correction": {
"put": {
"summary": "Correct stock",
"description": "Corrects stock. The item ID and the variation ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStock"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/stock\/correction",
"schema": {
"type": "object",
"required": [
"quantity",
"warehouseId",
"storageLocationId"
],
"properties": {
"quantity": {
"type": "number",
"description": "The quantity of the variation"
},
"warehouseId": {
"type": "integer",
"description": "The ID of the warehouse"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location"
},
"reasonId": {
"type": "integer",
"description": "The reason for correction. The following reasons are available:\n\n301: Stock correction\n302: Stock correction by stocktaking\n304: Stock correction because of manufacturer error\n305: Stock correction because of unusable paper\n306: Stock correction because of packing error\n307: Stock correction because of damage\n309: Stock correction (internal offset)\n317: Stock correction because of BBD\n318: Stock correction because of shipping items to FBA\n319: Stock correction because of shipping items to fulfillment service provider\n320: Stock correction because of sample for interested parties\n321: Stock correction because of sample for customers\n322: Stock correction because of sample\n323: Stock correction because quality models are booked in\n324: Stock correction because quality models are booked out\n325: Stock correction because of gift\n326: Stock correction because of malfunction (without return)\n327: Stock correction because of loss\n328: Stock correction because of unpack\n optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/movements": {
"get": {
"summary": "List stock movements",
"description": "Lists stock movements for a variation. The ID of the item and the ID of the variation must be specified. To get movements older than 3 months, set the 'year' parameter.\nNOTE: You can either get archive entries or non-archive entries. You can not get entries for the current year that are younger and older than 3 months with one request. You need separate requests to get entries older and younger than 3 months. To get all entries younger than 3 month you do not need to specify a year or any createdAt parameter.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of VariationStockMovement",
"items": {
"$ref": "#\/definitions\/VariationStockMovement"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "warehouseId",
"type": "integer",
"required": false,
"description": "The ID of the warehouse",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Get entries with createdAt date after this date",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Get entries with createdAt date before this date",
"format": "string",
"in": "query"
},
{
"name": "year",
"type": "integer",
"required": false,
"description": "Get entries from the archive for the given year. All movements older than 3 months are stored in the archive.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The requested page. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The number of items per page. The default number per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/redistribute": {
"put": {
"summary": "Redistribute stock",
"description": "Redistributes the stock of one storage location among one or more storage locations. The item ID and the variation ID need to be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StockStorageLocation",
"items": {
"$ref": "#\/definitions\/StockStorageLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/stock\/redistribute",
"schema": {
"type": "object",
"required": [
"quantity",
"currentStorageLocationId",
"currentWarehouseId",
"newStorageLocationId",
"newWarehouseId"
],
"properties": {
"reasonId": {
"type": "integer",
"description": "The reason for the redistribution. Valid reasons are:\n\n\t401: Stock transfer\n\t402: Stock correction by stocktaking\n\t403: Stock transfer because of need for repair\n optional"
},
"quantity": {
"type": "number",
"description": "The quantity to redistribute"
},
"currentStorageLocationId": {
"type": "integer",
"description": "The ID of the current storage location"
},
"currentWarehouseId": {
"type": "integer",
"description": "The ID of the current warehouse"
},
"newStorageLocationId": {
"type": "integer",
"description": "The ID of the new storage location"
},
"newWarehouseId": {
"type": "integer",
"description": "The ID of the new warehouse"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the redistribution optional"
},
"batch": {
"type": "string",
"description": "The batch of the redistribution optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/stock\/storageLocations": {
"get": {
"summary": "List stock of a variation per storage locations",
"description": "Lists stock of a variation per storage location. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StockStorageLocation",
"items": {
"$ref": "#\/definitions\/StockStorageLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The requested page",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The number of items per page",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_additional_skus": {
"get": {
"summary": "List additional SKUs",
"description": "Lists the additional SKUs of a variation. Filters must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationAdditionalSku"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_additional_skus",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId",
"marketAccountId",
"sku"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The ID of the variation."
},
"marketId": {
"type": "number",
"description": "The ID of the market reference."
},
"marketAccountId": {
"type": "integer",
"description": "The ID of the market account."
},
"sku": {
"type": "string",
"description": "The additional sku for this variation."
},
"createdAt": {
"type": "string",
"description": "The time the SKU was created (YYYY-MM-DD HH:MM:SS). optional"
},
"updatedAt": {
"type": "string",
"description": "The time the SKU was updated (YYYY-MM-DD HH:MM:SS). optional"
}
}
}
}
]
},
"post": {
"summary": "Create an additional SKU",
"description": "Creates an additional SKU. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationAdditionalSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_additional_skus",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId",
"marketAccountId",
"sku"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The ID of the variation."
},
"marketId": {
"type": "number",
"description": "The ID of the market reference."
},
"marketAccountId": {
"type": "integer",
"description": "The ID of the market account."
},
"sku": {
"type": "string",
"description": "The additional sku for this variation."
},
"createdAt": {
"type": "string",
"description": "The time the SKU was created (YYYY-MM-DD HH:MM:SS). optional"
},
"updatedAt": {
"type": "string",
"description": "The time the SKU was updated (YYYY-MM-DD HH:MM:SS). optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_additional_skus\/{additionalSkuId}": {
"delete": {
"summary": "Delete an additional SKU",
"description": "Deletes an additional SKU. The ID of the additional SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "additionalSkuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets an additional SKU",
"description": "Gets an additional SKU. The ID of the additional SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationAdditionalSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "additionalSkuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an additional SKU",
"description": "Updates an additional SKU. The ID of the additional SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationAdditionalSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "additionalSkuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_additional_skus\/{additionalSkuId}",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId",
"marketAccountId",
"sku"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The ID of the variation."
},
"marketId": {
"type": "number",
"description": "The ID of the market reference."
},
"marketAccountId": {
"type": "integer",
"description": "The ID of the market account."
},
"sku": {
"type": "string",
"description": "The additional sku for this variation."
},
"createdAt": {
"type": "string",
"description": "The time the SKU was created (YYYY-MM-DD HH:MM:SS). optional"
},
"updatedAt": {
"type": "string",
"description": "The time the SKU was updated (YYYY-MM-DD HH:MM:SS). optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_barcodes": {
"get": {
"summary": "List variation barcodes",
"description": "Lists all barcodes of a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBarcode"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified variation barcode information in the results. The following parameter is available:
- barcode<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a variation barcode",
"description": "Creates a variation barcode. The ID of the item, the ID of the variation, the ID of the barcode and the code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_barcodes",
"schema": {
"type": "object",
"required": [
"barcodeId",
"variationId",
"code"
],
"properties": {
"barcodeId": {
"type": "integer",
"description": "The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique."
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"code": {
"type": "string",
"description": "The code of the variation's barcode. The combination of code and barcode ID must be unique."
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_barcodes\/{barcodeId}": {
"delete": {
"summary": "Delete a variation barcode",
"description": "Deletes a variation barcode. Unlinks the barcode from the variation and deletes the code saved for the variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a variation barcode",
"description": "Get a specific variation barcode. The ID of the item, the ID of the variation and the ID of the barcode must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a variation barcode",
"description": "Updates a variation barcode. The ID of the item, the ID of the variation, the ID of the barcode and the code must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "barcodeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_barcodes\/{barcodeId}",
"schema": {
"type": "object",
"required": [
"barcodeId",
"variationId",
"code"
],
"properties": {
"barcodeId": {
"type": "integer",
"description": "The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique."
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"code": {
"type": "string",
"description": "The code of the variation's barcode. The combination of code and barcode ID must be unique."
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_bundles": {
"get": {
"summary": "List bundle components",
"description": "List all components of a bundle. The ID of the item and the ID of the variation to which bundle components were added must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBundle"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Add a variation to a bundle",
"description": "Adds a variation to a bundle variation as a bundle component.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBundle"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_bundles",
"schema": {
"type": "object",
"required": [
"variationId",
"componentVariationId",
"componentQuantity"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation to which other variations are added to create a bundle"
},
"componentVariationId": {
"type": "integer",
"description": "The unique ID of the variation added as bundle component"
},
"componentQuantity": {
"type": "integer",
"description": "The quantity of the variation to be added as bundle component"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_bundles\/{bundleId}": {
"delete": {
"summary": "Remove a bundle component",
"description": "Removes a component from a bundle. The bundle ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "bundleId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a variation bundle",
"description": "Gets the bundle information for a specific bundle component.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBundle"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "bundleId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a variation bundle",
"description": "Updates a variation bundle component.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationBundle"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "bundleId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_bundles\/{bundleId}",
"schema": {
"type": "object",
"required": [
"variationId",
"componentVariationId",
"componentQuantity"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation to which other variations are added to create a bundle"
},
"componentVariationId": {
"type": "integer",
"description": "The unique ID of the variation added as bundle component"
},
"componentQuantity": {
"type": "integer",
"description": "The quantity of the variation to be added as bundle component"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_categories": {
"get": {
"summary": "List categories linked to a variation",
"description": "Lists all categories linked to a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Link a category to a variation",
"description": "Creates a link between a category and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_categories",
"schema": {
"type": "object",
"required": [
"variationId",
"categoryId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"categoryId": {
"type": "integer",
"description": "The unique ID of the category"
},
"position": {
"type": "integer",
"description": "The position of the category optional"
},
"isNeckermannPrimary": {
"type": "string",
"description": "Flag that indicates if the category is the primary category for the market Neckermann for this variation. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_categories\/{catId}": {
"delete": {
"summary": "Remove a category from a variation",
"description": "Deletes the link between a category and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "catId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get link between category and variation",
"description": "Gets the link between a category and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "catId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update variation category link",
"description": "Updates the link between a category and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "catId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_categories\/{catId}",
"schema": {
"type": "object",
"required": [
"variationId",
"categoryId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"categoryId": {
"type": "integer",
"description": "The unique ID of the category"
},
"position": {
"type": "integer",
"description": "The position of the category optional"
},
"isNeckermannPrimary": {
"type": "string",
"description": "Flag that indicates if the category is the primary category for the market Neckermann for this variation. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_clients": {
"get": {
"summary": "List clients linked to a variation",
"description": "Lists all clients (stores) linked to a variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationClient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Link a client to a variation",
"description": "Creates a link between a client (store) and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationClient"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_clients",
"schema": {
"type": "object",
"required": [
"variationId",
"plentyId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"plentyId": {
"type": "integer",
"description": "The unique ID of the client (store)"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_clients\/{plentyId}": {
"delete": {
"summary": "Unlink a client from a variation",
"description": "Deletes the link between a client (store) and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_component_bundles": {
"get": {
"summary": "List bundles",
"description": "List the bundles that the variation is a component of. The variation ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBundle"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_default_categories": {
"get": {
"summary": "List default category links",
"description": "Lists the default category of a variation for all clients (stores). The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a default category link",
"description": "Creates a link between a variation and a category that designates the category as the default category.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_default_categories\/{plentyId}": {
"delete": {
"summary": "Delete a default category link",
"description": "Deletes a link between a variation and a category that designates this category as the default category.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets a default category link",
"description": "Gets the default category linked to a variation for the specified client (store). The ID of the item, the ID of the variation and the ID of the client (store) must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_images": {
"get": {
"summary": "List image links of a variation",
"description": "Lists all images linked to a variation. The variation ID must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variation images updated after the specified date. The date can be specified as unix timestamps or in the ISO 8601 date format. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an image link",
"description": "Creates a link between an image and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationImage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_images",
"schema": {
"type": "object",
"required": [
"imageId",
"itemId",
"variationId"
],
"properties": {
"imageId": {
"type": "integer",
"description": "The unique ID of the image"
},
"itemId": {
"type": "integer",
"description": "The unique ID of the item"
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_images\/{imageId}": {
"delete": {
"summary": "Delete an image link",
"description": "Deletes a link between an image and a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "imageId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_markets": {
"delete": {
"summary": "Delete all market links of one variation",
"description": "Deletes all links of one variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List markets linked to a variation",
"description": "Lists all markets linked to a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarket"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create link between variation and market",
"description": "Creates a link between a variation and a market. The ID of the item, the ID of the variation and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_markets",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"marketId": {
"type": "integer",
"description": "The unique ID of the market"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_markets\/{marketplaceId}": {
"delete": {
"summary": "Delete link between variation and market",
"description": "Deletes a link between a variation and a market. The ID of the item, the ID of the variation and the ID of the market must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "marketplaceId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_properties": {
"delete": {
"summary": "Deletes all links between a variation and its property values",
"description": "Deletes all links between a variation and its property values. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List property values linked to a variation",
"description": "Lists the property values linked to a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValue"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create link between variation and property value",
"description": "Creates a link between a variation and a property value.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_properties",
"schema": {
"type": "object",
"required": [
"variationId",
"propertyId",
"lang"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property value optional"
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"propertySelectionId": {
"type": "integer",
"description": "The unique ID of the property selection of the variation optional"
},
"valueInt": {
"type": "integer",
"description": "The int value of the property value of the variation optional"
},
"valueFloat": {
"type": "number",
"description": "The float value of the property value of the variation optional"
},
"valueFile": {
"type": "string",
"description": "The file value of the property value of the variation optional"
},
"valueTexts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_properties\/{propertyId}": {
"delete": {
"summary": "Delete link between variation and property value",
"description": "Delete a link between a variation and a property value. The ID of the item, the ID of the variation and the ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property value",
"description": "Gets a property value linked to a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property value",
"description": "Update the data of a property value linked to a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_properties\/{propertyId}",
"schema": {
"type": "object",
"required": [
"variationId",
"propertyId",
"lang"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property value optional"
},
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"propertySelectionId": {
"type": "integer",
"description": "The unique ID of the property selection of the variation optional"
},
"valueInt": {
"type": "integer",
"description": "The int value of the property value of the variation optional"
},
"valueFloat": {
"type": "number",
"description": "The float value of the property value of the variation optional"
},
"valueFile": {
"type": "string",
"description": "The file value of the property value of the variation optional"
},
"valueTexts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_sales_prices": {
"delete": {
"summary": "Delete all links between a variation and its sales prices",
"description": "Deletes all links between a variation and its sales prices and deletes the sales price data. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List sales prices of a variation",
"description": "Lists the sales prices of a variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create link between variation and sales price",
"description": "Creates a link between a variation and a sales price and adds sales price data.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_sales_prices",
"schema": {
"type": "object",
"required": [
"variationId",
"salesPriceId",
"price"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"price": {
"type": "number",
"description": "The price of the variation saved for this sales price"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_sales_prices\/{priceId}": {
"delete": {
"summary": "Delete link between variation and sales price",
"description": "Deletes a link between a variation and a sales price and deletes the sales price data. The ID of the sales price and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "priceId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get sales price data for a variation",
"description": "Gets sales price data linked to a variation. The ID of the sales price and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "priceId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update sales price data",
"description": "Updates sales price data linked to a variation. The ID of the sales price and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "priceId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_sales_prices\/{priceId}",
"schema": {
"type": "object",
"required": [
"variationId",
"salesPriceId",
"price"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The unique ID of the variation"
},
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"price": {
"type": "number",
"description": "The price of the variation saved for this sales price"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_skus": {
"get": {
"summary": "List SKUs",
"description": "Lists the SKUs of a variation. Filters must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSku"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create an SKU",
"description": "Creates an SKU. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_skus",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId",
"accountId",
"sku"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"marketId": {
"type": "number",
"description": "The ID of the market"
},
"accountId": {
"type": "integer",
"description": "The ID of the market account"
},
"initialSku": {
"type": "string",
"description": "The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU. optional"
},
"sku": {
"type": "string",
"description": "The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id."
},
"parentSku": {
"type": "string",
"description": "The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article. optional"
},
"isActive": {
"type": "boolean",
"description": "Flag that indicates if the item is ready for export (currently not in use). optional"
},
"createdAt": {
"type": "string",
"description": "The time the SKU was created (YYYY-MM-DD HH:MM:SS). optional"
},
"updatedAt": {
"type": "string",
"description": "The time the SKU was updated (YYYY-MM-DD HH:MM:SS). optional"
},
"exportedAt": {
"type": "string",
"description": "The time the variation was last exported (YYYY-MM-DD HH:MM:SS). optional"
},
"stockUpdatedAt": {
"type": "string",
"description": "optional"
},
"deletedAt": {
"type": "string",
"description": "The time the variation was deleted (YYYY-MM-DD HH:MM:SS). optional"
},
"status": {
"type": "string",
"description": "The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE. optional allowed values are ACTIVE, INACTIVE, ERROR, SENT"
},
"additionalInformation": {
"type": "string",
"description": "The field that contains additional information. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_skus\/{skuId}": {
"delete": {
"summary": "Delete an SKU",
"description": "Deletes an SKU. The ID of the SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "skuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an SKU",
"description": "Gets an SKU. The ID of the SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "skuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an SKU",
"description": "Updates an SKU. The ID of the SKU must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSku"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "skuId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{id}\/variations\/{variationId}\/variation_skus\/{skuId}",
"schema": {
"type": "object",
"required": [
"variationId",
"marketId",
"accountId",
"sku"
],
"properties": {
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"marketId": {
"type": "number",
"description": "The ID of the market"
},
"accountId": {
"type": "integer",
"description": "The ID of the market account"
},
"initialSku": {
"type": "string",
"description": "The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU. optional"
},
"sku": {
"type": "string",
"description": "The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id."
},
"parentSku": {
"type": "string",
"description": "The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article. optional"
},
"isActive": {
"type": "boolean",
"description": "Flag that indicates if the item is ready for export (currently not in use). optional"
},
"createdAt": {
"type": "string",
"description": "The time the SKU was created (YYYY-MM-DD HH:MM:SS). optional"
},
"updatedAt": {
"type": "string",
"description": "The time the SKU was updated (YYYY-MM-DD HH:MM:SS). optional"
},
"exportedAt": {
"type": "string",
"description": "The time the variation was last exported (YYYY-MM-DD HH:MM:SS). optional"
},
"stockUpdatedAt": {
"type": "string",
"description": "optional"
},
"deletedAt": {
"type": "string",
"description": "The time the variation was deleted (YYYY-MM-DD HH:MM:SS). optional"
},
"status": {
"type": "string",
"description": "The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE. optional allowed values are ACTIVE, INACTIVE, ERROR, SENT"
},
"additionalInformation": {
"type": "string",
"description": "The field that contains additional information. optional"
}
}
}
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_suppliers": {
"get": {
"summary": "Lists suppliers for a variation",
"description": "Lists all supplier data linked to a variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSupplier"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a link between variation and supplier",
"description": "Creates a link between a variation and a supplier and adds supplier data.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_suppliers\/{variationSupplierId}": {
"delete": {
"summary": "Delete link between variation and supplier",
"description": "Deletes a link between a variation and a supplier. The ID of the variation and the ID of the link between the variation and the supplier must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationSupplierId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get supplier data for a variation",
"description": "Gets the data for a supplier linked to a variation. The ID of the variation and the ID of the link between the variation and the supplier must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationSupplierId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Updates supplier data for a variation",
"description": "Updates the data of a supplier linked to a variation.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationSupplierId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_warehouses": {
"get": {
"summary": "List the warehouses linked to a variation",
"description": "Lists the warehouses linked to a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationWarehouse"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create link between a variation and a warehouse",
"description": "Creates a link between a variation and a warehouse and adds warehouse data.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{id}\/variations\/{variationId}\/variation_warehouses\/{warehouseId}": {
"delete": {
"summary": "Delete link between a warehouse and a variation",
"description": "Deletes the link between a warehouse and a variation. The ID of the variation and the ID of the warehouse must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get warehouse data for a variation",
"description": "Gets the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update warehouse data of a variation",
"description": "Updates the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{itemId}": {
"delete": {
"summary": "Delete an item",
"description": "Deletes an item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Show an item",
"description": "Show an item by itemId",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Item"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "lang",
"type": "string",
"required": false,
"description": "The language<\/a> of the variation information.",
"format": "string",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a item",
"description": "Updates a item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Item"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{itemId}",
"schema": {
"type": "object",
"required": [
"ageRestriction",
"title",
"profileId",
"propertyId"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the item optional"
},
"stockType": {
"type": "integer",
"description": "The stock type of the item. Possible values:0 = Stocked item (default)1 = Production item2 = Colli3 = Special order item optional allowed values are 0, 1, 2, 3"
},
"storeSpecial": {
"type": "integer",
"description": "Option to present items more prominently in the online store.1 = Special offer2 = New items3 = Top items optional allowed values are 0, 1, 2, 3"
},
"ownerId": {
"type": "integer",
"description": "The plentymarkets user that is assigned as owner of this item. optional"
},
"manufacturerId": {
"type": "integer",
"description": "The ID of the manufacturer of the item optional"
},
"createdAt": {
"type": "string",
"description": "Timestamp of the date and time the item was created. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "Deprecated: The customs tariff number of the item; usually a 11 digit code number based on the Harmonised System optional"
},
"revenueAccount": {
"type": "integer",
"description": "The revenue account the item is linked to. An individual revenue account can be saved for each item in plentymarkets. If this is not done, plentymarkets automatically determines a revenue account based on the VAT rate. optional"
},
"couponRestriction": {
"type": "integer",
"description": "Indicates if the item can be purchased using a promotional coupon.0 = Permitted1 = Not permitted2 = Purchasable with coupon only optional allowed values are 0, 1, 2"
},
"condition": {
"type": "integer",
"description": "The condition of the item. Possible values:0 = New1 = Used2 = Boxed as new3 = New with label4 = Factory seconds optional allowed values are 0, 1, 2, 3, 4"
},
"conditionApi": {
"type": "integer",
"description": "The condition of the item that is transferred to markets via API.0 = New1 = Used but as new2 = Used but very good3 = Used but good4 = Used but acceptable5 = Factory seconds optional allowed values are 0, 1, 2, 3, 4, 5"
},
"isSubscribable": {
"type": "boolean",
"description": "Flag that indicates if the item can be ordered as a subscription item. If yes, the item can be ordered for delivery at regular intervals. optional"
},
"isShippingPackage": {
"type": "boolean",
"description": "Flag that indicates if a shipping package is to be used for this item. If yes and the variation's dimensions are entered in the Settings tab of a variation, the correct shipping package is assigned automatically. optional"
},
"amazonFbaPlatform": {
"type": "integer",
"description": "Indicates the platform used for Fulfilment by Amazon (FBA). 0 = Do not use1 = AMAZON EU (Europe)2 = AMAZON FE (Far East)3 = AMAZON NA (North America) optional allowed values are 0, 1, 2, 3"
},
"isShippableByAmazon": {
"type": "boolean",
"description": "Flag that indicates if the item can be shipped with Amazon Multi-Channel. Amazon Multi-Channel Fulfillment is a service for fulfilling orders from sales channels other than Amazon platforms using inventory stored in the Amazon fulfillment center. optional"
},
"amazonProductType": {
"type": "integer",
"description": "The Amazon product type of the item. List of IDs: https:\/\/www.plentymarkets.co.uk\/manual\/data-exchange\/data-formats\/item\/ optional"
},
"amazonFedas": {
"type": "string",
"description": "The FEDAS product classification key of the item. optional"
},
"ebayPresetId": {
"type": "integer",
"description": "The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2. optional"
},
"ebayCategory": {
"type": "integer",
"description": "The eBay category 1 of the item. This category is used when a new listing is created. optional"
},
"ebayCategory2": {
"type": "integer",
"description": "The eBay category 2 of the item. This category is used when a new listing is created. optional"
},
"ebayStoreCategory": {
"type": "integer",
"description": "The ID of the eBay store category 1 of the item. This value is used for new listings. optional"
},
"ebayStoreCategory2": {
"type": "integer",
"description": "The ID of the eBay store category 2 of the item. This value is used for new listings. optional"
},
"rakutenCategoryId": {
"type": "integer",
"description": "The ID of the Rakuten category of this item. optional"
},
"flagOne": {
"type": "integer",
"description": "Flag 1 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31"
},
"flagTwo": {
"type": "integer",
"description": "Flag 2 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11"
},
"ageRestriction": {
"type": "integer",
"description": "The age customers must be to purchase the item. Items with an age rating of 18+ must be linked to a shipping profile for which the PostIdent option is activated.0 = None available3 = Released for ages 3 and up6 = Ages 6 and up9 = Ages 9 and up12 = Ages 12 and up14 = Ages 14 and up16 = Ages 16 and up18 = Ages 18 and up50 = Not marked88 = Not 99 = Unknown optional allowed values are 0, 3, 6, 9, 12, 14, 16, 18, 50, 88, 99"
},
"feedback": {
"type": "integer",
"description": "The feedback, i.e. rating, that this item received. Possible values are 1 to 5 or 1 to 10 depending on the maximum rating setting. An initial feedback can be saved for items. The saved value will then be displayed as the initial feedback. Every time new feedback is submitted, the average value will be recalculated automatically. optional"
},
"ebayTitles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemEbayTitle"
}
},
"title": {
"type": "string",
"description": "The title."
},
"itemShippingProfiles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
},
"profileId": {
"type": "integer",
"description": "The unique ID of the shipping profile"
},
"itemProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemProperty"
}
},
"propertyId": {
"type": "integer",
"description": "The id of the property item"
},
"propertySelectionId": {
"type": "integer",
"description": "The id of the property selection optional"
}
}
}
}
]
}
},
"\/rest\/items\/{itemId}\/fill": {
"post": {
"summary": "Fill item to es",
"description": "Fills item to es. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{itemId}\/item_shipping_profiles": {
"delete": {
"summary": "Deactivate shipping profiles of an item",
"description": "Deactivates all shipping profiles of an item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List shipping profiles of an item",
"description": "Lists the shipping profiles linked to an item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Activate a shipping profile",
"description": "Links a shipping profile to the item. The ID of the item and the ID of the shipping profile must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{itemId}\/item_shipping_profiles\/{id}": {
"delete": {
"summary": "Deactivate a shipping profile",
"description": "Unlinks a shipping profile from the item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The unique ID of the item",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "The unique ID of the link between item and shipping profile",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{itemId}\/variations": {
"get": {
"summary": "List variations of an item",
"description": "Lists all variations of an item. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Variation",
"items": {
"$ref": "#\/definitions\/Variation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified variation information in the results. The following parameters are available:
- properties<\/b> = The properties linked to the variation<\/li>
- variationProperties<\/b> = The properties linked to the variation<\/li>
- variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li>
- variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li>
- variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li>
- variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li>
- marketItemNumbers<\/b> = The market ident number of the variation<\/li>
- variationCategories<\/b> = The categories linked to the variation<\/li>
- variationClients<\/b> = The clients (stores) for which the variation is activated<\/li>
- variationMarkets<\/b> = The markets for which the variation is activated <\/li>
- variationDefaultCategory<\/b> = The default category of the variation<\/li>
- variationSuppliers<\/b> = The supplier data associated with the variation<\/li>
- variationWarehouses<\/b> = The warehouse data associated with the variation<\/li>
- images<\/b> = The images linked to the variation<\/li>
- itemImages<\/b> = The images linked to the item<\/li>
- variationAttributeValues<\/b> = The attribute values of the variation<\/li>
- variationSkus<\/b> = The SKU data associated with the variation<\/li>
- variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li>
- unit<\/b> = The unit assigned to the variation<\/li>
- parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li>
- item<\/b> = The item of the variation<\/li>
- stock<\/b> = The stock data of the variation<\/li><\/ul> For example, specifying the parameters variationCategories and variationDefaultCategory will include the default category and all other categories the variations are linked to. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "The language<\/a> of the variation information.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Limits the results to a specific page. The page number must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Limits the number of results listed per page to a specific number. The number of variations to be listed per page must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "isMain",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations that are main variations.",
"format": "boolean",
"in": "query"
},
{
"name": "isActive",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations that are active.",
"format": "boolean",
"in": "query"
},
{
"name": "barcode",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified barcode. A barcode must be specified.",
"format": "string",
"in": "query"
},
{
"name": "numberExact",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to the variation with the variation number specified.",
"format": "string",
"in": "query"
},
{
"name": "numberFuzzy",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with numbers that contain the variation number specified (SQL LIKE operator). For example, if variations with variation numbers 1 to 400 exist in the system, filtering by 12 will list variation numbers 12, 112, 120-129, 212 and 312.",
"format": "string",
"in": "query"
},
{
"name": "isBundle",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations to which variations were added to create a bundle.",
"format": "boolean",
"in": "query"
},
{
"name": "supplierNumber",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified supplier number. A supplier number must be specified.",
"format": "string",
"in": "query"
},
{
"name": "manufacturerId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified manufacturer ID.",
"format": "integer",
"in": "query"
},
{
"name": "updatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations updated during the specified period. The end date (to) is optional. If no end date is specified, variations updated between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/variations?updatedBetween=1451606400,1456790400 will list variations updated between 2016-01-01 and 2016-03-01. ...\/variations?updatedBetween=1451606400 will list variations updated since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "createdBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations created during the specified period. The end date (to) is optional. If no end date is specified, variations created between the start date (from) and the present will be listed. The dates can be specified as unix timestamps or in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/variations?createdBetween=1451606400,1456790400 will list variations created between 2016-01-01 and 2016-03-01. ...\/variations?createdBetween=1451606400 will list variations created since 2016-01-01. The PHP function strtotime is also supported.",
"format": "string",
"in": "query"
},
{
"name": "relatedUpdatedBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to those variations for which related information was updated during the specified period. Related information is defined as information linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. See variationUpdatedBetween for supported formats.",
"format": "string",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a variation",
"description": "Create a variation. The ID of the item must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Variation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{itemId}\/variations",
"schema": {
"type": "object",
"required": [
"itemId",
"valueId",
"unit"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the variation. The ID must be unique. optional"
},
"isMain": {
"type": "boolean",
"description": "Flag that indicates if the variation is the main variation of the item. optional"
},
"mainVariationId": {
"type": "integer",
"description": "The variation ID of the item's main variation. Value is NULL if this variation is the item's main variation. optional"
},
"itemId": {
"type": "integer",
"description": "The item ID of the item that this variation belongs to."
},
"position": {
"type": "integer",
"description": "The position of the variation. Value is inherited from the item's main variation if inheritance is active. optional"
},
"isActive": {
"type": "boolean",
"description": "Flag that indicates if the variation is active. Only active variations can be offered in the online store and\/or on markets. optional"
},
"number": {
"type": "string",
"description": "The unique variation number of the variation. The variation number must be specified. optional value must be unique"
},
"model": {
"type": "string",
"description": "The model of the variation. Value is inherited from the item's main variation if inheritance is active. optional"
},
"externalId": {
"type": "string",
"description": "The external variation ID of this variation. The external variation number is optional and allows importing items and variations from external systems to plentymarkets. optional"
},
"availability": {
"type": "integer",
"description": "The availability of the variation. Possible values: 1 to 10, null = Variation inherits value of main variation. optional"
},
"estimatedAvailableAt": {
"type": "string",
"description": "The estimated delivery date of variations on reorder. optional"
},
"purchasePrice": {
"type": "number",
"description": "The net purchase price. Value e.g. is used for price calculations. optional"
},
"movingAveragePrice": {
"type": "number",
"description": "The moving average purchase price of the variation. optional"
},
"createdAt": {
"type": "string",
"description": "The time the variation was created. optional"
},
"updatedAt": {
"type": "string",
"description": "The time the variation was last updated. optional"
},
"relatedUpdatedAt": {
"type": "string",
"description": "The time at which related information for this variation was last updated. Related information is defined as information that is linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. optional"
},
"priceCalculationId": {
"type": "integer",
"description": "The ID of the price calculation linked to the variation. optional"
},
"picking": {
"type": "string",
"description": "The order picking type of the variation. Possible values: single_picking, no_single_picking, exclude_from_picklist, null (no order picking type) optional allowed values are single_picking, no_single_picking, exclude_from_picklist"
},
"stockLimitation": {
"type": "integer",
"description": "The stock limitation for the variation. Possible values: 0 = No limitation, i.e. stock is not limited. The variations's availability is not checked automatically.1 = Stock is limited to net stock. The variation's availability is checked automatically.2 = Do not administer stock for this variation. optional allowed values are 0, 1, 2"
},
"isVisibleIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is visible in the online store if net stock is positive. If true, the variation automatically becomes visible when the net stock changes to positive. optional"
},
"isInvisibleIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is invisible in the online store if net stock is not positive. If true, the variation automatically becomes invisible when the net stock changes to 0 or negative. optional"
},
"isAvailableIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is available in the online store if net stock is positive. If true, the variation automatically becomes available when the net stock changes to positive. optional"
},
"isUnavailableIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is unavailable in the online store if net stock is not positive. If true, the variation automatically becomes available when the net stock changes to 0 or negative. optional"
},
"mainWarehouseId": {
"type": "integer",
"description": "The ID of the main warehouse of the variation. optional"
},
"maximumOrderQuantity": {
"type": "number",
"description": "The maximum order quantity permitted per order. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited. optional"
},
"minimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity. Decimal values are possible to allow orders by weight or length. optional"
},
"intervalOrderQuantity": {
"type": "number",
"description": "The quantity intervals the variation can be ordered in. Decimal values are possible to allow orders by weight or length. optional"
},
"availableUntil": {
"type": "string",
"description": "The last date the item will be available for sale. optional"
},
"releasedAt": {
"type": "string",
"description": "The release date of the variation. This is the date on which the variation will become available. The variation can be visible in the online store before this date, e.g. for preorders. optional"
},
"name": {
"type": "string",
"description": "The name of the variation optional"
},
"weightG": {
"type": "integer",
"description": "The gross weight of the variation in gramms (g). This weight includes the packaging for variations that are packaged separately. This value is used for calculating shipping packages and weight-based shipping costs. optional"
},
"weightNetG": {
"type": "integer",
"description": "The net weight of the variation in gramms (g). This is the weight of the variation without packaging. optional"
},
"widthMM": {
"type": "integer",
"description": "The width of the variation in millimetres (mm) optional"
},
"lengthMM": {
"type": "integer",
"description": "The length of the variation in millimeters (mm) optional"
},
"heightMM": {
"type": "integer",
"description": "The height of the variation in millimetres (mm) optional"
},
"extraShippingCharge1": {
"type": "number",
"description": "The extra shipping charge 1 for the variation. Extra shipping charges are useful for large or bulky items that are particularly expensive to ship. Charge 1 is added to the regular shipping costs for the first item of an order. If different variations are ordered, the extra shipping charge 1 of the variation with the highest charge 1 is selected. optional"
},
"extraShippingCharge2": {
"type": "number",
"description": "The extra shipping charge 2 for the variation. Extra shipping charges are useful for large or bulky items that are expensive to ship. Charge 2 is added to the shipping costs for any additional items of an order. optional"
},
"unitsContained": {
"type": "integer",
"description": "The number of sales units contained in one package. Default value is 1. optional"
},
"palletTypeId": {
"type": "integer",
"description": "The ID of the pallet type optional"
},
"packingUnits": {
"type": "integer",
"description": "The number of packing units if the item consists of multiple packages. Value is 0 if an item is sent as one package. All items of an order that have the value 0 will be packed into one package. optional"
},
"packingUnitTypeId": {
"type": "integer",
"description": "The ID of the packing unit type. optional"
},
"transportationCosts": {
"type": "number",
"description": "The net transportation costs for the variation. This value is used for price calculations and for calculating the acquisition price. optional"
},
"storageCosts": {
"type": "number",
"description": "The net storage costs for the variation optional"
},
"customs": {
"type": "number",
"description": "The customs rate in percent optional"
},
"operatingCosts": {
"type": "number",
"description": "The operating costs for the variation in percent optional"
},
"vatId": {
"type": "integer",
"description": "The ID of the VAT rate of the variation. VAT rates are created for each client (store) and linked to the variation. optional allowed values are 0, 1, 2, 3"
},
"bundleType": {
"type": "string",
"description": "Indicates the bundle type of the variation. Possible values:bundle = The variation is a bundlebundle_item = The variation is a bundle component.Null = The variation is not associated with a bundle optional allowed values are bundle, bundle_item"
},
"automaticClientVisibility": {
"type": "integer",
"description": "Indicates if the variation is set as available for any clients (stores). Possible values:0 \/ -1 (GET) or 0 (POST) = Variation is not available in any client (store).1 \/ 2 (GET) or 1 (POST) = Variation is available in at least one client (store).The variation's actual visibility depends on the settings for net stock dependency. optional allowed values are -1, 0, 1, 2"
},
"isHiddenInCategoryList": {
"type": "boolean",
"description": "Flag that indicates if the variation is hidden in the category list. If true, the variation will not be shown in any item category and will not be returned as a search result. The variation can only be accessed via its URL. optional"
},
"mayShowUnitPrice": {
"type": "boolean",
"description": "Display unit price in the online store optional"
},
"hasCalculatedBundleWeight": {
"type": "boolean",
"description": "Indicates if the gross bundle weight is calculated by its components. optional"
},
"hasCalculatedBundleNetWeight": {
"type": "boolean",
"description": "Indicates if the net bundle weight is calculated by its components. optional"
},
"hasCalculatedBundlePurchasePrice": {
"type": "boolean",
"description": "Indicates if the net purchase price is calculated by its components. optional"
},
"hasCalculatedBundleMovingAveragePrice": {
"type": "boolean",
"description": "Indicates if the moving average net purchase price is calculated by its components. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "The customs tariff number of the variation; usually a 11 digit code number based on the Harmonised System optional"
},
"categoryVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Categories are not inherited from the main variation.ID of the item's main variation = Inheritance of categories is active. optional"
},
"marketVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Markets are not inherited from the main variation.ID of the item's main variation = Inheritance of markets is active. optional"
},
"clientVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Clients (stores) are not inherited from the main variation.ID of the item's main variation = Inheritance of clients (stores) is active. optional"
},
"salesPriceVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Sales prices are not inherited from the main variation.ID of the item's main variation = Inheritance of sales prices is active. optional"
},
"supplierVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Suppliers are not inherited from the main variation.ID of the item's main variation = Inheritance of suppliers is active. optional"
},
"warehouseVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Warehouses are not inherited from the main variation.ID of the item's main variation = Inheritance of warehouses is active. optional"
},
"variationBarcodes": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"variationSalesPrices": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"variationCategories": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"variationClients": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationClient"
}
},
"variationMarkets": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarket"
}
},
"variationDefaultCategory": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
},
"variationSuppliers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"variationWarehouses": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"variationAttributeValues": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AttributeValueSet"
}
},
"valueId": {
"type": "integer",
"description": "The ID of the attribute value"
},
"unit": {
"type": "array",
"items": {
"$ref": "#\/definitions\/UnitCombination"
}
},
"parentVariationId": {
"type": "integer",
"description": "optional"
},
"parentVariationQuantity": {
"type": "number",
"description": "optional"
}
}
}
}
]
}
},
"\/rest\/items\/{itemId}\/variations\/{variationId}": {
"delete": {
"summary": "Delete a variation",
"description": "Delete a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a variation",
"description": "Get a variation. The ID of the item and the ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Variation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified variation information in the results. The following parameters are available:
- properties<\/b> = The properties linked to the variation<\/li>
- variationProperties<\/b> = The properties linked to the variation<\/li>
- variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li>
- variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li>
- variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li>
- variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li>
- marketItemNumbers<\/b> = The market ident number of the variation<\/li>
- variationCategories<\/b> = The categories linked to the variation<\/li>
- variationClients<\/b> = The clients (stores) for which the variation is activated<\/li>
- variationMarkets<\/b> = The markets for which the variation is activated <\/li>
- variationDefaultCategory<\/b> = The default category of the variation<\/li>
- variationSuppliers<\/b> = The supplier data associated with the variation<\/li>
- variationWarehouses<\/b> = The warehouse data associated with the variation<\/li>
- images<\/b> = The images linked to the variation<\/li>
- itemImages<\/b> = The images linked to the item<\/li>
- variationAttributeValues<\/b> = The attribute values of the variation<\/li>
- variationSkus<\/b> = The SKU data associated with the variation<\/li>
- variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li>
- unit<\/b> = The unit assigned to the variation<\/li>
- parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li>
- item<\/b> = The item of the variation<\/li>
- stock<\/b> = The stock data of the variation<\/li><\/ul> For example, specifying the parameters variationCategories and variationDefaultCategory will include the default category and all other categories the variations are linked to. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a variation",
"description": "Updates a variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Variation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{itemId}\/variations\/{variationId}",
"schema": {
"type": "object",
"required": [
"itemId",
"barcodeId",
"code",
"salesPriceId",
"price",
"categoryId",
"plentyId",
"marketId",
"branchId",
"purchasePrice",
"warehouseId",
"valueId",
"unit",
"crossItemId",
"relationship",
"profileId",
"lang",
"componentVariationId",
"componentQuantity",
"sku",
"propertyId",
"text",
"isVisibleForContact"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the comment optional"
},
"isMain": {
"type": "boolean",
"description": "Flag that indicates if the variation is the main variation of the item. optional"
},
"mainVariationId": {
"type": "integer",
"description": "The variation ID of the item's main variation. Value is NULL if this variation is the item's main variation. optional"
},
"itemId": {
"type": "integer",
"description": "The item ID of the item that this variation belongs to."
},
"position": {
"type": "integer",
"description": "The position of the market ident number (ASIN\/ePID)"
},
"isActive": {
"type": "boolean",
"description": "Flag that indicates if the item is ready for export (currently not in use). optional"
},
"number": {
"type": "string",
"description": "The unique variation number of the variation. The variation number must be specified. optional"
},
"model": {
"type": "string",
"description": "The model of the variation. Value is inherited from the item's main variation if inheritance is active. optional"
},
"externalId": {
"type": "string",
"description": "The external variation ID of this variation. The external variation number is optional and allows importing items and variations from external systems to plentymarkets. optional"
},
"availability": {
"type": "integer",
"description": "The availability of the variation. Possible values: 1 to 10, null = Variation inherits value of main variation. optional"
},
"estimatedAvailableAt": {
"type": "string",
"description": "The estimated delivery date of variations on reorder. optional"
},
"purchasePrice": {
"type": "number",
"description": "The price at which the variation was purchased from this supplier."
},
"movingAveragePrice": {
"type": "number",
"description": "The moving average purchase price of the variation. optional"
},
"createdAt": {
"type": "string",
"description": "The time the variation was created. optional"
},
"updatedAt": {
"type": "string",
"description": "The time the variation was last updated. optional"
},
"relatedUpdatedAt": {
"type": "string",
"description": "The time at which related information for this variation was last updated. Related information is defined as information that is linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. optional"
},
"priceCalculationId": {
"type": "integer",
"description": "The ID of the price calculation linked to the variation. optional"
},
"picking": {
"type": "string",
"description": "The order picking type of the variation. Possible values: single_picking, no_single_picking, exclude_from_picklist, null (no order picking type) optional allowed values are single_picking, no_single_picking, exclude_from_picklist"
},
"stockLimitation": {
"type": "integer",
"description": "The stock limitation for the variation. Possible values: 0 = No limitation, i.e. stock is not limited. The variations's availability is not checked automatically.1 = Stock is limited to net stock. The variation's availability is checked automatically.2 = Do not administer stock for this variation. optional allowed values are 0, 1, 2"
},
"isVisibleIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is visible in the online store if net stock is positive. If true, the variation automatically becomes visible when the net stock changes to positive. optional"
},
"isInvisibleIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is invisible in the online store if net stock is not positive. If true, the variation automatically becomes invisible when the net stock changes to 0 or negative. optional"
},
"isAvailableIfNetStockIsPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is available in the online store if net stock is positive. If true, the variation automatically becomes available when the net stock changes to positive. optional"
},
"isUnavailableIfNetStockIsNotPositive": {
"type": "boolean",
"description": "Flag that indicates if the variation is unavailable in the online store if net stock is not positive. If true, the variation automatically becomes available when the net stock changes to 0 or negative. optional"
},
"mainWarehouseId": {
"type": "integer",
"description": "The ID of the main warehouse of the variation. optional"
},
"maximumOrderQuantity": {
"type": "number",
"description": "The maximum order quantity permitted per order. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited. optional"
},
"minimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity. Decimal values are possible to allow orders by weight or length. optional"
},
"intervalOrderQuantity": {
"type": "number",
"description": "The quantity intervals the variation can be ordered in. Decimal values are possible to allow orders by weight or length. optional"
},
"availableUntil": {
"type": "string",
"description": "The last date the item will be available for sale. optional"
},
"releasedAt": {
"type": "string",
"description": "The release date of the variation. This is the date on which the variation will become available. The variation can be visible in the online store before this date, e.g. for preorders. optional"
},
"name": {
"type": "string",
"description": "The default name of the item. By default, this name is displayed in the online store. For Default items, this name is also used for markets. Character limit: max. 240 characters. optional"
},
"weightG": {
"type": "integer",
"description": "The gross weight of the variation in gramms (g). This weight includes the packaging for variations that are packaged separately. This value is used for calculating shipping packages and weight-based shipping costs. optional"
},
"weightNetG": {
"type": "integer",
"description": "The net weight of the variation in gramms (g). This is the weight of the variation without packaging. optional"
},
"widthMM": {
"type": "integer",
"description": "The width of the variation in millimetres (mm) optional"
},
"lengthMM": {
"type": "integer",
"description": "The length of the variation in millimeters (mm) optional"
},
"heightMM": {
"type": "integer",
"description": "The height of the variation in millimetres (mm) optional"
},
"extraShippingCharge1": {
"type": "number",
"description": "The extra shipping charge 1 for the variation. Extra shipping charges are useful for large or bulky items that are particularly expensive to ship. Charge 1 is added to the regular shipping costs for the first item of an order. If different variations are ordered, the extra shipping charge 1 of the variation with the highest charge 1 is selected. optional"
},
"extraShippingCharge2": {
"type": "number",
"description": "The extra shipping charge 2 for the variation. Extra shipping charges are useful for large or bulky items that are expensive to ship. Charge 2 is added to the shipping costs for any additional items of an order. optional"
},
"unitsContained": {
"type": "integer",
"description": "The number of sales units contained in one package. Default value is 1. optional"
},
"palletTypeId": {
"type": "integer",
"description": "The ID of the pallet type optional"
},
"packingUnits": {
"type": "integer",
"description": "The number of packing units if the item consists of multiple packages. Value is 0 if an item is sent as one package. All items of an order that have the value 0 will be packed into one package. optional"
},
"packingUnitTypeId": {
"type": "integer",
"description": "The ID of the packing unit type. optional"
},
"transportationCosts": {
"type": "number",
"description": "The net transportation costs for the variation. This value is used for price calculations and for calculating the acquisition price. optional"
},
"storageCosts": {
"type": "number",
"description": "The net storage costs for the variation optional"
},
"customs": {
"type": "number",
"description": "The customs rate in percent optional"
},
"operatingCosts": {
"type": "number",
"description": "The operating costs for the variation in percent optional"
},
"vatId": {
"type": "integer",
"description": "The ID of the VAT rate of the variation. VAT rates are created for each client (store) and linked to the variation. optional allowed values are 0, 1, 2, 3"
},
"bundleType": {
"type": "string",
"description": "Indicates the bundle type of the variation. Possible values:bundle = The variation is a bundlebundle_item = The variation is a bundle component.Null = The variation is not associated with a bundle optional allowed values are bundle, bundle_item"
},
"automaticClientVisibility": {
"type": "integer",
"description": "Indicates if the variation is set as available for any clients (stores). Possible values:0 \/ -1 (GET) or 0 (POST) = Variation is not available in any client (store).1 \/ 2 (GET) or 1 (POST) = Variation is available in at least one client (store).The variation's actual visibility depends on the settings for net stock dependency. optional allowed values are -1, 0, 1, 2"
},
"isHiddenInCategoryList": {
"type": "boolean",
"description": "Flag that indicates if the variation is hidden in the category list. If true, the variation will not be shown in any item category and will not be returned as a search result. The variation can only be accessed via its URL. optional"
},
"mayShowUnitPrice": {
"type": "boolean",
"description": "Display unit price in the online store optional"
},
"hasCalculatedBundleWeight": {
"type": "boolean",
"description": "Indicates if the gross bundle weight is calculated by its components. optional"
},
"hasCalculatedBundleNetWeight": {
"type": "boolean",
"description": "Indicates if the net bundle weight is calculated by its components. optional"
},
"hasCalculatedBundlePurchasePrice": {
"type": "boolean",
"description": "Indicates if the net purchase price is calculated by its components. optional"
},
"hasCalculatedBundleMovingAveragePrice": {
"type": "boolean",
"description": "Indicates if the moving average net purchase price is calculated by its components. optional"
},
"customsTariffNumber": {
"type": "string",
"description": "The customs tariff number of the variation; usually a 11 digit code number based on the Harmonised System optional"
},
"categoryVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Categories are not inherited from the main variation.ID of the item's main variation = Inheritance of categories is active. optional"
},
"marketVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Markets are not inherited from the main variation.ID of the item's main variation = Inheritance of markets is active. optional"
},
"clientVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Clients (stores) are not inherited from the main variation.ID of the item's main variation = Inheritance of clients (stores) is active. optional"
},
"salesPriceVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Sales prices are not inherited from the main variation.ID of the item's main variation = Inheritance of sales prices is active. optional"
},
"supplierVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Suppliers are not inherited from the main variation.ID of the item's main variation = Inheritance of suppliers is active. optional"
},
"warehouseVariationId": {
"type": "integer",
"description": "Either the ID of the variation or the ID of the item's main variation. No other values are permitted.ID of the variation = Warehouses are not inherited from the main variation.ID of the item's main variation = Inheritance of warehouses is active. optional"
},
"variationBarcodes": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBarcode"
}
},
"barcodeId": {
"type": "integer",
"description": "The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique."
},
"code": {
"type": "string",
"description": "The code of the variation's barcode. The combination of code and barcode ID must be unique."
},
"variationSalesPrices": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSalesPrice"
}
},
"salesPriceId": {
"type": "integer",
"description": "The unique ID of the sales price"
},
"price": {
"type": "number",
"description": "The price of the variation saved for this sales price"
},
"variationCategories": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationCategory"
}
},
"categoryId": {
"type": "integer",
"description": "The unique ID of the category"
},
"isNeckermannPrimary": {
"type": "string",
"description": "Flag that indicates if the category is the primary category for the market Neckermann for this variation. optional"
},
"variationClients": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationClient"
}
},
"plentyId": {
"type": "integer",
"description": "The unique plenty ID of the client (store)"
},
"variationMarkets": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarket"
}
},
"marketId": {
"type": "number",
"description": "The ID of the market reference."
},
"variationDefaultCategory": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDefaultCategory"
}
},
"branchId": {
"type": "integer",
"description": "The unique ID of the category branch"
},
"variationSuppliers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSupplier"
}
},
"supplierId": {
"type": "integer",
"description": "The unique ID of the supplier optional"
},
"itemNumber": {
"type": "string",
"description": "The external item number assigned to the variation by this supplier optional"
},
"lastPriceQuery": {
"type": "string",
"description": "The date of the last price query to this supplier. This helps to plan price negotiations. optional"
},
"discount": {
"type": "number",
"description": "The discount in percent the supplier grants for the variation. optional"
},
"isDiscountable": {
"type": "string",
"description": "Flag that indicates if the supplier's discount for this variation is active. optional"
},
"packagingUnit": {
"type": "number",
"description": "The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets. optional"
},
"variationWarehouses": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationWarehouse"
}
},
"warehouseId": {
"type": "integer",
"description": "The unique ID of the warehouse"
},
"warehouseZoneId": {
"type": "integer",
"description": "The unique ID of the warehouse zone optional"
},
"storageLocationType": {
"type": "string",
"description": "The storage location type of the warehouse optional allowed values are none, small, medium, large, europallet"
},
"reorderLevel": {
"type": "integer",
"description": "The reorder level for the variation in this warehouse optional"
},
"maximumStock": {
"type": "integer",
"description": "The maximum stock for the variation in this warehouse optional"
},
"stockTurnoverInDays": {
"type": "integer",
"description": "The stock turnover in days for the variation in this warehouse optional"
},
"storageLocation": {
"type": "integer",
"description": "The storage location of the variation in this warehouse optional"
},
"stockBuffer": {
"type": "integer",
"description": "The stock buffer for the variation in this warehouse optional"
},
"variationAttributeValues": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AttributeValueSet"
}
},
"valueId": {
"type": "integer",
"description": "The ID of the attribute value"
},
"unit": {
"type": "array",
"items": {
"$ref": "#\/definitions\/UnitCombination"
}
},
"parentVariationId": {
"type": "integer",
"description": "optional"
},
"parentVariationQuantity": {
"type": "number",
"description": "optional"
},
"item": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ImagesRelation"
}
},
"itemCrossSelling": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemCrossSelling"
}
},
"crossItemId": {
"type": "integer",
"description": "The unique ID of the cross-selling item that is linked to the item"
},
"relationship": {
"type": "string",
"description": "The cross-selling relationship between item and cross-selling item. Possible values:Accessory = The cross-selling item is an accessory of the item.ReplacementPart = The cross-selling item is a replacement part for the item.Similar = The cross-selling item is similar to the item.Bundle = The cross-selling item is suitable to be sold as a bundle with the item. allowed values are Variation, DisplaySet, Collection, Accessory, Customized, Part, Complements, Piece, Necessary, ReplacementPart, Similar, Episode, Season, Bundle, Component"
},
"isDynamic": {
"type": "boolean",
"description": "Flag that indicates if the cross-selling link was generated automatically. optional"
},
"itemShippingProfiles": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemShippingProfiles"
}
},
"profileId": {
"type": "integer",
"description": "The unique ID of the shipping profile"
},
"variationTexts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationDescription"
}
},
"lang": {
"type": "string",
"description": "The language code of the description"
},
"name2": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"name3": {
"type": "string",
"description": "Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. optional"
},
"previewDescription": {
"type": "string",
"description": "The preview text. The preview text is a short description that can be displayed in item lists. optional"
},
"metaDescription": {
"type": "string",
"description": "The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters. optional"
},
"description": {
"type": "string",
"description": "The item description. This is a detailed description displayed in the item layout of the online store. optional"
},
"technicalData": {
"type": "string",
"description": "The technical data for the item. To display the technical data in the online store, insert the template variable TechnicalData and an optional title into the template ItemViewSingleItem. optional"
},
"urlPath": {
"type": "string",
"description": "The URL path of the item in the online store. By default, the URL path consists of the categories and the item name. The path will be assigned automatically by plentymarkets when the item is created and will be displayed as part of the URL when the item is selected in the online store. optional"
},
"metaKeywords": {
"type": "string",
"description": "Meta keywords to tag the item for search engines. More than one keyword can be separated by commas. optional"
},
"images": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImagesRelation"
}
},
"itemImages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemImagesRelation"
}
},
"variationBundleComponents": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationBundle"
}
},
"componentVariationId": {
"type": "integer",
"description": "The unique ID of the variation added as bundle component with componentQuantity"
},
"componentQuantity": {
"type": "integer",
"description": "The quantity of the variation to be added as bundle component with componentVariationId"
},
"marketItemNumbers": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationMarketIdentNumber"
}
},
"countryId": {
"type": "integer",
"description": "The country code of the market ident number (ASIN\/ePID)"
},
"type": {
"type": "string",
"description": "The type of market ident number (ASIN\/ePID) allowed values are ASIN, EPID, UPC, RSIN"
},
"value": {
"type": "string",
"description": "The value of the market ident number (ASIN\/ePID)"
},
"variationSkus": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationSku"
}
},
"accountId": {
"type": "integer",
"description": "The ID of the market account"
},
"sku": {
"type": "string",
"description": "The additional sku for this variation."
},
"initialSku": {
"type": "string",
"description": "The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU. optional"
},
"parentSku": {
"type": "string",
"description": "The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article. optional"
},
"status": {
"type": "string",
"description": "The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE. optional allowed values are ACTIVE, INACTIVE, ERROR, SENT"
},
"additionalInformation": {
"type": "string",
"description": "The field that contains additional information. optional"
},
"variationAdditionalSkus": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationAdditionalSku"
}
},
"marketAccountId": {
"type": "integer",
"description": "The ID of the market account."
},
"properties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelation"
}
},
"propertyId": {
"type": "integer",
"description": "The unique ID of the property"
},
"selectionRelationId": {
"type": "integer",
"description": "The ID of the selection relation optional"
},
"variationProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValue"
}
},
"propertySelectionId": {
"type": "integer",
"description": "The unique ID of the property selection of the variation optional"
},
"valueInt": {
"type": "integer",
"description": "The int value of the property value of the variation optional"
},
"valueFloat": {
"type": "number",
"description": "The float value of the property value of the variation optional"
},
"valueFile": {
"type": "string",
"description": "The file value of the property value of the variation optional"
},
"tags": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Comment"
}
},
"userId": {
"type": "integer",
"description": "The ID of the user optional"
},
"text": {
"type": "string",
"description": "The comment text"
},
"isVisibleForContact": {
"type": "boolean",
"description": "If true, the comment is visible for the associated contact."
}
}
}
}
]
}
},
"\/rest\/items\/{itemId}\/variations\/{variationId}\/fill": {
"post": {
"summary": "Fill a variation",
"description": "Fills a variation. The ID of the variation must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/items\/{itemId}\/variations\/{variationId}\/variation_properties\/{propertyId}\/texts": {
"get": {
"summary": "Get property value texts",
"description": "Gets the texts saved for a specific property of the type Text in all available languages. The ID of the property must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create property value text by language",
"description": "Saves text for a specific property of the type Text in the specified language. The ID of the property and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{itemId}\/variations\/{variationId}\/variation_properties\/{propertyId}\/texts",
"schema": {
"type": "object",
"required": [
"valueId",
"lang"
],
"properties": {
"valueId": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property"
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
}
},
"\/rest\/items\/{itemId}\/variations\/{variationId}\/variation_properties\/{propertyId}\/texts\/{lang}": {
"delete": {
"summary": "Delete property value text by language",
"description": "Deletes the text saved for a specific property of the type Text in the specified language. The ID of the property and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get property value text by language",
"description": "Gets the value text saved for a specific property of the type Text in the specified language. The ID of the property and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update property value text by language",
"description": "Updates the text saved for a specific property of the type Text in the specified language. The ID of the property and the language must be specified.",
"tags": [
"Item"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/VariationPropertyValueText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/items\/{itemId}\/variations\/{variationId}\/variation_properties\/{propertyId}\/texts\/{lang}",
"schema": {
"type": "object",
"required": [
"valueId",
"lang"
],
"properties": {
"valueId": {
"type": "integer",
"description": "The unique ID of the link between the variation and the property"
},
"lang": {
"type": "string",
"description": "The language of the property value text"
},
"value": {
"type": "string",
"description": "The text saved for the property of the type Text optional"
}
}
}
}
]
}
},
"\/rest\/languages\/translations": {
"post": {
"summary": "Create a new translation",
"description": "Creates a new translation.",
"tags": [
"PluginMultilingualism"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginTranslation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$pluginName",
"type": "string",
"required": true,
"description": "The name of the plugin",
"format": "string",
"in": "query"
},
{
"name": "$languageCode",
"type": "string",
"required": true,
"description": "The language code for the translation",
"format": "string",
"in": "query"
},
{
"name": "$key",
"type": "string",
"required": true,
"description": "The translation key",
"format": "string",
"in": "query"
},
{
"name": "$value",
"type": "string",
"required": true,
"description": "The value of the translation",
"format": "string",
"in": "query"
},
{
"name": "$fileName",
"type": "string",
"required": true,
"description": "The of the file",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/languages\/translations\/{translationId}": {
"delete": {
"summary": "Delete a translation",
"description": "Deletes a translation. The ID of the translation must be specified.",
"tags": [
"PluginMultilingualism"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$translationId",
"type": "integer",
"required": true,
"description": "The ID of the translation",
"format": "integer",
"in": "query"
},
{
"name": "translationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a translation",
"description": "Gets a translation. The ID of the translation must be specified.",
"tags": [
"PluginMultilingualism"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginTranslation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$id",
"type": "integer",
"required": true,
"description": "The ID of the translation",
"format": "integer",
"in": "query"
},
{
"name": "translationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a translation",
"description": "Updates a translation. The ID of the translation must be specified",
"tags": [
"PluginMultilingualism"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginTranslation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$id",
"type": "integer",
"required": true,
"description": "The ID of the translation",
"format": "integer",
"in": "query"
},
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$pluginName",
"type": "string",
"required": true,
"description": "The name of the plugin",
"format": "string",
"in": "query"
},
{
"name": "$languageCode",
"type": "string",
"required": true,
"description": "The language code for the translation",
"format": "string",
"in": "query"
},
{
"name": "$key",
"type": "string",
"required": true,
"description": "The translation key",
"format": "string",
"in": "query"
},
{
"name": "$value",
"type": "string",
"required": true,
"description": "The value of the translation",
"format": "string",
"in": "query"
},
{
"name": "$fileName",
"type": "string",
"required": true,
"description": "The value of the translation",
"format": "string",
"in": "query"
},
{
"name": "translationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/legalinformation\/{plentyId}\/{lang}\/{type}": {
"get": {
"summary": "Get legal information of an online store",
"description": "Gets legal information of an online store. The plenty ID of the store , the language and the type of legal information must be specified. The language must be specified as ISO 639-1 code.",
"tags": [
"LegalInformation"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/LegalInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "The plenty ID of the online store.",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The language of the legal information text. The language must be specified as ISO 639-1 code, e.g. en for English",
"format": "string",
"in": "path"
},
{
"name": "type",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Save legal information for an online store",
"description": "Saves a legal information for an online store. The plenty ID of the online store, the language of the legal information and the type of the legal information must be specified. The language must be specified as ISO 639-1 code.\nExisting legal information will be overwritten.",
"tags": [
"LegalInformation"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/LegalInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "The plenty ID of the online store",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The language of the legal information text. The language must be specified as ISO 639-1 code, e.g. en for English",
"format": "string",
"in": "path"
},
{
"name": "type",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/legalinformation\/{plentyId}\/{lang}\/{type}",
"schema": {
"type": "object",
"required": [
"lang",
"type"
],
"properties": {
"plentyId": {
"type": "integer",
"description": "The unique identifier of the plenty client optional"
},
"lang": {
"type": "string",
"description": "The language of the legal information text allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn"
},
"type": {
"type": "string",
"description": "The type of the legal information text. The types available are:\n\nTermsConditions\nCancellationRights\nPrivacyPolicy\nLegalDisclosure\nWithdrawalForm\n allowed values are TermsConditions, CancellationRights, PrivacyPolicy, LegalDisclosure, WithdrawalForm"
},
"plainText": {
"type": "string",
"description": "The text value of the legal information text optional"
},
"htmlText": {
"type": "string",
"description": "The html value of the legal information text optional"
}
}
}
}
]
}
},
"\/rest\/listings": {
"get": {
"summary": "List listing",
"description": "Lists listings by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Listing",
"items": {
"$ref": "#\/definitions\/Listing"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listings with specific listing ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listings with specific item ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "typeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listings with specific type ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "stockDependenceTypeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listings with specific stock dependence type ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "unitCombinationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listings with specific unit combination ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. One of 'stockDependenceType', 'type', 'markets', 'properties'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create new listing",
"description": "Creates a new listing.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Listing"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings",
"schema": {
"type": "object",
"required": [
"itemId",
"typeId",
"stockDependenceTypeId",
"unitCombinationId"
],
"properties": {
"itemId": {
"type": "integer",
"description": "The ID of the item."
},
"typeId": {
"type": "integer",
"description": "The ID of the listing type. Possible types are:\n\n 1 = Auction\n 2 = Fixed\n 3 = Shop item\n allowed values are 1, 2, 3"
},
"stockDependenceTypeId": {
"type": "integer",
"description": "The ID of the listing stock dependence. Possible stock dependence types are:\n\n 1 = Unlimited with sync\n 2 = Limited with reservation\n 3 = Limited without reservation\n 4 = Unlimited without sync\n allowed values are 1, 2, 3, 4"
},
"unitCombinationId": {
"type": "integer",
"description": "The ID of the unit combination."
},
"properties": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/layout_templates": {
"post": {
"summary": "Create new layout template",
"description": "Creates a new layout template.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/LayoutTemplate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/layout_templates",
"schema": {
"type": "object",
"required": [
"name",
"htmlStructure",
"mainFrame",
"appendixType"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the layout template."
},
"css": {
"type": "string",
"description": "The css of the layout template. optional"
},
"htmlStructure": {
"type": "string",
"description": "The html structure of the layout template."
},
"mainFrame": {
"type": "string",
"description": "The main frame of the layout template."
},
"appendixType": {
"type": "string",
"description": "The appendix type of the layout template. allowed values are withoutLogo, withPrivacyPolicy, standard"
},
"additionalContent": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/layout_templates\/{id}": {
"delete": {
"summary": "Delete a layout template",
"description": "Deletes a layout template by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The layout template ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a layout template",
"description": "Gets a layout template by providing its ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/LayoutTemplate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the layout template entry.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/listings\/markets": {
"get": {
"summary": "List listing markets",
"description": "Lists listing market by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarket",
"items": {
"$ref": "#\/definitions\/ListingMarket"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that match the given ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that match the given variation ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "variations",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets with a custom variation condition. Available values are 'all', 'fixed'.",
"format": "string",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with given referrer ID.",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with given credential ID.",
"format": "integer",
"in": "query"
},
{
"name": "directoryId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with a given directory ID.",
"format": "integer",
"in": "query"
},
{
"name": "verified",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets that are verified. Available values are 'succeeded','unknown' or 'failed'.",
"format": "string",
"in": "query"
},
{
"name": "duration",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets with given duration.",
"format": "string",
"in": "query"
},
{
"name": "listingId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a given listing ID.",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a given item ID.",
"format": "integer",
"in": "query"
},
{
"name": "listingTypeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a listing of a custom type ID. Available values are:\n
\n - 1 - Auction<\/li>\n
- 2 - Fixed price<\/li>\n
- 3 - Shop (only for Hood listings)<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "stockDependenceTypeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a listing with a custom stock dependence type ID. Available values are:\n
\n - 1 - Unlimited stock with automatic synchronisation<\/li>\n
- 2 - Limited and reserved stock<\/li>\n
- 3 - Limited and unreserved stock<\/li>\n
- 4 - Unlimited stock without automatich synchronisation<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "status",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets with a custom status condition. Available values are 'enabled', 'disabled', 'online', 'offline'",
"format": "string",
"in": "query"
},
{
"name": "stockCondition",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets with a custom stock condition. Available values are 'stockNetLessEqualZero', 'stockNetLessZero', 'stockNetGreaterZero', 'stockGrossLessEqualZero', 'stockGrossLessZero', 'stockGrossGreaterZero', 'stockNetTotalLessEqualZero', 'stockNetTotalLessZero', 'stockNetTotalGreaterZero'",
"format": "string",
"in": "query"
},
{
"name": "shippingProfileId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a given shipping profile ID",
"format": "integer",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Valid instances are 'listing', 'texts', 'properties', 'prices', 'dates', 'infos'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create new listing market",
"description": "Creates a new listing market. Based on the given options this call can create multiple listing markets. If the\n'optionTemplateId' parameter is provided and the listing option template includes options for different markets\nthan one listing market will be created for each market.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ListingMarket"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/markets",
"schema": {
"type": "object",
"required": [
"listing"
],
"properties": {
"listingId": {
"type": "integer",
"description": "The listing ID of the current listing market."
},
"optionTemplateId": {
"type": "integer",
"description": "The ID of an existing listing option template from where to load listing market settings. @see OptionTemplate."
},
"referrerId": {
"type": "integer",
"description": "The ID of the referrer. array"
},
"listing": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ListingMarketHistory"
}
},
"properties": {
"type": "array",
"items": {}
},
"prices": {
"type": "array",
"items": {}
},
"texts": {
"type": "array",
"items": {}
},
"itemSpecifics": {
"type": "array",
"items": {}
},
"dates": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/directories": {
"get": {
"summary": "Get all listing market directories",
"description": "Gets all listing market directories.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ListingMarketDirectory"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create listing market directory",
"description": "Creates a listing market directory.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketDirectory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/markets\/directories",
"schema": {
"type": "object",
"required": [
"name",
"parentId",
"level"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the listing market directory."
},
"parentId": {
"type": "integer",
"description": "The parent ID of the listing market directory. optional with level"
},
"level": {
"type": "integer",
"description": "The level of the directory. optional with parentId"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/directories\/{id}": {
"delete": {
"summary": "Delete listing market directory",
"description": "Deletes a listing market directory by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The listing market directory ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a listing market directory",
"description": "Gets a listing market directory by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketDirectory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing market directory entry.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update listing market directory",
"description": "Updates a listing market directory by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketDirectory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The listing market directory ID.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/listings\/markets\/directories\/{id}",
"schema": {
"type": "object",
"required": [
"id",
"parentId",
"level"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the listing market directory."
},
"name": {
"type": "string",
"description": "The name of the listing market directory. optional"
},
"parentId": {
"type": "integer",
"description": "The parent ID of the listing market directory. optional with level"
},
"level": {
"type": "integer",
"description": "The level of the directory. optional with parentId"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/find": {
"get": {
"summary": "Find listing markets",
"description": "Lists listing market by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarket",
"items": {
"$ref": "#\/definitions\/ListingMarket"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that match the given ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "variations",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets with a custom variation condition. Available values are 'all', 'fixed'.",
"format": "string",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with given referrer ID.",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with given credential ID.",
"format": "integer",
"in": "query"
},
{
"name": "directoryId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets with a given directory ID.",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a given item ID.",
"format": "integer",
"in": "query"
},
{
"name": "shippingProfileId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing markets that belong to a given shipping profile ID",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Valid instances are 'listing', 'texts', 'properties', 'prices', 'dates', 'infos'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/markets\/histories": {
"get": {
"summary": "List listing market history",
"description": "Lists listing market history by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarketHistory",
"items": {
"$ref": "#\/definitions\/ListingMarketHistory"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "listingMarketId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that match the given listing market ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that match the given variation ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "variations",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with a custom variation condition. Available values are 'all', 'fixed'.",
"format": "string",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories with given referrer ID.",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories with given credential ID.",
"format": "integer",
"in": "query"
},
{
"name": "directoryId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories with a given directory ID.",
"format": "integer",
"in": "query"
},
{
"name": "verified",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that are verified. Available values are 'succeeded','unknown' or 'failed'.",
"format": "string",
"in": "query"
},
{
"name": "duration",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with given duration.",
"format": "string",
"in": "query"
},
{
"name": "externalId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with given external id.",
"format": "string",
"in": "query"
},
{
"name": "listingId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to a given listing ID.",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to a given item ID.",
"format": "integer",
"in": "query"
},
{
"name": "listingTypeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to a listing of a custom type ID. Available values are:\n
\n - 1 - Auction<\/li>\n
- 2 - Fixed price<\/li>\n
- 3 - Shop (only for Hood listings)<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "stockDependenceTypeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to a listing with a custom stock dependence type ID. Available values are:\n
\n - 1 - Unlimited stock with automatic synchronisation<\/li>\n
- 2 - Limited and reserved stock<\/li>\n
- 3 - Limited and unreserved stock<\/li>\n
- 4 - Unlimited stock without automatich synchronisation<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "statusId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market histories with a custom status status ID. Available values are:\n
\n - 1 - Active listing market histories<\/li>\n
- 2 - Ended listing market histories<\/li>\n
- 3 - Relisted listing market histories<\/li>\n
- 4 - Hidden listing market histories<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "stockCondition",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with a custom stock condition. Available values are 'stockNetLessEqualZero', 'stockNetLessZero', 'stockNetGreaterZero', 'stockGrossLessEqualZero', 'stockGrossLessZero', 'stockGrossGreaterZero', 'stockNetTotalLessEqualZero', 'stockNetTotalLessZero', 'stockNetTotalGreaterZero'",
"format": "string",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "textData",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that match given text in listing title or description.",
"format": "string",
"in": "query"
},
{
"name": "firstPlatformCategoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with first platform category ID equal to the given ID.",
"format": "string",
"in": "query"
},
{
"name": "secondPlatformCategoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with second platform category ID equal to the given ID.",
"format": "string",
"in": "query"
},
{
"name": "firstShopCategoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with first shop category ID equal to the given ID.",
"format": "string",
"in": "query"
},
{
"name": "secondShopCategoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with second shop category ID equal to the given ID.",
"format": "string",
"in": "query"
},
{
"name": "thirdShopCategoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with third shop category ID equal to the given ID.",
"format": "string",
"in": "query"
},
{
"name": "shippingProfileId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to a given shipping profile.",
"format": "string",
"in": "query"
},
{
"name": "lastSale",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories with last sale before given date.The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "isEbayPlus",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to eBay Plus.",
"format": "string",
"in": "query"
},
{
"name": "isClickAndCollect",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market histories that belong to eBay Click & Collect.",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Valid instances are 'listingMarket', 'texts', 'properties', 'prices', 'dates'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/markets\/histories\/{id}": {
"get": {
"summary": "Get a listing market history",
"description": "Gets a listing market history by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketHistory"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing market history entry.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. One of 'listingMarket', 'texts', 'properties', 'dates', 'variations'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/markets\/infos": {
"get": {
"summary": "Search listing market info",
"description": "Search listing market info by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarketInfo",
"items": {
"$ref": "#\/definitions\/ListingMarketInfo"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market info that match the given ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "listingMarketId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market info that match the given listing market ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market info with a custom type. Available values are 'warning', 'error', 'info'.",
"format": "string",
"in": "query"
},
{
"name": "code",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market info with given codes.",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing markets that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/markets\/item_specifics": {
"get": {
"summary": "Gets all ListingMarketItemSpecifics.",
"description": "Can be filtered by ID, listingMarketId, name and value.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketItemSpecific"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/markets\/item_specifics",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the item specific. optional"
},
"listingMarketId": {
"type": "integer",
"description": "The LMID which belongs to the item specific ID. optional"
},
"name": {
"type": "string",
"description": "The name of the item specific. optional"
},
"value": {
"type": "string",
"description": "The value of the item specific. optional"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/item_specifics\/find": {
"get": {
"summary": "Gets all ListingMarketItemSpecifics.",
"description": "Can be filtered by ID, listingMarketId, name and value.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarketItemSpecific",
"items": {
"$ref": "#\/definitions\/ListingMarketItemSpecific"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/markets\/item_specifics\/find",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the item specific. optional"
},
"listingMarketId": {
"type": "integer",
"description": "The LMID which belongs to the item specific ID. optional"
},
"name": {
"type": "string",
"description": "The name of the item specific. optional"
},
"value": {
"type": "string",
"description": "The value of the item specific. optional"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/item_specifics\/{id}": {
"delete": {
"summary": "Deletes a ListingMarketItemSpecific.",
"description": "The ID has to be specified.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Gets a ListingMarketItemSpecific.",
"description": "The ID has to be specified.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketItemSpecific"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Updates a ListingMarketItemSpecific.",
"description": "The ID has to be specified.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketItemSpecific"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/listings\/markets\/item_specifics\/{id}",
"schema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the item specific."
},
"listingMarketId": {
"type": "integer",
"description": "The LMID which belongs to the item specific ID. optional"
},
"name": {
"type": "string",
"description": "The name of the item specific. optional"
},
"value": {
"type": "string",
"description": "The value of the item specific. optional"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/texts": {
"get": {
"summary": "List listing market texts",
"description": "Lists listing market texts by filter options.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingMarketText",
"items": {
"$ref": "#\/definitions\/ListingMarketText"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market texts with specific ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "listingMarketId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing market texts with specific listing market IDs. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "language",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market texts for a specific language. @see listing market text model language for the complete available list of language types.",
"format": "string",
"in": "query"
},
{
"name": "contains",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to listing market texts which title, subtitle or description contain the given value.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a listing market text",
"description": "Creates a listing market text for a given listing market ID. If an entry with same data already exists the request will be ignored and the old entry will be returned.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "listingMarketId",
"type": "integer",
"required": true,
"description": "The listing market ID this text belongs to.",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/listings\/markets\/texts",
"schema": {
"type": "object",
"required": [
"listingMarketId",
"lang",
"title"
],
"properties": {
"listingMarketId": {
"type": "integer",
"description": "The ID of the listing market the text belongs to."
},
"lang": {
"type": "string",
"description": "The language of the listing market text. Available values: 'de', 'en', 'fr', 'it', 'es', 'tr', 'nl', 'pl', 'nn', 'da', 'se', 'cz', 'ru', 'sk', 'cn', 'vn', 'pt', 'bg', 'ro'."
},
"title": {
"type": "string",
"description": "The title of the listing market text."
},
"subtitle": {
"type": "string",
"description": "The subtitle of the listing market text. optional"
},
"description": {
"type": "string",
"description": "The description of the listing market text. optional"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/texts\/{id}": {
"delete": {
"summary": "Delete a listing market text",
"description": "Deletes a listing market text for a given listing market text ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "lang",
"type": "string",
"required": true,
"description": "The listing market text language that should be updated.",
"format": "string",
"in": "query"
},
{
"name": "listingMarketId",
"type": "integer",
"required": true,
"description": "The listing market ID this text belongs to.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a listing market text",
"description": "Gets a listing market text by providing its ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing market text entry.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/listings\/markets\/texts\/{listingMarketId}\/{lang}": {
"put": {
"summary": "Update a listing market text",
"description": "Updates a listing market text for a given listing market ID and language.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarketText"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "listingMarketId",
"type": "integer",
"required": true,
"description": "The listing market ID this text belongs to.",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The listing market text language that should be updated.",
"format": "string",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/listings\/markets\/texts\/{listingMarketId}\/{lang}",
"schema": {
"type": "object",
"required": [
"listingMarketId"
],
"properties": {
"listingMarketId": {
"type": "integer",
"description": "The ID of the listing market the text belongs to."
},
"lang": {
"type": "string",
"description": "The language of the listing market text. Available values: 'de', 'en', 'fr', 'it', 'es', 'tr', 'nl', 'pl', 'nn', 'da', 'se', 'cz', 'ru', 'sk', 'cn', 'vn', 'pt', 'bg', 'ro'. optional"
},
"title": {
"type": "string",
"description": "The title of the listing market text. optional"
},
"subtitle": {
"type": "string",
"description": "The subtitle of the listing market text. optional"
},
"description": {
"type": "string",
"description": "The description of the listing market text. optional"
}
}
}
}
]
}
},
"\/rest\/listings\/markets\/{id}": {
"delete": {
"summary": "Delete listing market",
"description": "Deletes a listing market by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The listing market ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a listing market",
"description": "Gets a listing market by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing market entry.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. One of 'listing', 'texts', 'properties', 'itemSpecifics', 'prices', 'dates', 'infos'.",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update a listing market",
"description": "Updates a listing market by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The listing market ID.",
"format": "integer",
"in": "path"
},
{
"name": "referrerId",
"type": "integer",
"required": true,
"description": "The referrer ID.",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/listings\/markets\/{id}",
"schema": {
"type": "object",
"required": [
"id",
"referrerId",
"listing"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the listing market."
},
"listingId": {
"type": "integer",
"description": "The listing ID of the current listing market. optional"
},
"optionTemplateId": {
"type": "integer",
"description": "The ID of an existing listing option template from where to load listing market settings. @see OptionTemplate. optional"
},
"referrerId": {
"type": "integer",
"description": "The ID of the referrer."
},
"listing": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ListingMarketHistory"
}
},
"properties": {
"type": "array",
"items": {}
},
"prices": {
"type": "array",
"items": {}
},
"texts": {
"type": "array",
"items": {}
},
"itemSpecifics": {
"type": "array",
"items": {}
},
"dates": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/option_templates": {
"post": {
"summary": "Create option template",
"description": "Creates an option template.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OptionTemplate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/listings\/option_templates",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the option template."
},
"listing": {
"type": "array",
"items": {}
},
"marketOptions": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/option_templates\/preview": {
"get": {
"summary": "Get a preview list of option templates",
"description": "Gets a preview list of all available listing option templates.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/listings\/option_templates\/{id}": {
"delete": {
"summary": "Delete option template",
"description": "Deletes an option template by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The option template ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get option template",
"description": "Gets an option template by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OptionTemplate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the option template entry.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update option template",
"description": "Updates an option template by ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OptionTemplate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The option template ID.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/listings\/option_templates\/{id}",
"schema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the option template."
},
"name": {
"type": "string",
"description": "The name of the option template. optional"
},
"listing": {
"type": "array",
"items": {}
},
"marketOptions": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/listings\/shipping_profiles": {
"get": {
"summary": "List listing shipping profiles",
"description": "Lists listing shipping profiles.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ShippingProfile",
"items": {
"$ref": "#\/definitions\/ShippingProfile"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing shipping profiles that match the given ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing shipping profiles with given referrer ID(s).",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to listing shipping profiles with given credential ID(s).",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/shipping_profiles\/{id}": {
"get": {
"summary": "Get a shipping profile",
"description": "Gets a shipping profile by providing its ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingProfile"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing shipping profile entry.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/stock_dependence_types": {
"get": {
"summary": "List listing stock dependence types",
"description": "Lists listing stock dependence types.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StockDependenceType",
"items": {
"$ref": "#\/definitions\/StockDependenceType"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Available values: 'names'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/stock_dependence_types\/{id}": {
"get": {
"summary": "Get a listing stock dependence type",
"description": "Gets a listing stock dependence type by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StockDependenceType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing stock dependence type entry.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Available values: 'names'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/types": {
"get": {
"summary": "List listing types",
"description": "Lists all listing types.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ListingType",
"items": {
"$ref": "#\/definitions\/ListingType"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/listings\/types\/{id}": {
"get": {
"summary": "Get a listing type",
"description": "Gets a listing type by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ListingType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Available values: 'names'.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing type entry.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/listings\/{id}": {
"delete": {
"summary": "Delete a listing",
"description": "Deletes a listing by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The listing ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a listing",
"description": "Gets a listing by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Listing"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing entry.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. One of 'stockDependenceType', 'type', 'markets', 'properties'.",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update a listing",
"description": "Updates a listing by given ID.",
"tags": [
"Listing"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Listing"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the listing.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/listings\/{id}",
"schema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the listing."
},
"itemId": {
"type": "integer",
"description": "The ID of the item. optional"
},
"typeId": {
"type": "integer",
"description": "The ID of the listing type. Possible types are:\n\n 1 = Auction\n 2 = Fixed\n 3 = Shop item\n optional allowed values are 1, 2, 3"
},
"stockDependenceTypeId": {
"type": "integer",
"description": "The ID of the listing stock dependence. Possible stock dependence types are:\n\n 1 = Unlimited with sync\n 2 = Limited with reservation\n 3 = Limited without reservation\n 4 = Unlimited without sync\n optional allowed values are 1, 2, 3, 4"
},
"unitCombinationId": {
"type": "integer",
"description": "The ID of the unit combination. optional"
}
}
}
}
]
}
},
"\/rest\/login": {
"post": {
"summary": "Login",
"description": "Logs in to plentymarkets with your back end user credentials. The login call returns a JSON object that contains information, such as the access token and the refresh token.",
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/login",
"schema": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"username": {
"type": "string",
"description": "Name of the back end user"
},
"password": {
"type": "string",
"description": "Password of the back end user"
}
}
}
}
]
}
},
"\/rest\/login\/refresh": {
"post": {
"summary": "Refresh",
"description": "Refreshes the access token using the refresh token. The refresh token is part of the login call response.",
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TokenData"
}
}
}
}
},
"\/rest\/logout": {
"post": {
"summary": "Logout",
"description": "Logs out the back end user from plentymarkets. The access token expires.",
"tags": [
"Authentication"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/logs": {
"get": {
"summary": "Perform a search operation.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Log",
"items": {
"$ref": "#\/definitions\/Log"
}
},
"filters": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "integration",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to log entries with custom integration key(s).",
"format": "integer",
"in": "query"
},
{
"name": "identifier",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to log entries with custom identifier(s).",
"format": "integer",
"in": "query"
},
{
"name": "referenceType",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to log entries with custom reference types.",
"format": "string",
"in": "query"
},
{
"name": "referenceValue",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to log entries with custom reference values.",
"format": "string",
"in": "query"
},
{
"name": "additionalInfo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to log entries that match an additional info.",
"format": "string",
"in": "query"
},
{
"name": "code",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to log entries with a custom code.",
"format": "integer",
"in": "query"
},
{
"name": "level",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to log entries of a custom level. Available values are: 'debug', 'info', 'notice', 'warning', 'error', 'critical', 'alert', 'emergency'.",
"format": "integer",
"in": "query"
},
{
"name": "fromDate",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to log entries created after this date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "toDate",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to log entries created before this date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Valid instances are 'additionalInfo'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a log entry.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/logs",
"schema": {
"type": "object",
"required": [
"integration",
"identifier",
"code",
"level"
],
"properties": {
"integration": {
"type": "string",
"description": "The integration key used for the log entry. Used as a first level allocation."
},
"identifier": {
"type": "string",
"description": "The identifier used for the log entry. Used as a second level allocation."
},
"code": {
"type": "string",
"description": "The code for this current log entry. For log entries with level \"debug\", \"info\", \"notice\", \"warning\" and \"report\" this needs to have an translation in order to be stored."
},
"level": {
"type": "string",
"description": "The level this current log entry belongs to. Notice! When storing log entries with level \"report\" the entries will actually be stored as level \"info\". The difference between \"report\" and \"info\" is that log entries with level \"report\" do not need prior activation. allowed values are report, debug, info, notice, warning, error, critical, alert, emergency"
},
"referenceType": {
"type": "string",
"description": "Deprecated field, see the references field instead. optional"
},
"referenceValue": {
"type": "string",
"description": "Deprecated field, see the references field instead. optional"
},
"references": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/logs\/integration_keys": {
"get": {
"summary": "",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/logs\/reference_types": {
"get": {
"summary": "Get all registered reference types.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/logs\/settings": {
"get": {
"summary": "Show config.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Save config.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/logs\/{id}": {
"get": {
"summary": "Get Log entry by ID.",
"description": "",
"tags": [
"Log"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Log"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/markets\/credentials": {
"get": {
"summary": "List credentials",
"description": "Lists credentials by filter options.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Credentials",
"items": {
"$ref": "#\/definitions\/Credentials"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": true,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The items per page to search for",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a credential",
"description": "Create a new credential with the given data.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Credentials"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/markets\/credentials",
"schema": {
"type": "object",
"required": [
"environment",
"status",
"market"
],
"properties": {
"environment": {
"type": "string",
"description": "The environment for the credentials. Possible values: sandbox, production allowed values are sandbox, production"
},
"status": {
"type": "string",
"description": "The status of the credentials. Possible values: active, inactive, pending allowed values are active, inactive, pending"
},
"market": {
"type": "string",
"description": "The market for the current credentials."
}
}
}
}
]
}
},
"\/rest\/markets\/credentials\/{credentialsId}": {
"delete": {
"summary": "Delete a credential",
"description": "Deletes a credential by given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the credentials to be deleted.",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a credential",
"description": "Gets a credential by given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Credentials"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the credentials to be found.",
"format": "integer",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a credential",
"description": "Update a credential with the given data and ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Credentials"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/markets\/credentials\/{credentialsId}",
"schema": {
"type": "object",
"required": [
"id",
"market"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the credentials."
},
"environment": {
"type": "string",
"description": "The environment for the credentials. Possible values: sandbox, production optional allowed values are sandbox, production"
},
"status": {
"type": "string",
"description": "The status of the credentials. Possible values: active, inactive, pending optional allowed values are active, inactive, pending"
},
"market": {
"type": "string",
"description": "The market for the current credentials."
}
}
}
}
]
}
},
"\/rest\/markets\/ebay\/auth\/login": {
"get": {
"summary": "Get the login URL.",
"description": "Generates the eBay login URL.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/ebay\/auth\/refresh-token": {
"put": {
"summary": "Refresh an expired access token.",
"description": "Refreshes the expired eBay access token.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/ebay\/categories": {
"get": {
"summary": "List categories",
"description": "Lists categories. By passing category ID as filter, only subcategories of that category will be returned. The marketplace ID filter is required.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Category"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "marketplaceId",
"type": "string",
"required": true,
"description": "Filter that restricts the search result to categories that belong to the specified marketplace ID.",
"format": "string",
"in": "query"
},
{
"name": "categoryId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to categories that belong to the specified category ID.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/markets\/ebay\/categories\/{id}": {
"get": {
"summary": "Get category",
"description": "Get category for given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Category"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the category to be found.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/markets\/ebay\/fulfillment_policies\/{id}": {
"get": {
"summary": "Get fulfillment policy",
"description": "Get fulfillment policy for given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/FulfillmentPolicy"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "marketplaceId",
"type": "string",
"required": true,
"description": "The ID of the marketplace for which to get the policy.",
"format": "string",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "The ID of credentials for which to get the policy.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/markets\/ebay\/item_specifics": {
"get": {
"summary": "List item specifics",
"description": "List item specifics for a given category Id and referrerId.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ItemSpecific"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "categoryId",
"type": "integer",
"required": true,
"description": "The ID of the category for which to list item specifics",
"format": "integer",
"in": "query"
},
{
"name": "marketplaceId",
"type": "string",
"required": true,
"description": "Filter that restricts the search result to categories that belong to the specified marketplace ID.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/markets\/ebay\/marketplaces": {
"get": {
"summary": "Get all eBay marketplaces.",
"description": "List eBay marketplaces. Use filters to find specific ones.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Marketplace"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "referrerId",
"type": "number",
"required": false,
"description": "Get only marketplaces that match the given referrer ID",
"format": "",
"in": "query"
},
{
"name": "marketplaceId",
"type": "string",
"required": false,
"description": "Get only marketplaces that match the given marketplace ID",
"format": "string",
"in": "query"
},
{
"name": "marketId",
"type": "integer",
"required": false,
"description": "Get only marketplaces that match the given market ID",
"format": "integer",
"in": "query"
},
{
"name": "siteId",
"type": "integer",
"required": false,
"description": "Get only marketplaces that match the given site ID",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/markets\/ebay\/parts-fitments": {
"get": {
"summary": "List fitments",
"description": "Lists fitments.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Fitment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a fitment",
"description": "Create a new fitment for the given data.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Fitment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/markets\/ebay\/parts-fitments",
"schema": {
"type": "object",
"required": [
"marketId",
"name",
"categoryId",
"properties"
],
"properties": {
"marketId": {
"type": "integer",
"description": "The id of the market the fitment belongs to."
},
"name": {
"type": "string",
"description": "The name of the fitment."
},
"categoryId": {
"type": "integer",
"description": "The id of the category the fitment belongs to."
},
"items": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FitmentItem"
}
},
"properties": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/markets\/ebay\/parts-fitments\/search": {
"get": {
"summary": "Search fitments",
"description": "Search fitments by filter options.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Fitment",
"items": {
"$ref": "#\/definitions\/Fitment"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "categoryId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to fitments with specific eBay category ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to fitments with specific ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "marketId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to fitments with specific market ID. Several IDs can be entered as array.",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to fitments with specific name.",
"format": "string",
"in": "query"
},
{
"name": "propertyName",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to fitments with specific property name.",
"format": "string",
"in": "query"
},
{
"name": "propertyValue",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to fitments with specific property value.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with child instances to be loaded. Available values: 'items', 'items.properties'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/markets\/ebay\/parts-fitments\/{fitmentId}": {
"delete": {
"summary": "Delete a fitment.",
"description": "Deletes a fitment. The ID of the fitment must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The fitment ID.",
"format": "integer",
"in": "query"
},
{
"name": "fitmentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a fitment",
"description": "Gets a fitment. The id of the fitment must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Fitment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The fitment ID.",
"format": "integer",
"in": "query"
},
{
"name": "fitmentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update fitment.",
"description": "Updates a fitment. Items that do not occur anymore will be replaced.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Fitment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the fitment list.",
"format": "integer",
"in": "query"
},
{
"name": "fitmentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/markets\/ebay\/parts-fitments\/{fitmentId}",
"schema": {
"type": "object",
"required": [
"marketId",
"name",
"categoryId",
"properties"
],
"properties": {
"marketId": {
"type": "integer",
"description": "The id of the market the fitment belongs to."
},
"name": {
"type": "string",
"description": "The name of the fitment."
},
"categoryId": {
"type": "integer",
"description": "The id of the category the fitment belongs to."
},
"items": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FitmentItem"
}
},
"properties": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/markets\/ebay\/payment_policies\/{id}": {
"get": {
"summary": "Get payment policy",
"description": "Get payment policy for given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentPolicy"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "marketplaceId",
"type": "string",
"required": true,
"description": "The ID of the marketplace for which to get the policy.",
"format": "string",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "The ID of credentials for which to get the policy.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/markets\/ebay\/return_policies\/{id}": {
"get": {
"summary": "Get return policy",
"description": "Get return policy for given ID.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ReturnPolicy"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "marketplaceId",
"type": "string",
"required": true,
"description": "The ID of the marketplace for which to get the policy.",
"format": "string",
"in": "query"
},
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "The ID of credentials for which to get the policy.",
"format": "integer",
"in": "query"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/markets\/ebay\/shop_categories": {
"get": {
"summary": "List all eBay shop categories",
"description": "Lists all eBay shop categories.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "credentialsId",
"type": "integer",
"required": true,
"description": "The credentials ID for whom to fetch eBay shop categories.",
"format": "integer",
"in": "query"
},
{
"name": "viewType",
"type": "string",
"required": false,
"description": "How should the eBay shop categories be returned. Possible values: 'list' or 'tree'. Default is 'list'",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/markets\/listings\/marketplaces": {
"get": {
"summary": "Get all listing marketplaces.",
"description": "List listing marketplaces. Use filters to find specific ones.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Marketplace"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "referrerId",
"type": "number",
"required": false,
"description": "Get only marketplaces that match the given referrer ID",
"format": "",
"in": "query"
},
{
"name": "marketplaceId",
"type": "string",
"required": false,
"description": "Get only marketplaces that match the given marketplace ID",
"format": "string",
"in": "query"
},
{
"name": "marketId",
"type": "integer",
"required": false,
"description": "Get only marketplaces that match the given market ID",
"format": "integer",
"in": "query"
},
{
"name": "siteId",
"type": "integer",
"required": false,
"description": "Get only marketplaces that match the given site ID",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/markets\/settings": {
"get": {
"summary": "List market settings",
"description": "Lists market settings. The marketplace ID and the type must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Settings"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create market settings",
"description": "Creates new market settings by given data. The marketplace ID and the type must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Settings"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/settings\/bulk": {
"post": {
"summary": "Create market settings",
"description": "Creates new market settings by given data. The marketplace ID and the type must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Settings"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Update market settings",
"description": "Updates market settings. The market settings ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Settings"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/settings\/correlations": {
"get": {
"summary": "List correlation",
"description": "Lists correlations. The type, the market settings ID and the correlation ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Settings"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a correlation",
"description": "Creates a correlation. The type, the market settings ID and the correlation ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/settings\/correlations\/bulk": {
"post": {
"summary": "Create multiple correlations",
"description": "Creates multiple correlations. The type, market settings ID and the correlation ID for each param combination must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/markets\/settings\/{settingId}": {
"delete": {
"summary": "Delete market settings",
"description": "Deletes market settings. The market settings ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "settingId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get market settings",
"description": "Gets market settings. The market settings ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Settings"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "settingId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update market settings",
"description": "Updates market settings. The market settings ID must be specified.",
"tags": [
"Market"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Settings"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "settingId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/messages": {
"get": {
"summary": "List message stream of a certain message (excluding message with UUID5)",
"description": "Lists the stream of messages of a certain message (excluding the message with the given UUID5).",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid",
"type": "string",
"required": false,
"description": "The reference UUID5 of the message to start from (excluding).",
"format": "string",
"in": "query"
},
{
"name": "successors",
"type": "boolean",
"required": false,
"description": "If set to FALSE, the messages older than the referenced message will be returned.",
"format": "boolean",
"in": "query"
},
{
"name": "amount",
"type": "integer",
"required": false,
"description": "The number of messages to be listed (defaults to 50)",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create message",
"description": "Creates a new message.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Message"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/messages",
"schema": {
"type": "object",
"required": [
"message",
"to",
"from",
"referrer",
"name",
"size",
"contentType"
],
"properties": {
"message": {
"type": "string",
"description": "The content of the message"
},
"whispered": {
"type": "boolean",
"description": "Whether the message is whispered (not visible for the contact\/order linked to the message) or not optional"
},
"to": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageTo"
}
},
"linkedTo": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageLinkedTo"
}
},
"metaData": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageMetaData"
}
},
"from": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageFrom"
}
},
"tags": {
"type": "array",
"items": {}
},
"referrer": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageReferrer"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
},
"name": {
"type": "string",
"description": "The file name of the attachment"
},
"size": {
"type": "integer",
"description": "The size of the attachment in bytes"
},
"contentType": {
"type": "string",
"description": "The content type fo the attachment allowed values are image\/png, image\/jpeg, image\/gif, image\/bmp, image\/tiff, application\/pdf, application\/zip, application\/json, application\/octet-stream, text\/plain, text\/csv"
}
}
}
}
]
}
},
"\/rest\/messages\/get": {
"get": {
"summary": "List messages per page",
"description": "Lists the number of messages per page.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The number of the returned page of messages. The default value is 1 (the first).",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of messages to be listed (defaults to 50).",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/messages\/{uuid5}": {
"delete": {
"summary": "Delete message by UUID",
"description": "Deletes a message by the UUID. The UUID must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID of the message to be deleted",
"format": "string",
"in": "path"
}
]
},
"get": {
"summary": "Get message for the given UUID5 and all its associated successors",
"description": "Gets the message for the given UUID5 and all its associated successors. The UUID must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID5 of the message",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/messages\/{uuid5}\/attachments": {
"get": {
"summary": "Get attachment by UUID and file name",
"description": "Gets an attachment. The UUID of the message and the file name must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID of the message",
"format": "string",
"in": "path"
},
{
"name": "filename",
"type": "string",
"required": true,
"description": "The file name of the attachment",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/messages\/{uuid5}\/controls": {
"put": {
"summary": "Update message controls",
"description": "Updates the message ui control options in the message meta data and returns the message.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Message"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid5",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/messages\/{uuid5}\/controls",
"schema": {
"type": "object",
"properties": {
"replyable": {
"type": "boolean",
"description": "Indicates whether or not is allowed to reply to this message stream (default true). optional"
},
"attachable": {
"type": "boolean",
"description": "Indicates whether or not is allowed to attach files in a message (default true). optional"
},
"linksDisabled": {
"type": "boolean",
"description": "Indicates whether or not the message links should be disabled (default false). optional"
}
}
}
}
]
}
},
"\/rest\/messages\/{uuid5}\/done": {
"put": {
"summary": "Set or unset doneAt date of message",
"description": "Sets or unsets the doneAt date of the message. The UUID {uuid5} must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "doneAt",
"type": "string",
"required": false,
"description": "Set (or unset, if doneAt is not given) the doneAt date in the message.",
"format": "string",
"in": "query"
},
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID5 of the message",
"format": "string",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/messages\/{uuid5}\/done",
"schema": {
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageTo"
}
},
"linkedTo": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageLinkedTo"
}
},
"tags": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/messages\/{uuid5}\/readBy": {
"put": {
"summary": "Update ReadBy array of message",
"description": "Updates the ReadBy array of the message. The UUID must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "readBy",
"type": "integer",
"required": true,
"description": "The ID of the user who read the message",
"format": "integer",
"in": "query"
},
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID of the message",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/messages\/{uuid5}\/tags": {
"put": {
"summary": "Update tags of message",
"description": "Updates the tags of the message. The UUID must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "tags",
"type": "integer",
"required": true,
"description": "The tags of the message",
"format": "integer",
"in": "query"
},
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID of the message",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/messages\/{uuid5}\/visibility": {
"put": {
"summary": "Update message visibility",
"description": "Updates the message visibility. The UUID must be specified.",
"tags": [
"Messenger"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "uuid5",
"type": "string",
"required": true,
"description": "The UUID of the message",
"format": "string",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/messages\/{uuid5}\/visibility",
"schema": {
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageTo"
}
},
"linkedTo": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageLinkedTo"
}
},
"tags": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/newsletters": {
"delete": {
"summary": "Delete entries",
"description": "Deletes all entries.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Entry"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "List newsletter entries",
"description": "Lists all newsletter entries.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Entry"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create entry",
"description": "Creates an entry.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Entry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "subject",
"type": "string",
"required": false,
"description": "The subject of the newsletter entry",
"format": "string",
"in": "query"
},
{
"name": "body",
"type": "string",
"required": false,
"description": "The body of the newsletter entry",
"format": "string",
"in": "query"
},
{
"name": "kind",
"type": "string",
"required": false,
"description": "The type of the entry. The content can be saved as plain text or in HTML format. Possible values: ['plain', 'html'].",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/newsletters",
"schema": {
"type": "object",
"required": [
"subject"
],
"properties": {
"subject": {
"type": "string",
"description": "The subject of the newsletter entry"
},
"body": {
"type": "string",
"description": "The body of the newsletter entry optional"
},
"kind": {
"type": "string",
"description": "The type of the newsletter entry optional"
}
}
}
}
]
}
},
"\/rest\/newsletters\/double_opt_in\/{contactId}": {
"post": {
"summary": "Send doubleOptIn mail",
"description": "Sends a mail with a doubleOptIn. The ID of the costumer must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": true,
"description": "The ID of the costumer contact",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/newsletters\/folders": {
"delete": {
"summary": "Delete folders",
"description": "Deletes all folders.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Folder"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "List newsletter folders",
"description": "Lists all newsletter folders.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Recipient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create folder",
"description": "Creates a folder.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Folder"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": false,
"description": "The ID of the newsletter folder",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of the newsletter folder",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": false,
"description": "The position of the newsletter folder",
"format": "integer",
"in": "query"
},
{
"name": "isDeletable",
"type": "boolean",
"required": false,
"description": "Flag that indicates if the newsletter folder can be deleted. Default value of is deletable is 1. The folders 'Customers' and 'Interested parties' are available by default and cannot be deleted.",
"format": "boolean",
"in": "query"
},
{
"name": "isSelectable",
"type": "boolean",
"required": false,
"description": "Flag that indicates if the newsletter folder can be selected by customers in the online store. If it is allowed, the folder will be displayed in the My account area of the online store. Customers will then be able to subscribe to the newsletters that are included in this folder.",
"format": "boolean",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/newsletters\/folders",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the newsletter folder optional value must be unique"
},
"name": {
"type": "string",
"description": "The name of the newsletter folder"
},
"position": {
"type": "integer",
"description": "The position of the newsletter folder optional"
},
"isDeletable": {
"type": "boolean",
"description": "Flag that indicates if the newsletter folder can be deleted. The folders 'Customers' and 'Interested parties' are available by default and cannot be deleted. optional"
},
"isSelectable": {
"type": "boolean",
"description": "Flag that indicates if the newsletter folder can be selected by customers in the online store. If this is allowed, the folder will be displayed in the My account area of the online store. Customers will then be able to subscribe to the newsletters that are included in this folder. optional"
}
}
}
}
]
}
},
"\/rest\/newsletters\/folders\/{folderId}": {
"delete": {
"summary": "Delete folder",
"description": "Deletes a folder. The ID of the folder must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Folder"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List details of a folder",
"description": "Lists details of a folder. The ID of the folder must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Folder"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update folder",
"description": "Updates a folder. The ID of the folder must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Folder"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of the newsletter folder",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": false,
"description": "The position of the newsletter folder",
"format": "integer",
"in": "query"
},
{
"name": "clientIds",
"type": "integer",
"required": false,
"description": "The IDs of the clients (stores). It is possible to determine which clients (stores) the newsletter folder is visible for. ",
"format": "integer",
"in": "query"
},
{
"name": "isDeletable",
"type": "boolean",
"required": false,
"description": "Flag that indicates if the newsletter folder can be deleted. The folders 'Customers' and 'Interested parties' are available by default and cannot be deleted.",
"format": "boolean",
"in": "query"
},
{
"name": "isSelectable",
"type": "boolean",
"required": false,
"description": "Flag that indicates if the newsletter folder can be selected by customers in the online store. If it is allowed, the folder will be displayed in the My account area of the online store. Customers will then be able to subscribe to the newsletters that are included in this folder.",
"format": "boolean",
"in": "query"
},
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/newsletters\/folders\/{folderId}\/recipients": {
"get": {
"summary": "List all recipients of a folder",
"description": "Lists all recipients of a folder. The ID of the folder must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Recipient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/newsletters\/list_recipients": {
"get": {
"summary": "List recipients",
"description": "Lists a recipients.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to specific columns",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of orders to be displayed per page. The default number of orders per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "folderId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to a specific folderId.",
"format": "integer",
"in": "query"
},
{
"name": "isConfirmed",
"type": "boolean",
"required": false,
"description": "Filter that restricts the search result to confirmed recipients.",
"format": "boolean",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for a Recipient. CURRENTLY NOT AVAILABLE",
"format": "integer",
"in": "query"
},
{
"name": "recipientId",
"type": "integer",
"required": true,
"description": "The ID of the recipient",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/newsletters\/recipients": {
"delete": {
"summary": "Delete recipients",
"description": "Deletes a recipients.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Recipient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "List recipients of folder",
"description": "Lists all recipients of a folder.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Recipient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "email",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to the email address of the recipient",
"format": "string",
"in": "query"
},
{
"name": "folderId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to the folder ID",
"format": "integer",
"in": "query"
},
{
"name": "recipientId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to the recipient ID",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create recipient",
"description": "Creates a recipient.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Recipient"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "email",
"type": "string",
"required": false,
"description": "The email address of the recipient",
"format": "string",
"in": "query"
},
{
"name": "firstName",
"type": "string",
"required": false,
"description": "The first name of the recipient",
"format": "string",
"in": "query"
},
{
"name": "lastName",
"type": "string",
"required": false,
"description": "The last name of the recipient",
"format": "string",
"in": "query"
},
{
"name": "folderIds",
"type": "integer",
"required": false,
"description": "The IDs of the newsletter folders. These folders were selected by the customer in the online store in order to receive newsletters included in these folders.",
"format": "integer",
"in": "query"
},
{
"name": "isFrontend",
"type": "boolean",
"required": false,
"description": "Value that indicates if the REST call was retrieved from the front end. Possible values are: 'true' or 'false'. True = The REST call was retrieved from the front end. False = The REST call was not retrieved from the front end.",
"format": "boolean",
"in": "query"
},
{
"name": "ignoreVisibility",
"type": "boolean",
"required": false,
"description": "Value that indicates if the REST call considers folders without visibility. Possible value: 'true'. If the value 'true' is set, the folder visibility will be ignored. This means that both visible and invisible folders will be listed depending on the folder IDs entered in the REST call.",
"format": "boolean",
"in": "query"
},
{
"name": "ipAddress",
"type": "string",
"required": false,
"description": "The IP address from where the customer has confirmed the newsletter",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/newsletters\/recipients",
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address of the recipient"
}
}
}
}
]
}
},
"\/rest\/newsletters\/recipients\/{recipientId}": {
"delete": {
"summary": "Delete recipient",
"description": "Deletes a recipient. The ID of the recipient must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Recipient"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "recipientId",
"type": "integer",
"required": true,
"description": "The ID of the recipient",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List recipient",
"description": "Lists a recipient. The ID of the recipient must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Recipient"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "recipientId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update recipient",
"description": "Updates a recipient that is assigned to a folder. The ID of the recipient must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Recipient"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "email",
"type": "string",
"required": false,
"description": "The email address of the newsletter recipient",
"format": "string",
"in": "query"
},
{
"name": "firstName",
"type": "string",
"required": false,
"description": "The first name of the newsletter recipient",
"format": "string",
"in": "query"
},
{
"name": "lastName",
"type": "string",
"required": false,
"description": "The last name of the newsletter recipient",
"format": "string",
"in": "query"
},
{
"name": "folderIds",
"type": "integer",
"required": false,
"description": "DEPRECATED: The IDs of the newsletter folders. These folders were selected by the customer in the online store in order to receive newsletters included in these folders.",
"format": "integer",
"in": "query"
},
{
"name": "folderId",
"type": "integer",
"required": false,
"description": "The ID of the newsletter folder.",
"format": "integer",
"in": "query"
},
{
"name": "ipAddress",
"type": "string",
"required": false,
"description": "The IP address from where the customer has confirmed the newsletter",
"format": "string",
"in": "query"
},
{
"name": "birthday",
"type": "string",
"required": false,
"description": "The customer birthday as Date string (e.g. '1982-11-24', '1982\/11\/24' or '24.11.1982')",
"format": "string",
"in": "query"
},
{
"name": "gender",
"type": "string",
"required": false,
"description": "The gender of the customer, one of the following values: 'm','f','d'.",
"format": "string",
"in": "query"
},
{
"name": "recipientId",
"type": "integer",
"required": true,
"description": "The ID of the recipient",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/newsletters\/recipients\/{recipientId}",
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address of the recipient"
}
}
}
}
]
}
},
"\/rest\/newsletters\/{entryId}": {
"delete": {
"summary": "Delete entry",
"description": "Deletes an entry. The ID of the entry must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Entry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "entryId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter entry",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List details of an entry",
"description": "Lists details of an entry. The ID of the entry must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Entry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "entryId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter entry.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update entry",
"description": "Updates an entry. The ID of the entry must be specified.",
"tags": [
"Newsletter"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Entry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "subject",
"type": "string",
"required": false,
"description": "The subject of the entry",
"format": "string",
"in": "query"
},
{
"name": "body",
"type": "string",
"required": false,
"description": "The body of the entry",
"format": "string",
"in": "query"
},
{
"name": "kind",
"type": "string",
"required": false,
"description": "The type of the entry. The content can be saved as plain text or in HTML format. Possible values: ['plain', 'html'].",
"format": "string",
"in": "query"
},
{
"name": "entryId",
"type": "integer",
"required": true,
"description": "The ID of the entry",
"format": "integer",
"in": "path"
},
{
"name": "folderId",
"type": "integer",
"required": true,
"description": "The ID of the newsletter folder",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders": {
"get": {
"summary": "Search order",
"description": "Searches for orders. The results can be restricted by using filter options.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Order",
"items": {
"$ref": "#\/definitions\/Order"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderType",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders of specific order types. The ID of the order types must be specified. Several order type IDs can be entered separated by commas. @see order model typeId",
"format": "string",
"in": "query"
},
{
"name": "contactId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders of a contact. The ID of the contact must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "referrerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "shippingProfileId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "shippingServiceProviderId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "ownerUserId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "warehouseId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "isEbayPlus",
"type": "boolean",
"required": false,
"description": "Filter that restricts the search result to orders with the referrer eBay PLUS.",
"format": "boolean",
"in": "query"
},
{
"name": "includedVariation",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "includedItem",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "orderIds",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific ID. To list several orders, the order IDs must be enetered separated by commas.",
"format": "integer",
"in": "query"
},
{
"name": "countryId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific delivery or invoice country. The ID of the country must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "orderItemName",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.",
"format": "string",
"in": "query"
},
{
"name": "variationNumber",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "sender.contact",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific sender of the type contact. For example, the supplier is a sender of the type contact for reorders. The ID of the sender must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "sender.warehouse",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific sender of the type warehouse. For example, the sending warehouse is a sender of the type warehouse for redistributions. The ID of the sender must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "receiver.contact",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders including a specific receiver of the type contact. For example, a receiver of the type contact is the recipient of a main order. The ID of the receiver must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "receiver.warehouse",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders with a specific receiver of the type warehouse. TFor example, the receiving receiving warehouse is a receiver of the type warehouse for redistributions. The ID of the receiver must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "externalOrderId",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.",
"format": "string",
"in": "query"
},
{
"name": "clientId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "paymentStatus",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders with a specific payment status. Valid values are unpaid, partlyPaid, fullyPaid, overpaid. One of these values must be specified.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that were last updated on a specified date. The date has to be entered in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be entered in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that were created from a specified date up to the present date. This filter can be used alone or can be combined with the CreatedAtTo filter. The date has to be entered in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that were created within a certain period of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The date has to be entered in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "paidAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that received a payment on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "paidAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders that received a payment within a certain period of time. This filter can be used alone or can be combined with the paidAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "outgoingItemsBookedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders where the outgoing items were booked on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "outgoingItemsBookedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders where the outgoing items were booked within a specified period of time. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "statusFrom",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders in a specific order status. The value of the order status must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "statusTo",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders within a range of order statuses. This filter can be used alone or can be combined with the statusFrom filter. The value of the order status must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "hasDocument",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders which hold the given document type. Valid values are multi_invoice<\/i>, multi_credit_note<\/i>, success_confirmation<\/i>, return_note<\/i>, pickup_delivery<\/i>, repair_bill<\/i>, dunning_letter<\/i>, offer<\/i>, order_confirmation<\/i>, credit_note<\/i>, correction_document<\/i>, delivery_note<\/i>, invoice<\/i>, invoice_external<\/i>, receipt<\/i>",
"format": "string",
"in": "query"
},
{
"name": "hasDocumentNumber",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to orders which hold documents with given number.",
"format": "string",
"in": "query"
},
{
"name": "parentOrderId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to orders which have the given order ID as parent.",
"format": "integer",
"in": "query"
},
{
"name": "addOrderItems",
"type": "boolean",
"required": false,
"description": "Add the order items to the results. Default = true.",
"format": "boolean",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of orders to be displayed per page. The default number of orders per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order. Currently possible are:\n
\n - 'addresses' = The address objects that are associated with the order.<\/li>\n
- 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.<\/li>\n
- 'comments' = The order comments.<\/li>\n
- 'location' = The accounting location of the order.<\/li>\n
- 'payments' = The payments that are associated with the order.<\/li>\n
- 'documents' = The documents that are associated with the order.<\/li>\n
- 'contactSender' = The associated contact for the contact-sender relation.<\/li>\n
- 'contactReceiver' = The associated contact for the contact-receiver relation.<\/li>\n
- 'warehouseSender' = The associated warehouse for the warehouse-sender relation.<\/li>\n
- 'warehouseReceiver' = The associated warehouse for the warehouse-receiver relation.<\/li>\n
- 'orderItems.variation' = The variation that is associated with the order item.<\/li>\n
- 'orderItems.giftCardCodes' = The gift card codes that are associated with the order item.<\/li>\n
- 'orderItems.transactions' = The transactions that are associated with the order item.<\/li>\n
- 'orderItems.serialNumbers' = The serial numbers that are associated with the order item.<\/li>\n
- 'orderItems.variationBarcodes' = The barcodes that are associated with variation of the order item.<\/li>\n
- 'orderItems.comments' = The comments that are associated with the order item.<\/li>\n
- 'originOrderReferences' = The references to other orders, e.g. returns or credit notes, associated with this order.<\/li>\n
- 'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n
- deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations that are associated with the order item.<\/li>\n <\/ul>\n Example:
?with[]=addresses&with[]=orderItems.variation<\/code>",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create an order",
"description": "Creates an order. The parameters included in the example below must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "coupon",
"type": "integer",
"required": false,
"description": "One or multiple coupon code to be redeemed with order creation",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/orders",
"schema": {
"type": "object",
"required": [
"typeId",
"plentyId"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the order type\n It is possible to define individual order types. However,\n the following types are available by default:\n\n 1 = Sales order\n 2 = Delivery\n 3 = Returns\n 4 = Credit note\n 5 = Warranty\n 6 = Repair\n 7 = Offer\n 8 = Advance order\n 9 = Multi-order\n 10 = Multi credit note\n 11 = Multi delivery\n 12 = Reorder\n 13 = Partial delivery\n 14 = Subscription\n 15 = Redistribution"
},
"plentyId": {
"type": "integer",
"description": "The plenty ID of the client that the order belongs to"
},
"statusId": {
"type": "number",
"description": "The ID of the order status optional"
},
"ownerId": {
"type": "integer",
"description": "The user ID of the order's owner optional"
},
"lockStatus": {
"type": "string",
"description": "The lock status of the order. The following statuses are available:\n\n unlocked\n permanentlyLocked\n reversibleLocked\n allowed values are unlocked, permanentlyLocked, reversibleLocked"
},
"orderItems": {
"type": "array",
"items": {}
},
"properties": {
"type": "array",
"items": {}
},
"addressRelations": {
"type": "array",
"items": {}
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/orders\/addresses": {
"post": {
"summary": "Create address for existing order",
"description": "Creates an address for an existing order.",
"tags": [
"Account"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AddressOrderRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/contacts\/{contactId}": {
"get": {
"summary": "List orders of a contact",
"description": "Lists all orders of a contact. The ID of the contact must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Order",
"items": {
"$ref": "#\/definitions\/Order"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": true,
"description": "The ID of the contact.",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The number of orders to be displayed per page. The default number of orders per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order. The following relations are available:\n * \n - 'addresses' = The address objects linked to the order.<\/li>\n
- 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the reference type. The available reference types are parent and reorder. The ID of the reference and the relation itself are also available.<\/li>\n
- 'comments' = The order comments.<\/li>\n
- 'location' = The accounting location linked to the order.<\/li>\n
- 'payments' = The payments linked to the order.<\/li>\n
- 'documents' = The documents linked to the order.<\/li>\n
- 'contactSender' = The contact belonging the contact-sender relation.<\/li>\n
- 'contactReceiver' = The contact belonging to the contact-receiver relation.<\/li>\n
- 'warehouseSender' = The warehouse belonging to the warehouse-sender relation.<\/li>\n
- 'warehouseReceiver' = The warehouse belonging to the warehouse-receiver relation.<\/li>\n
- 'orderItems.variation' = The variation data belonging to the order item.<\/li>\n
- 'orderItems.giftCardCodes' = The gift card codes belonging to the order item.<\/li>\n
- 'orderItems.transactions' = The transactions belonging to the order item.<\/li>\n
- 'orderItems.serialNumbers' = The serial numbers belonging to the order item.<\/li>\n
- 'orderItems.variationBarcodes' = The barcodes belonging to the order item.<\/li>\n
- 'orderItems.comments' = The comments belonging to the order item.<\/li>\n
- 'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n
- deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations linked to the order item.<\/li>\n <\/ul>\n Example:
?with[]=addresses&with[]=orderItems.variation<\/code>",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/contacts\/{contactId}\/multi_order": {
"post": {
"summary": "Create a multi-order",
"description": "Creates a multi-order for a contact. The ID of the contact must be specified. Options chosen in the System \u00bb Orders \u00bb Order types \u00bb Multi-order menu are relevant for this call.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/coupons\/campaigns\/codes\/{code}": {
"delete": {
"summary": "Delete a coupon",
"description": "Deletes a coupon by the coupon code.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "withoutUsed",
"type": "integer",
"required": false,
"description": "Do not delete used coupons",
"format": "integer",
"in": "query"
},
{
"name": "code",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get coupon code information",
"description": "Gets coupon code information. The code must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CouponCampaignCode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "code",
"type": "string",
"required": true,
"description": "The coupon code",
"format": "string",
"in": "path"
},
{
"name": "with",
"type": "string",
"required": false,
"description": "Load additional relations for a coupon code. Currently possible are:\n * \n * - 'campaign' = The coupon campaign to which this code belongs to.<\/li>\n * <\/ul>\n * Example:
?with=campaign<\/code>",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/coupons\/campaigns\/codes\/{code}\/disabled\/{isDisabled}": {
"put": {
"summary": "Disable or enable coupon",
"description": "Sets the coupon disable field.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "code",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "isDisabled",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/coupons\/campaigns\/{campaignId}\/codes": {
"post": {
"summary": "Create a coupon code",
"description": "Creates a coupon code. The ID of the campaign must be specified. A code can optionally be specified. A random code will be generated if the code is not specified. A coupon value can also be optionally specified. The value of the campaign will be used if no individual value is specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CouponCampaignCode"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "campaignId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/coupons\/campaigns\/{campaignId}\/codes",
"schema": {
"type": "object",
"required": [
"campaignId"
],
"properties": {
"campaignId": {
"type": "integer",
"description": "The ID of the campaign that the code belongs to"
},
"code": {
"type": "string",
"description": "The coupon code matching to \/^[a-zA-Z0-9_-]{6,32}$\/"
},
"value": {
"type": "number",
"description": "The value of the coupon if it differs from the campaign value. The value is null if the campaign value is used."
},
"usedCount": {
"type": "integer",
"description": "How many times a code has been redeemed"
},
"usedAmount": {
"type": "number",
"description": "The amount that is already redeemed. The total amount that can be redeemed is defined in the campaign as coupon value, because the value applies to all codes of a campaign."
}
}
}
}
]
}
},
"\/rest\/orders\/coupons\/codes": {
"post": {
"summary": "Validate multiple coupons",
"description": "Validates if multiple coupon codes can be used for the specified items, contact ID, etc. At least one code must be specified. Only one coupon code for special offers (promotional code) can be specified. Promotional codes are validated first. Gift card codes are validated and redeemed after the promotional code to ensure that any discounts are calculated correctly.\nIf any coupon code is invalid, a CouponCodeValidation object with an exception parameter will be added to the list. If the coupon code is valid, a CouponCodeValidation object will be added to the list.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CouponCodeValidation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "coupons",
"type": "integer",
"required": true,
"description": "The coupons to validate.",
"format": "integer",
"in": "query"
},
{
"name": "callFromScheduler",
"type": "boolean",
"required": false,
"description": "Flag that indicates whether the validation is requested by a subscription order or not. TRUE = The validation is requested by a subscription order. FALSE = The validation is not requested by a subscription order.",
"format": "boolean",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "The plenty id.",
"format": "integer",
"in": "query"
},
{
"name": "shipToCountry",
"type": "integer",
"required": true,
"description": "The country of delivery.",
"format": "integer",
"in": "query"
},
{
"name": "taxIdNumber",
"type": "string",
"required": false,
"description": "The tax id number.",
"format": "string",
"in": "query"
},
{
"name": "contactClass",
"type": "integer",
"required": false,
"description": "The contact class.",
"format": "integer",
"in": "query"
},
{
"name": "contactType",
"type": "integer",
"required": false,
"description": "The contact type.",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/orders\/coupons\/codes",
"schema": {
"type": "object",
"required": [
"items",
"contactId"
],
"properties": {
"validationType": {
"type": "string",
"description": "The type of the campaign. Currently the only type available is plentymarkets. optional allowed values are plenty"
},
"items": {
"type": "array",
"items": {}
},
"contactId": {
"type": "integer",
"description": "The ID of the contact that wants to redeem the coupon"
},
"currency": {
"type": "string",
"description": "The currency of the purchase optional"
},
"referrer": {
"type": "number",
"description": "The order referrer optional"
}
}
}
}
]
}
},
"\/rest\/orders\/coupons\/codes\/contacts\/{contactId}": {
"get": {
"summary": "List redeemed coupon codes of a contact",
"description": "Lists the redeemed coupon codes of contact. The ID of the contact must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of CouponCodeContact",
"items": {
"$ref": "#\/definitions\/CouponCodeContact"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": true,
"description": "The ID of the contact",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of coupons to be displayed per page. The default number of coupons per page is 50.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/coupons\/codes\/{coupon}": {
"post": {
"summary": "Validate a coupon",
"description": "Validates if a coupon code can be used for the specified items, contact ID, etc. The code must be specified. If the coupon code is invalid, a ValidationException will be thrown. If the coupon code is valid, a CouponCodeValidation object will be returned.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CouponCodeValidation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "coupon",
"type": "string",
"required": true,
"description": "The coupon to validate.",
"format": "string",
"in": "path"
},
{
"name": "callFromScheduler",
"type": "boolean",
"required": false,
"description": "Flag that indicates whether the validation is requested by a subscription order or not. TRUE = The validation is requested by a subscription order. FALSE = The validation is not requested by a subscription order.",
"format": "boolean",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "The plenty id.",
"format": "integer",
"in": "query"
},
{
"name": "shipToCountry",
"type": "integer",
"required": true,
"description": "The country of delivery.",
"format": "integer",
"in": "query"
},
{
"name": "taxIdNumber",
"type": "string",
"required": false,
"description": "The tax id number.",
"format": "string",
"in": "query"
},
{
"name": "contactClass",
"type": "integer",
"required": false,
"description": "The contact class.",
"format": "integer",
"in": "query"
},
{
"name": "contactType",
"type": "integer",
"required": false,
"description": "The contact type.",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/orders\/coupons\/codes\/{coupon}",
"schema": {
"type": "object",
"required": [
"items",
"contactId"
],
"properties": {
"validationType": {
"type": "string",
"description": "The type of the campaign. Currently the only type available is plentymarkets. optional allowed values are plenty"
},
"items": {
"type": "array",
"items": {}
},
"contactId": {
"type": "integer",
"description": "The ID of the contact that wants to redeem the coupon"
},
"currency": {
"type": "string",
"description": "The currency of the purchase optional"
},
"referrer": {
"type": "number",
"description": "The order referrer optional"
}
}
}
}
]
}
},
"\/rest\/orders\/currencies": {
"get": {
"summary": "List currencies",
"description": "",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Currency"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Valid relations are 'names' or 'countries'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/currencies\/countries\/{countryId}": {
"get": {
"summary": "Get a currency for a country",
"description": "Get a currency for a country. The ID of the country must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Currency"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Valid relations are 'names' or 'countries').",
"format": "integer",
"in": "query"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/currencies\/exchange_rates\/from\/{currencyIso}": {
"get": {
"summary": "Get the exchange rates from a currency",
"description": "Gets the exchange rates from a currency. The ISO 4271 code of the currency must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "currencyIso",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/currencies\/exchange_rates\/to\/{currencyIso}": {
"get": {
"summary": "Get the exchange rates to a currency",
"description": "Gets the exchange rates to a currency. The ISO 4271 code of the currency must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "currencyIso",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/currencies\/{currencyIso}": {
"get": {
"summary": "Get a currency",
"description": "Get a currency. The ISO 4217 code of the currency must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Currency"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "currencyIso",
"type": "string",
"required": true,
"description": "The ISO 4217 code of the currency",
"format": "string",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Valid relations are 'names' or 'countries'",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/currencies\/{currencyIso}\/countries": {
"get": {
"summary": "List countries for a currency",
"description": "List countries for a currency. The ISO 4271 code of the currency must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Country"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "currencyIso",
"type": "string",
"required": true,
"description": "The ISO 4217 code of the currency",
"format": "string",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/currencies\/{currencyIso}\/exchangeRate": {
"get": {
"summary": "Get the exchange rate for a currency",
"description": "Gets the exchange rate for a currency. The ISO 4271 code of the currency must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CurrencyExchangeRate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "currencyIso",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/dates\/types": {
"get": {
"summary": "List order date types",
"description": "Lists all available order date types.\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n
- 13 = Subscription cancelled on<\/li>\n
- 14 = Subscription last run<\/li>\n
- 15 = Subscription next run<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderDateType"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/dates\/types\/{typeId}": {
"get": {
"summary": "Find an order date type",
"description": "Finds an order date type. The ID of the type must be specified. The following IDs are available:\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n
- 13 = Subscription cancelled on<\/li>\n
- 14 = Subscription last run<\/li>\n
- 15 = Subscription next run<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderDateType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/dates\/types\/{typeId}\/names": {
"get": {
"summary": "List names of an order date type",
"description": "Lists names in all languages available of an order date type. The ID of the date type must be specified. The following IDs are available:\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n
- 13 = Subscription cancelled on<\/li>\n
- 14 = Subscription last run<\/li>\n
- 15 = Subscription next run<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderDateTypeName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The Id of the OrderDateType to be found",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/dates\/types\/{typeId}\/names\/{lang}": {
"get": {
"summary": "Get a name of an order date type",
"description": "Gets a name of an order date type. The ID of the date type must be specified. The language of the order date type name must be specified by setting the ISO code of the language. The following IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n
- 13 = Subscription cancelled on<\/li>\n
- 14 = Subscription last run<\/li>\n
- 15 = Subscription next run<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderDateTypeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date type that should be found",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The language of the order date type name",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/orders\/documents": {
"get": {
"summary": "List order documents",
"description": "",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Document",
"items": {
"$ref": "#\/definitions\/Document"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to a specific contact ID.",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to the specific plenty ID.",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created within a certain period of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed within a certain period of time. This filter can be used alone or can be combined with the displayDateFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The items per page to search for",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for a document. Currently possible are:\n
\n - 'references' = The document reference objects that are associated with the document.<\/li>\n <\/ul>\n Example:
?with[]=references<\/code>",
"format": "integer",
"in": "query"
},
{
"name": "withContent",
"type": "boolean",
"required": false,
"description": "Load also the document content as base64 encoded string.",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/orders\/documents\/accounting_summary": {
"get": {
"summary": "List document accounting summaries",
"description": "Lists document accounting summaries. A document accounting summary is saved along with each reversal document (for invoice and credit note). It contains accounting information about the order for this point in time. The summary is saved because an order can be updated after a reversal document is generated. The information about the order before the update is needed for accounting purposes.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaginatedResult"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": false,
"description": "The ID of the order.",
"format": "integer",
"in": "query"
},
{
"name": "documentType",
"type": "string",
"required": false,
"description": "The document type. The types that can be returned are the following: reversal_document (reversal document for an invoice) and reversal_refund (reversal document for an invoice).",
"format": "string",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Get entries with createdAt date after this date.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Get entries with createdAt date before this date.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of summaries that should be displayed per page. The default number of orders per page is 10.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/documents\/downloads\/{type}": {
"get": {
"summary": "Download documents of a document type",
"description": "Downloads documents of the same document type as a zip file. The type of the documents must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StreamedResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to a specific contact ID.",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to the specific plenty ID.",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created within a certain period of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were updated within a certain period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed within a certain period of time. This filter can be used alone or can be combined with the displayDateFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "The type of the order document. The available types are receipt, zReport, tillCount, posCouponReceipt, posInvoice, posInvoiceCancellation, cancellation, invoiceExternal, invoice, deliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer, dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reorder, uploaded.",
"format": "string",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The number of documents to display per page. The default number displayed is 50. The maximum number is 6000.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/documents\/{type}": {
"get": {
"summary": "List documents of a type",
"description": "Lists documents of a type. The type must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Document",
"items": {
"$ref": "#\/definitions\/Document"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contactId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to a specific contact ID.",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search results to documents belonging to the specific plenty ID.",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were created within a certain period of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were updated within a certain period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "displayDateTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to documents that were displayed within a certain period of time. This filter can be used alone or can be combined with the displayDateFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "The type of the order document. The available types are receipt, tillCount, posCouponReceipt, posInvoice, posInvoiceCancellation, cancellation, zReport, invoiceExternal, invoice, deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer, dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reversal, reversalRefund, proFormaInvoice, reorder, uploaded.",
"format": "string",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The items per page to search for",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for a document. Currently possible are:\n \n - 'references' = The document reference objects that are associated with the document.<\/li>\n <\/ul>\n Example:
?with[]=references<\/code>",
"format": "integer",
"in": "query"
},
{
"name": "withContent",
"type": "boolean",
"required": false,
"description": "Load also the document content as base64 encoded string.",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/orders\/items\/dates": {
"post": {
"summary": "Create a date for an order item",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nCreates a date for an order item. The ID of the order item and the order item date must be specified. Also, an array containing the order item ID, the type ID of the order item date must be set. The following order item date type IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/items\/dates",
"schema": {
"type": "object",
"required": [
"orderItemId",
"typeId",
"date"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the date belongs to optional with typeId"
},
"typeId": {
"type": "integer",
"description": "The ID of the date type. The following types are available:\n\nStart date = 9\nEnd date = 10\nEstimated delivery date = 11\n optional with orderItemId"
},
"date": {
"type": "string"
}
}
}
}
]
}
},
"\/rest\/orders\/items\/dates\/{id}": {
"delete": {
"summary": "Delete a date of an order item",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes the date of an order item. The ID of the date must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item date",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get date of an order item",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nGets a date of an order item. The ID of the date must be specified. The following IDs are available:\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item date",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a date of an order item",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates a date of an order item. The ID of the date must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item date",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/dates\/{id}",
"schema": {
"type": "object",
"required": [
"date"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the date belongs to optional"
},
"typeId": {
"type": "integer",
"description": "The ID of the date type. The following types are available:\n\nStart date = 9\nEnd date = 10\nEstimated delivery date = 11\n optional"
},
"date": {
"type": "string"
}
}
}
}
]
}
},
"\/rest\/orders\/items\/outgoing_stocks": {
"delete": {
"summary": "Revert outgoing stock for order items",
"description": "Reverts the booking of the given order items of an order. The order items have to be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/items\/outgoing_stocks",
"schema": {
"type": "object",
"required": [
"id",
"warehouseId",
"quantity"
],
"properties": {
"id": {
"type": "integer",
"description": "The Id of the order item to be booked back in."
},
"warehouseId": {
"type": "integer",
"description": "The Id of the warehouse, where the quantity should be booked back in. optional"
},
"quantity": {
"type": "number",
"description": "The quantity for this order item to be booked back in. optional"
},
"batch": {
"type": "string",
"description": "[optional] The batch for this order item, to be booked back in. optional"
},
"bestBeforeDate": {
"type": "string",
"description": "[optional] The best before date for this order item, to be booked back in. optional"
},
"reasonId": {
"type": "integer",
"description": "[optional] The Id of the reason, why the quantity for this order item should be booked back in.\nPossible values are one of the following: optional"
}
}
}
}
]
}
},
"\/rest\/orders\/items\/properties": {
"post": {
"summary": "Create order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nCreates an order item property. The request data must contain the order item ID, the order item property type ID and the value depending on the property type. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 20 = ORIGINAL_WAREHOUSE<\/li>\n
- 21 = ORIGINAL_QUANTITY<\/li>\n
- 22 = CATEGORY_ID<\/li>\n
- 23 = MARKET_FEE<\/li>\n
- 24 = STOCK_REVERSING<\/li>\n
- 25 = DISPUTE_STATUS<\/li>\n
- 26 = NO_CHANGE_BY_CONTACT<\/li>\n
- 29 = SIZE<\/li>\n
- 30 = LOCATION_RESERVED<\/li>\n
- 31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n
- 32 = PARTIAL_SHIPPING_COSTS<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 35 = RETURNS_REASON<\/li>\n
- 36 = RETURNS_ITEM_STATUS<\/li>\n
- 37 = FULFILLMENT_CENTER_ID<\/li>\n
- 38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n
- 39 = REORDER_ITEM_ID<\/li>\n
- 40 = LISTING_TYPE<\/li>\n
- 46 = SOLD_COUPON_CODE<\/li>\n
- 48 = ORDER_ITEM_STATE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/items\/properties",
"schema": {
"type": "object",
"required": [
"orderItemId",
"typeId",
"value"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the property belongs to. optional with typeId"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type.\n\nWAREHOUSE\t\t =\t1\nSHIPPING_PROFILE\t =\t2\nPAYMENT_METHOD\t =\t3\nWEIGHT\t\t\t =\t11\nWIDTH\t\t\t =\t12\nLENGTH\t\t =\t13\nHEIGHT\t \t\t = 14\nEXTERNAL_TOKEN_ID =\t16\nEXTERNAL_ITEM_ID =\t17\nCOUPON_CODE\t \t =\t18\nCOUPON_TYPE\t\t =\t19\nORIGINAL_WAREHOUSE\t =\t20\nORIGINAL_QUANTITY =\t21\nCATEGORY_ID = 22\nMARKET_FEE\t\t =\t23\nSTOCK_REVERSING\t =\t24\nDISPUTE_STATUS \t =\t25\nNO_CHANGE_BY_CONTACT = 26\nSIZE \t\t\t =\t29\nLOCATION_RESERVED\t =\t30\nEXTERNAL_SHIPMENT_ITEM_ID =\t31\nPARTIAL_SHIPPING_COSTS =\t32\nMAIN_DOCUMENT_NUMBER =\t33\nSALES_TAX_ID_NUMBER =\t34\nRETURNS_REASON =\t35\nRETURNS_ITEM_STATUS =\t36\nFULFILLMENT_CENTER_ID = 37\nFULFILLMENT_CENTER_COUNTRY_ISO = 38\nREORDER_ITEM_ID = 39\nLISTING_TYPE = 40\nSOLD_COUPON_CODE = 46\nORDER_ITEM_STATE = 48\n optional with orderItemId"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on type."
}
}
}
}
]
}
},
"\/rest\/orders\/items\/properties\/{id}": {
"delete": {
"summary": "Delete order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes an order item property. The ID of the order item property must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item property.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get order item property",
"description": "Gets an order item property. The ID of the order item property must be specified.\nDEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item property.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates an order item property. The ID of the order item property must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order item property instance to be updated.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/properties\/{id}",
"schema": {
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the property belongs to. optional"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type.\n\nWAREHOUSE\t\t =\t1\nSHIPPING_PROFILE\t =\t2\nPAYMENT_METHOD\t =\t3\nWEIGHT\t\t\t =\t11\nWIDTH\t\t\t =\t12\nLENGTH\t\t =\t13\nHEIGHT\t \t\t = 14\nEXTERNAL_TOKEN_ID =\t16\nEXTERNAL_ITEM_ID =\t17\nCOUPON_CODE\t \t =\t18\nCOUPON_TYPE\t\t =\t19\nORIGINAL_WAREHOUSE\t =\t20\nORIGINAL_QUANTITY =\t21\nCATEGORY_ID = 22\nMARKET_FEE\t\t =\t23\nSTOCK_REVERSING\t =\t24\nDISPUTE_STATUS \t =\t25\nNO_CHANGE_BY_CONTACT = 26\nSIZE \t\t\t =\t29\nLOCATION_RESERVED\t =\t30\nEXTERNAL_SHIPMENT_ITEM_ID =\t31\nPARTIAL_SHIPPING_COSTS =\t32\nMAIN_DOCUMENT_NUMBER =\t33\nSALES_TAX_ID_NUMBER =\t34\nRETURNS_REASON =\t35\nRETURNS_ITEM_STATUS =\t36\nFULFILLMENT_CENTER_ID = 37\nFULFILLMENT_CENTER_COUNTRY_ISO = 38\nREORDER_ITEM_ID = 39\nLISTING_TYPE = 40\nSOLD_COUPON_CODE = 46\nORDER_ITEM_STATE = 48\n optional"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on type."
}
}
}
}
]
}
},
"\/rest\/orders\/items\/transactions": {
"get": {
"summary": "Search order item transactions",
"description": "Searches for order item transactions by filter parameters.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of OrderItemTransaction",
"items": {
"$ref": "#\/definitions\/OrderItemTransaction"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of orders to be displayed per page. The default number of orders per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "Specifies the properties of the order item transactions to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Loads additional relations of the order item transactions. The available relations are 'orderItem' and 'warehouseLocation'.",
"format": "integer",
"in": "query"
},
{
"name": "sortBy",
"type": "string",
"required": false,
"description": "Sort search result according to createdAt, updatedAt, orderItemId, receiptId or quantity. The default value is orderItemId.",
"format": "string",
"in": "query"
},
{
"name": "sortOrder",
"type": "string",
"required": false,
"description": "Sort direction desc or asc. The default value is asc.",
"format": "string",
"in": "query"
},
{
"name": "orderItemId",
"type": "integer",
"required": false,
"description": "The ID of the order item",
"format": "integer",
"in": "query"
},
{
"name": "orderId",
"type": "integer",
"required": false,
"description": "The ID of the order",
"format": "integer",
"in": "query"
},
{
"name": "direction",
"type": "string",
"required": false,
"description": "The direction of the order item transactions",
"format": "string",
"in": "query"
},
{
"name": "status",
"type": "string",
"required": false,
"description": "The status of the order item transactions ('in' for incoming or 'out' for outgoing)",
"format": "string",
"in": "query"
},
{
"name": "isBooked",
"type": "boolean",
"required": false,
"description": "Returns all booked order item transactions.",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/orders\/items\/transactions\/booking": {
"post": {
"summary": "Book order item transactions",
"description": "Books order item transactions. Transactions are order item movements. These are incoming and outgoing items. The IDs of the order item transactions must be specified. To get the transactions first, use the Search transactions<\/a> call.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderBooking"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "transactionIds",
"type": "integer",
"required": true,
"description": "The IDs of the order item transactions.",
"format": "integer",
"in": "query"
},
{
"name": "deliveryNoteNumber",
"type": "string",
"required": false,
"description": "If desired, set a delivery note number. The delivery note number has to match the type of order item transaction. For incoming items, set an external delivery note number. For outgoing items, set an external or an internal delivery note number.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/items\/transactions\/{transactionId}": {
"delete": {
"summary": "Delete order item transaction",
"description": "Deletes an order item transaction. Transactions are order item movements. These are incoming and outgoing items. The ID of the transaction must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "transactionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update order item transaction",
"description": "Updates an order item transaction. Transactions are order item movements. These are incoming and outgoing items.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemTransaction"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "transactionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/transactions\/{transactionId}",
"schema": {
"type": "object",
"properties": {
"warehouseLocationId": {
"type": "integer",
"description": "The ID of the warehouse location"
},
"batch": {
"type": "string",
"description": "The batch"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date"
}
}
}
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/booking": {
"post": {
"summary": "Book an order item in",
"description": "Books an order item in. The ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderBooking"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item.",
"format": "integer",
"in": "path"
},
{
"name": "deliveryNoteNumber",
"type": "string",
"required": false,
"description": "If desired, set the delivery note number provided by the supplier.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/dates": {
"get": {
"summary": "List all dates of an order item",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nLists all dates of an order item. The ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderItemDate"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/dates\/{typeId}": {
"delete": {
"summary": "Delete a date of an order item by order item and date type",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes a date of an order item. The ID of the order item and the ID of the date type must be specified. The following order item date type IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a date of an order item by order item and date type",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nGets a date of an order item. The ID of the order item and the ID of the date type must be specified.\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date type",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a date for an order item by order item and date type",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nCreates a date for an order item. The ID of the order item and the ID of the date type must be specified. The following order item date type IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date type",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/{orderItemId}\/dates\/{typeId}",
"schema": {
"type": "object",
"required": [
"orderItemId",
"typeId",
"date"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the date belongs to optional with typeId"
},
"typeId": {
"type": "integer",
"description": "The ID of the date type. The following types are available:\n\nStart date = 9\nEnd date = 10\nEstimated delivery date = 11\n optional with orderItemId"
},
"date": {
"type": "string"
}
}
}
}
]
},
"put": {
"summary": "Update a date of an order item by order item and date type",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates the date of an order item. The ID of the order item and the ID of the date type must be specified. The following order item date type IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date type",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/{orderItemId}\/dates\/{typeId}",
"schema": {
"type": "object",
"required": [
"date"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the date belongs to optional"
},
"typeId": {
"type": "integer",
"description": "The ID of the date type. The following types are available:\n\nStart date = 9\nEnd date = 10\nEstimated delivery date = 11\n optional"
},
"date": {
"type": "string"
}
}
}
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/properties": {
"get": {
"summary": "Get all order item properties",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nGets all order item properties for one order item. The order item ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderItemProperty"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The order item ID.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/properties\/{typeId}": {
"delete": {
"summary": "Delete order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes an order item property. The order item ID and the order item property type ID must be specified. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 20 = ORIGINAL_WAREHOUSE<\/li>\n
- 21 = ORIGINAL_QUANTITY<\/li>\n
- 22 = CATEGORY_ID<\/li>\n
- 23 = MARKET_FEE<\/li>\n
- 24 = STOCK_REVERSING<\/li>\n
- 25 = DISPUTE_STATUS<\/li>\n
- 26 = NO_CHANGE_BY_CONTACT<\/li>\n
- 29 = SIZE<\/li>\n
- 30 = LOCATION_RESERVED<\/li>\n
- 31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n
- 32 = PARTIAL_SHIPPING_COSTS<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 35 = RETURNS_REASON<\/li>\n
- 36 = RETURNS_ITEM_STATUS<\/li>\n
- 37 = FULFILLMENT_CENTER_ID<\/li>\n
- 38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n
- 39 = REORDER_ITEM_ID<\/li>\n
- 40 = LISTING_TYPE<\/li>\n
- 46 = SOLD_COUPON_CODE<\/li>\n
- 48 = ORDER_ITEM_STATE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The order item ID.",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The order item property type ID.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get order item property",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nGets an order item property. The order item ID and the order item property type ID must be specified. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 20 = ORIGINAL_WAREHOUSE<\/li>\n
- 21 = ORIGINAL_QUANTITY<\/li>\n
- 22 = CATEGORY_ID<\/li>\n
- 23 = MARKET_FEE<\/li>\n
- 24 = STOCK_REVERSING<\/li>\n
- 25 = DISPUTE_STATUS<\/li>\n
- 26 = NO_CHANGE_BY_CONTACT<\/li>\n
- 29 = SIZE<\/li>\n
- 30 = LOCATION_RESERVED<\/li>\n
- 31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n
- 32 = PARTIAL_SHIPPING_COSTS<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 35 = RETURNS_REASON<\/li>\n
- 36 = RETURNS_ITEM_STATUS<\/li>\n
- 37 = FULFILLMENT_CENTER_ID<\/li>\n
- 38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n
- 39 = REORDER_ITEM_ID<\/li>\n
- 40 = LISTING_TYPE<\/li>\n
- 46 = SOLD_COUPON_CODE<\/li>\n
- 48 = ORDER_ITEM_STATE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item.",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order item property type.",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nCreates an order item property. The order item ID and the order item property type ID must be specified. The following properties are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 20 = ORIGINAL_WAREHOUSE<\/li>\n
- 21 = ORIGINAL_QUANTITY<\/li>\n
- 22 = CATEGORY_ID<\/li>\n
- 23 = MARKET_FEE<\/li>\n
- 24 = STOCK_REVERSING<\/li>\n
- 25 = DISPUTE_STATUS<\/li>\n
- 26 = NO_CHANGE_BY_CONTACT<\/li>\n
- 29 = SIZE<\/li>\n
- 30 = LOCATION_RESERVED<\/li>\n
- 31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n
- 32 = PARTIAL_SHIPPING_COSTS<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 35 = RETURNS_REASON<\/li>\n
- 36 = RETURNS_ITEM_STATUS<\/li>\n
- 37 = FULFILLMENT_CENTER_ID<\/li>\n
- 38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n
- 39 = REORDER_ITEM_ID<\/li>\n
- 40 = LISTING_TYPE<\/li>\n
- 46 = SOLD_COUPON_CODE<\/li>\n
- 48 = ORDER_ITEM_STATE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The order item ID.",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The order item property type ID.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/{orderItemId}\/properties\/{typeId}",
"schema": {
"type": "object",
"required": [
"orderItemId",
"typeId",
"value"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the property belongs to. optional with typeId"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type.\n\nWAREHOUSE\t\t =\t1\nSHIPPING_PROFILE\t =\t2\nPAYMENT_METHOD\t =\t3\nWEIGHT\t\t\t =\t11\nWIDTH\t\t\t =\t12\nLENGTH\t\t =\t13\nHEIGHT\t \t\t = 14\nEXTERNAL_TOKEN_ID =\t16\nEXTERNAL_ITEM_ID =\t17\nCOUPON_CODE\t \t =\t18\nCOUPON_TYPE\t\t =\t19\nORIGINAL_WAREHOUSE\t =\t20\nORIGINAL_QUANTITY =\t21\nCATEGORY_ID = 22\nMARKET_FEE\t\t =\t23\nSTOCK_REVERSING\t =\t24\nDISPUTE_STATUS \t =\t25\nNO_CHANGE_BY_CONTACT = 26\nSIZE \t\t\t =\t29\nLOCATION_RESERVED\t =\t30\nEXTERNAL_SHIPMENT_ITEM_ID =\t31\nPARTIAL_SHIPPING_COSTS =\t32\nMAIN_DOCUMENT_NUMBER =\t33\nSALES_TAX_ID_NUMBER =\t34\nRETURNS_REASON =\t35\nRETURNS_ITEM_STATUS =\t36\nFULFILLMENT_CENTER_ID = 37\nFULFILLMENT_CENTER_COUNTRY_ISO = 38\nREORDER_ITEM_ID = 39\nLISTING_TYPE = 40\nSOLD_COUPON_CODE = 46\nORDER_ITEM_STATE = 48\n optional with orderItemId"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on type."
}
}
}
}
]
},
"put": {
"summary": "Update order item property",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates an order item property. The order item ID and the order item property type ID must be specified. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 20 = ORIGINAL_WAREHOUSE<\/li>\n
- 21 = ORIGINAL_QUANTITY<\/li>\n
- 22 = CATEGORY_ID<\/li>\n
- 23 = MARKET_FEE<\/li>\n
- 24 = STOCK_REVERSING<\/li>\n
- 25 = DISPUTE_STATUS<\/li>\n
- 26 = NO_CHANGE_BY_CONTACT<\/li>\n
- 29 = SIZE<\/li>\n
- 30 = LOCATION_RESERVED<\/li>\n
- 31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n
- 32 = PARTIAL_SHIPPING_COSTS<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 35 = RETURNS_REASON<\/li>\n
- 36 = RETURNS_ITEM_STATUS<\/li>\n
- 37 = FULFILLMENT_CENTER_ID<\/li>\n
- 38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n
- 39 = REORDER_ITEM_ID<\/li>\n
- 40 = LISTING_TYPE<\/li>\n
- 46 = SOLD_COUPON_CODE<\/li>\n
- 48 = ORDER_ITEM_STATE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The order item ID.",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The order item property type ID.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/{orderItemId}\/properties\/{typeId}",
"schema": {
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item that the property belongs to. optional"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type.\n\nWAREHOUSE\t\t =\t1\nSHIPPING_PROFILE\t =\t2\nPAYMENT_METHOD\t =\t3\nWEIGHT\t\t\t =\t11\nWIDTH\t\t\t =\t12\nLENGTH\t\t =\t13\nHEIGHT\t \t\t = 14\nEXTERNAL_TOKEN_ID =\t16\nEXTERNAL_ITEM_ID =\t17\nCOUPON_CODE\t \t =\t18\nCOUPON_TYPE\t\t =\t19\nORIGINAL_WAREHOUSE\t =\t20\nORIGINAL_QUANTITY =\t21\nCATEGORY_ID = 22\nMARKET_FEE\t\t =\t23\nSTOCK_REVERSING\t =\t24\nDISPUTE_STATUS \t =\t25\nNO_CHANGE_BY_CONTACT = 26\nSIZE \t\t\t =\t29\nLOCATION_RESERVED\t =\t30\nEXTERNAL_SHIPMENT_ITEM_ID =\t31\nPARTIAL_SHIPPING_COSTS =\t32\nMAIN_DOCUMENT_NUMBER =\t33\nSALES_TAX_ID_NUMBER =\t34\nRETURNS_REASON =\t35\nRETURNS_ITEM_STATUS =\t36\nFULFILLMENT_CENTER_ID = 37\nFULFILLMENT_CENTER_COUNTRY_ISO = 38\nREORDER_ITEM_ID = 39\nLISTING_TYPE = 40\nSOLD_COUPON_CODE = 46\nORDER_ITEM_STATE = 48\n optional"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on type."
}
}
}
}
]
}
},
"\/rest\/orders\/items\/{orderItemId}\/transactions": {
"get": {
"summary": "List order item transactions",
"description": "Lists transactions for an order item. Transactions are order item movements. These are incoming and outgoing items. The ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderItemTransaction"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for a transaction. Currently possible are 'orderItem' and 'warehouseLocation'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create order item transaction",
"description": "Creates an order item transaction. Transactions are order item movements. These are incoming and outgoing items. The ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderItemTransaction"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/items\/{orderItemId}\/transactions",
"schema": {
"type": "object",
"required": [
"orderItemId",
"quantity",
"direction",
"status"
],
"properties": {
"orderItemId": {
"type": "integer",
"description": "The ID of the order item"
},
"quantity": {
"type": "number",
"description": "The quantity"
},
"userId": {
"type": "integer",
"description": "The ID of the user"
},
"identification": {
"type": "string",
"description": "External identification. Can be an arbitrary string."
},
"direction": {
"type": "string",
"description": "The direction. Possible values are 'in' and 'out'. allowed values are in, out"
},
"status": {
"type": "string",
"description": "The status. Possible values are 'regular' and 'cancelled'. allowed values are regular, cancelled"
},
"receiptId": {
"type": "integer",
"description": "The receipt ID"
},
"warehouseLocationId": {
"type": "integer",
"description": "The ID of the warehouse location"
},
"batch": {
"type": "string",
"description": "The batch"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date"
}
}
}
}
]
}
},
"\/rest\/orders\/properties\/types": {
"get": {
"summary": "List order property types",
"description": "Lists property types and their names in all languages. Optionally, one or more languages can be specified to get a limited response. The following property types are available by default:\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 4 = PAYMENT_STATUS<\/li>\n
- 5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n
- 6 = DOCUMENT_LANGUAGE<\/li>\n
- 7 = EXTERNAL_ORDER_ID<\/li>\n
- 8 = CUSTOMER_SIGN<\/li>\n
- 9 = DUNNING_LEVEL<\/li>\n
- 10 = SELLER_ACCOUNT<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 15 = FLAG<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 45 = PAYMENT_TRANSACTION_ID<\/li>\n
- 47 = EXTERNAL_TAX_SERVICE<\/li>\n
- 60 = MERCHANT_ID<\/li>\n
- 61 = REPORT_ID<\/li>\n
- 63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n
- 64 = AMAZON_SHIPPING_LABEL<\/li>\n
- 994 = EBAY_PLUS<\/li>\n
- 995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderPropertyType"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "lang",
"type": "integer",
"required": false,
"description": "If no parameter is set here, all languages are loaded by default. Optionally, enter an arry containing the ISO codes of the desired languages.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create order property type",
"description": "Creates an order property type. After creating the order property type, it can be linked to an existing order using the property type ID.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderPropertyType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/properties\/types",
"schema": {
"type": "object",
"required": [
"names",
"lang",
"name"
],
"properties": {
"position": {
"type": "integer",
"description": "The position for sorting"
},
"cast": {
"type": "string",
"description": "The data type of the values of this property type. Valid types are:\n\n\tstring\n\tint\n\tnumeric\n\tbool\n\tenum(val1,val2,val3,...)\n optional"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderPropertyTypeName"
}
},
"lang": {
"type": "string",
"description": "The language of the type name"
},
"name": {
"type": "string",
"description": "The name of property type"
}
}
}
}
]
}
},
"\/rest\/orders\/properties\/types\/{typeId}": {
"delete": {
"summary": "Delete property type",
"description": "Deletes a property type and all names for it from the database. The ID of the property type must be specified. Property type IDs lower than 1,000 cannot be deleted because they are system defaults.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the property type",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get property type",
"description": "Gets a property type and its names in all languages. Optionally, one or more languages can be specified to get a limited response. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 4 = PAYMENT_STATUS<\/li>\n
- 5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n
- 6 = DOCUMENT_LANGUAGE<\/li>\n
- 7 = EXTERNAL_ORDER_ID<\/li>\n
- 8 = CUSTOMER_SIGN<\/li>\n
- 9 = DUNNING_LEVEL<\/li>\n
- 10 = SELLER_ACCOUNT<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 15 = FLAG<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 45 = PAYMENT_TRANSACTION_ID<\/li>\n
- 47 = EXTERNAL_TAX_SERVICE<\/li>\n
- 60 = MERCHANT_ID<\/li>\n
- 61 = REPORT_ID<\/li>\n
- 63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n
- 64 = AMAZON_SHIPPING_LABEL<\/li>\n
- 994 = EBAY_PLUS<\/li>\n
- 995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderPropertyType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the type.",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": false,
"description": "If no parameter is set here, all languages for the property are loaded by default. Optionally, enter an arry containing the ISO codes of the desired languages.",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update property type",
"description": "Updates a property type and its names. The ID of the property type must be specified. If names that do not yet exist for a language are provided, they will be created. Property type IDs lower than 1,000 cannot be updated because they are system defaults.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderPropertyType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/properties\/types\/{typeId}",
"schema": {
"type": "object",
"required": [
"lang",
"name"
],
"properties": {
"position": {
"type": "integer",
"description": "The position for sorting"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderPropertyTypeName"
}
},
"lang": {
"type": "string",
"description": "The language of the type name"
},
"name": {
"type": "string",
"description": "The name of property type"
}
}
}
}
]
}
},
"\/rest\/orders\/properties\/{id}": {
"delete": {
"summary": "Delete property of an order by property ID",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes a property of an order. The ID of the property must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the property to be deleted.",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update property of an order by property ID",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates the value of a property. The ID of the property must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/properties\/{id}",
"schema": {
"type": "object",
"required": [
"id",
"typeId",
"value"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the order property"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following types are available:\n\n WAREHOUSE\t\t=\t1\n SHIPPING_PROFILE\t=\t2\n PAYMENT_METHOD\t\t\t=\t3\n PAYMENT_STATUS\t\t\t=\t4\n EXTERNAL_SHIPPING_PROFILE\t\t\t=\t5\n DOCUMENT_LANGUAGE\t\t\t=\t6\n EXTERNAL_ORDER_ID\t\t\t=\t7\n CUSTOMER_SIGN\t\t\t=\t8\n DUNNING_LEVEL\t\t\t=\t9\n SELLER_ACCOUNT\t\t\t=\t10\n WEIGHT\t\t\t=\t11\n WIDTH\t\t\t=\t12\n LENGTH =\t13\n HEIGHT\t\t=\t14\n FLAG\t\t\t=\t15\n EXTERNAL_TOKEN_ID\t\t\t=\t16\n EXTERNAL_ITEM_ID\t\t\t=\t17\n COUPON_CODE\t\t\t=\t18\n COUPON_TYPE = 19\n SALES_TAX_ID_NUMBER = 34\n MAIN_DOCUMENT_NUMBER = 33\n PAYMENT_TRANSACTION_ID = 45\n EXTERNAL_TAX_SERVICE = 47\n MERCHANT_ID = 60\n REPORT_ID = 61\n PREFERRED_STORAGE_LOCATION_ID = 63\n AMAZON_SHIPPING_LABEL = 64\n EBAY_PLUS = 994\n FULFILLMENT_SERVICE = 995"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on the type."
}
}
}
}
]
}
},
"\/rest\/orders\/referrers": {
"get": {
"summary": "List referrers",
"description": "Lists referrers with the desired columns\/attributes.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderReferrer"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The desired columns\/attributes of the order referrer to be loaded.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/countries": {
"get": {
"summary": "List shipping countries",
"description": "Lists all shipping countries.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "active",
"type": "integer",
"required": false,
"description": "Returns only the active shipping countries.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'states' and 'names'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/export_documents\/{orderId}": {
"get": {
"summary": "List export documents by order ID",
"description": "",
"tags": [
"Export"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ExportDocument"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/package_types": {
"get": {
"summary": "List shipping package types",
"description": "Lists all shipping packages types.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ShippingPackageType"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/shipping\/package_types\/{shippingPackageTypeId}": {
"get": {
"summary": "Get a shipping package type",
"description": "Gets a shipping package type. The ID of the shipping package type must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingPackageType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "shippingPackageTypeId",
"type": "integer",
"required": true,
"description": "The ID of the shipping package type",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/packages\/items\/{id}": {
"delete": {
"summary": "Delete package, variation or quantity for an order",
"description": "Deletes the package, variation or quantity in a package. The ID of the order package item variation is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order package item variation",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update package, variation or quantity for an order",
"description": "Updates the package, variation or quantity in a package. The ID of the order package item variation is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the order package item variation",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/packages\/items\/{packageId}\/{itemId}\/{variationId}": {
"delete": {
"summary": "Delete items of an order package",
"description": "Deletes the items of an order package. The ID of the package, of the item and of the variation are mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "packageId",
"type": "integer",
"required": true,
"description": "The ID of the package",
"format": "integer",
"in": "path"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update items of an order package",
"description": "Updates the items of an order package. The ID of the package, of the item and of the variation are mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "packageId",
"type": "integer",
"required": true,
"description": "The ID of the package",
"format": "integer",
"in": "path"
},
{
"name": "itemId",
"type": "integer",
"required": true,
"description": "The ID of the item",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "The ID of the variation",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/packages\/{packageId}\/items": {
"get": {
"summary": "List items of an order package",
"description": "Lists items of an order package. The ID of the package must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackageItems"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "packageId",
"type": "integer",
"required": true,
"description": "The ID of the order package",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create package, variation or quantity for an order",
"description": "Creates the package, variation or quantity in a package. The ID of the order package item variation is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "packageId",
"type": "integer",
"required": true,
"description": "The ID of the order package",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/pallets": {
"get": {
"summary": "List order shipping pallets",
"description": "Lists order shipping pallets. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderShippingPallet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "string",
"required": true,
"description": "The ID of the order",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create order shipping pallets",
"description": "Creates order shipping pallets.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPallet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/shipping\/pallets",
"schema": {
"type": "object",
"required": [
"individualWeight",
"width",
"height",
"length",
"isStackable"
],
"properties": {
"individualWeight": {
"type": "number",
"description": "The weight of the order shipping pallet"
},
"width": {
"type": "number",
"description": "The width of the order shipping pallet"
},
"height": {
"type": "number",
"description": "The height of the order shipping pallet"
},
"length": {
"type": "number",
"description": "The length of the order shipping pallet"
},
"isStackable": {
"type": "boolean",
"description": "Flag to tell if the pallet is stackable or not. If true, another pallet can be placed over the current one"
}
}
}
}
]
}
},
"\/rest\/orders\/shipping\/pallets\/{palletId}": {
"delete": {
"summary": "Delete all pallets of an order",
"description": "Deletes all pallets of an order. The ID of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPallet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/shipping\/pallets\/{palletId}",
"schema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the order shipping pallet"
}
}
}
}
]
},
"get": {
"summary": "List all pallets of an order",
"description": "Lists all pallets of an order. The ID of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPallet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update all pallets of an order",
"description": "Updates all pallets of an order. The ID of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPallet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/shipping\/pallets\/{palletId}",
"schema": {
"type": "object",
"required": [
"individualWeight",
"width",
"height",
"length",
"isStackable"
],
"properties": {
"individualWeight": {
"type": "number",
"description": "The weight of the order shipping pallet"
},
"width": {
"type": "number",
"description": "The width of the order shipping pallet"
},
"height": {
"type": "number",
"description": "The height of the order shipping pallet"
},
"length": {
"type": "number",
"description": "The length of the order shipping pallet"
},
"isStackable": {
"type": "boolean",
"description": "Flag to tell if the pallet is stackable or not. If true, another pallet can be placed over the current one"
}
}
}
}
]
}
},
"\/rest\/orders\/shipping\/parcel_service_regions\/{parcelServiceRegionId}": {
"get": {
"summary": "Get an order parcel service region",
"description": "Gets an parcel service region. The ID of the parcel service region must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ParcelServiceRegion"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "parcelServiceRegionId",
"type": "integer",
"required": true,
"description": "The ID of the parcel service region",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/presets": {
"get": {
"summary": "List shipping profiles",
"description": "Lists all shipping profiles.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ParcelServicePreset"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded in the shipping profile",
"format": "integer",
"in": "query"
},
{
"name": "parcelServiceName",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to parcel service presets with a specified service name (e.g. 'DHL' for DHL)",
"format": "string",
"in": "query"
},
{
"name": "shippingServiceProvider",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to a shipping service provider",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "string",
"required": false,
"description": "The name of an relation to the preset. The following parameter is available: parcelServiceRegion, parcelServiceRegionConstraint, parcelServicePresetNames and parcelServiceNames.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtBefore",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to presets that were updated before a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss",
"format": "string",
"in": "query"
},
{
"name": "updatedAtAfter",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to presets that were updated after a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/presets\/{presetId}": {
"get": {
"summary": "Get a shipping profile",
"description": "Gets a shipping profile. The ID of the shipping profile must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ParcelServicePreset"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "presetId",
"type": "integer",
"required": true,
"description": "The ID of the shipping profile",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded in the shipping profile",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/presets\/{presetId}\/parcel_service_regions": {
"get": {
"summary": "List parcel service regions by parcel service preset ID",
"description": "Lists parcel service regions. The ID of the parcel service preset must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ParcelServiceRegion"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "presetId",
"type": "integer",
"required": true,
"description": " The ID of the preset",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/returns\/returns_service_providers": {
"get": {
"summary": "List returns service providers",
"description": "Lists all returns service providers.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ReturnsServiceProvider",
"items": {
"$ref": "#\/definitions\/ReturnsServiceProvider"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "isPlugin",
"type": "integer",
"required": false,
"description": "Possible values are 1 (true) and 0 (false).",
"format": "integer",
"in": "query"
},
{
"name": "pluginId",
"type": "integer",
"required": false,
"description": "The ID of the plugin",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/returns\/returns_service_providers\/plugins": {
"get": {
"summary": "List returns service provider plugins",
"description": "Lists all returns service provider plugins.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/shipping\/returns\/returns_service_providers\/{providerId}": {
"get": {
"summary": "Get returns service provider by the ID",
"description": "Gets a specific returns service provider. The ID of the returns service provider must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ReturnsServiceProvider"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "providerId",
"type": "integer",
"required": true,
"description": "The ID of the returns service provider",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/shipping\/returns\/{returnsId}": {
"get": {
"summary": "",
"description": "",
"tags": [
"Returns"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of OrderReturns",
"items": {
"$ref": "#\/definitions\/OrderReturns"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "returnsId",
"type": "integer",
"required": true,
"description": "The id of the order returns to search for.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order. Currently possible are:\n\t
\n\t- 'documents' = The document objects that are associated with the order returns.<\/li>\n\t
- 'labels' = The base64 encoded labels that are associated with the order returns.<\/li>\n\t<\/ul>\n\tExample:
?with[]=documents&with[]=labels<\/code>",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/shipping\/shipping_information": {
"get": {
"summary": "List orders with shipping information",
"description": "Lists all the orders with their shipping information.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create shipping information",
"description": "Creates the shipping information.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/shipping\/shipping_service_providers": {
"get": {
"summary": "List shipping service providers",
"description": "Lists all shipping service providers.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of ShippingServiceProvider",
"items": {
"$ref": "#\/definitions\/ShippingServiceProvider"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAtBefore",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to shipping providers that were updated before a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss",
"format": "string",
"in": "query"
},
{
"name": "updatedAtAfter",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to shipping providers that were updated after a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "string",
"required": false,
"description": "The name of an relation to the shipping provider. The following parameter is available: ownShippingServiceProviders.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Save a shipping service provider",
"description": "Saves a shipping service provider. The name of the shipping service provider must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingServiceProvider"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/shipping\/shipping_service_providers\/plugins": {
"get": {
"summary": "List shipping service provider plugins",
"description": "Lists all shipping service provider plugins.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/shipping\/shipping_service_providers\/{shipping_service_provider_id}": {
"get": {
"summary": "Get a shipping service provider",
"description": "Gets a shipping service provider. The ID of the shipping service provider must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingServiceProvider"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "shippingServiceProviderId",
"type": "integer",
"required": true,
"description": "The ID of the shipping service provider",
"format": "integer",
"in": "query"
},
{
"name": "shipping_service_provider_id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/status-history": {
"get": {
"summary": "List status histories of orders",
"description": "Lists the status histories of all orders. The result can be limited to an order specified by an ID, a status with a particular ID, a period of time or a user specified by the user ID.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StatusHistoryEntry",
"items": {
"$ref": "#\/definitions\/StatusHistoryEntry"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": false,
"description": "The ID of the order",
"format": "integer",
"in": "query"
},
{
"name": "statusId",
"type": "number",
"required": false,
"description": "The ID of the status",
"format": "",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Set a start date to get status history entries beginning with this date",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Set an end date to get status history entries up to this date",
"format": "string",
"in": "query"
},
{
"name": "userId",
"type": "string",
"required": false,
"description": "The ID of the user",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/statuses": {
"get": {
"summary": "Searches for order statuses",
"description": "Searches for a list of order statuses. The search results are specified by providing filter parameters in the form of order status IDs.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of OrderStatus",
"items": {
"$ref": "#\/definitions\/OrderStatus"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "statusIdFrom",
"type": "number",
"required": false,
"description": "Define an ID as a start value for the filter. Filter that restricts the search for order statuses to IDs from a defined value.",
"format": "",
"in": "query"
},
{
"name": "statusIdTo",
"type": "number",
"required": false,
"description": "Define an ID as an end value for the filter.",
"format": "",
"in": "query"
}
]
},
"post": {
"summary": "Creates an order status.",
"description": "Creates an order status. The ID of the order status must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderStatus"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/orders\/statuses",
"schema": {
"type": "object",
"required": [
"statusId",
"names"
],
"properties": {
"statusId": {
"type": "number",
"description": "The ID of the status."
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Collection"
}
}
}
}
}
]
}
},
"\/rest\/orders\/statuses\/all": {
"get": {
"summary": "Get all order statuses",
"description": "Gets all order statuses.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/orders\/statuses\/group_functions": {
"post": {
"summary": "Change order status properties",
"description": "Change properties of an order status. Properties are colour of the order status, visibility in the online store and availability for orders of the type reorder or redistribution.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "newStatusValues",
"type": "integer",
"required": true,
"description": "Set an array of new order status properties consisting of one key and one value for each property. The status colour must be set as a hexadecimal code. All other properties must be specified either by value 0 (inactive) or 1 (active).",
"format": "integer",
"in": "query"
},
{
"name": "selectedStatusList",
"type": "integer",
"required": true,
"description": "Set a list with the IDs of the order statuses that should be changed.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/statuses\/{statusId}": {
"delete": {
"summary": "Delete an order status",
"description": "Deletes an order status. The ID of the order status must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "statusId",
"type": "number",
"required": true,
"description": "The ID of the status, which shall be deleted.",
"format": "",
"in": "path"
}
]
},
"get": {
"summary": "Get an order status",
"description": "Gets an order status. The status has to be specified by providing a status ID.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderStatus"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "statusId",
"type": "number",
"required": true,
"description": "The ID of the order status.",
"format": "",
"in": "path"
}
]
},
"put": {
"summary": "Update an order status",
"description": "Updates an order status. The ID of the order status must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderStatus"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "statusId",
"type": "number",
"required": true,
"description": "The ID of the order status that should be updated.",
"format": "",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/statuses\/{statusId}",
"schema": {
"type": "object",
"properties": {
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Collection"
}
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}": {
"delete": {
"summary": "Delete an order",
"description": "Deletes an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order to be deleted.",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an order",
"description": "Gets an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order. The following relations are available:\n * \n - 'addresses' = The address objects linked to the order.<\/li>\n
- 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the reference type. The available reference types are parent and reorder. The ID of the reference and the relation itself are also available.<\/li>\n
- 'comments' = The order comments.<\/li>\n
- 'location' = The accounting location linked to the order.<\/li>\n
- 'payments' = The payments linked to the order.<\/li>\n
- 'documents' = The documents linked to the order.<\/li>\n
- 'contactSender' = The contact belonging the contact-sender relation.<\/li>\n
- 'contactReceiver' = The contact belonging to the contact-receiver relation.<\/li>\n
- 'warehouseSender' = The warehouse belonging to the warehouse-sender relation.<\/li>\n
- 'warehouseReceiver' = The warehouse belonging to the warehouse-receiver relation.<\/li>\n
- 'orderItems.variation' = The variation data belonging to the order item.<\/li>\n
- 'orderItems.giftCardCodes' = The gift card codes belonging to the order item.<\/li>\n
- 'orderItems.transactions' = The transactions belonging to the order item.<\/li>\n
- 'orderItems.serialNumbers' = The serial numbers belonging to the order item.<\/li>\n
- 'orderItems.variationBarcodes' = The barcodes belonging to the order item.<\/li>\n
- 'orderItems.comments' = The comments belonging to the order item.<\/li>\n
- 'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n
- deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations linked to the order item.<\/li>\n <\/ul>\n Example:
?with[]=addresses&with[]=orderItems.variation<\/code>",
"format": "integer",
"in": "query"
},
{
"name": "addOrderItems",
"type": "boolean",
"required": false,
"description": "Add the order items to the result. Default = true.",
"format": "boolean",
"in": "query"
}
]
},
"put": {
"summary": "Update an order",
"description": "Updates an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}",
"schema": {
"type": "object",
"properties": {
"plentyId": {
"type": "integer",
"description": "The plenty ID of the client that the order belongs to optional"
},
"statusId": {
"type": "number",
"description": "The ID of the order status optional"
},
"ownerId": {
"type": "integer",
"description": "The user ID of the order's owner optional"
},
"orderItems": {
"type": "array",
"items": {}
},
"properties": {
"type": "array",
"items": {}
},
"addressRelations": {
"type": "array",
"items": {}
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/booking": {
"post": {
"summary": "Book an order in",
"description": "Books an order in, e.g. an order of the type reorder. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderBooking"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
},
{
"name": "deliveryNoteNumber",
"type": "string",
"required": false,
"description": "If desired, set the delivery note number provided by the supplier.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/cancel": {
"put": {
"summary": "Cancel an order",
"description": "Cancels an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order to be canceled.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/cancel",
"schema": {
"type": "object",
"properties": {
"statusId": {
"type": "number",
"description": "The ID of the order status optional"
},
"message": {
"type": "string",
"description": "The message that is displayed in the status history optional"
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/contactWish": {
"get": {
"summary": "Get a contact wish",
"description": "Gets the contact wish for an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ContactWish"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/coupons\/{coupon}": {
"post": {
"summary": "Redeem a coupon code",
"description": "Redeems a coupon code and applies it to an order. The ID of the order must be specified. If the coupon was successfully redeemed, the coupon data will be returned. If the coupon can not be redeemed, a validation exception will be thrown.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CouponCodeValidation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order to redeem the coupon",
"format": "integer",
"in": "path"
},
{
"name": "coupon",
"type": "string",
"required": true,
"description": "The coupon code to be redeemed",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/dates": {
"get": {
"summary": "List all dates of an order",
"description": "Lists all dates of an order. The ID of the order must be specified.\nDEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderDate"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/dates\/{typeId}": {
"get": {
"summary": "Get a date",
"description": "DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nGets a date. The ID of the order and the ID of the date type must be specified. The following IDs are available:\n\n
\n- 1 = Deleted on<\/li>\n
- 2 = Created on<\/li>\n
- 3 = Paid date<\/li>\n
- 4 = Last update<\/li>\n
- 5 = Completed on<\/li>\n
- 6 = Return date<\/li>\n
- 7 = Payment due date<\/li>\n
- 8 = Estimated shipping date<\/li>\n
- 9 = Start date<\/li>\n
- 10 = End date<\/li>\n
- 11 = Possible delivery date<\/li>\n
- 12 = Market transfer date<\/li>\n
- 13 = Subscription cancelled on<\/li>\n
- 14 = Subscription last run<\/li>\n
- 15 = Subscription next run<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderDate"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "The ID of the order date type that should be found",
"format": "integer",
"in": "path"
},
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/delivery_orders": {
"post": {
"summary": "Create a delivery order from a parent order",
"description": "Creates a delivery order from a parent order. The parent order ID and the quantities to use must be specified.\nStructure of the data array:\n[\n 'quantities' => [\n [\n [\"orderItemId\" =>
],\n [\"quantity\" => ]\n ],\n ]\n]",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/delivery_orders\/automatic": {
"post": {
"summary": "Create delivery orders automatically for all order items",
"description": "Create delivery orders automatically for all order items. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/correction_document\/generate": {
"post": {
"summary": "Generate adjustment form of an order",
"description": "Generate adjustment form of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'credit note'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/credit_note\/generate": {
"post": {
"summary": "Generate credit note of an order",
"description": "Generate credit note of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'credit note'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'",
"format": "string",
"in": "query"
},
{
"name": "allowRegenerate",
"type": "boolean",
"required": false,
"description": "If true, existing credit not document without reversal is generated once again.",
"format": "boolean",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/delivery_note\/generate": {
"post": {
"summary": "Generate delivery note of an order",
"description": "Generate delivery note of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair' and 'delivery order'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
},
{
"name": "storehouseId",
"type": "integer",
"required": false,
"description": "If set, only items with the given warehouse ID are included on the document.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/dunning_letter\/generate": {
"post": {
"summary": "Generate dunning letter of an order",
"description": "Generate dunning letter of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair' and 'multi order'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
},
{
"name": "articleId",
"type": "integer",
"required": false,
"description": "Add an item to the order.",
"format": "integer",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Add a variation to the order.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/invoice\/generate": {
"post": {
"summary": "Generate invoice of an order",
"description": "Generate invoice of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair' and 'advance order'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "allowRegenerate",
"type": "boolean",
"required": false,
"description": "If true, existing invoice document without reversal is generated once again.",
"format": "boolean",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
},
{
"name": "valuta",
"type": "boolean",
"required": false,
"description": "If true, valuta is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "discount",
"type": "boolean",
"required": false,
"description": "If true, discount is enabled for the document.",
"format": "boolean",
"in": "query"
},
{
"name": "discountPercentage",
"type": "integer",
"required": false,
"description": "Overwrite percentage discount value. Possible values are 2, 3, 4, 5.",
"format": "integer",
"in": "query"
},
{
"name": "discountDays",
"type": "integer",
"required": false,
"description": "Overwrite discount in days. Possible values are 1, 5, 7, 10, 14, 21, 28, 30, 60, 90.",
"format": "integer",
"in": "query"
},
{
"name": "paymentDue",
"type": "boolean",
"required": false,
"description": "If true, payment due is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "paymentDueDays",
"type": "integer",
"required": false,
"description": "Overwrite payment due in days.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/offer\/generate": {
"post": {
"summary": "Generate offer document of an order",
"description": "Generate offer document of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'offer'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/order_confirmation\/generate": {
"post": {
"summary": "Generate order confirmation of an order",
"description": "Generate order confirmation of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair', 'advance order' and 'offer'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
},
{
"name": "valuta",
"type": "boolean",
"required": false,
"description": "If true, valuta is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "discount",
"type": "boolean",
"required": false,
"description": "If true, discount is enabled for the document.",
"format": "boolean",
"in": "query"
},
{
"name": "discountPercentage",
"type": "integer",
"required": false,
"description": "Overwrite percentage discount value. Possible values are 2, 3, 4, 5.",
"format": "integer",
"in": "query"
},
{
"name": "discountDays",
"type": "integer",
"required": false,
"description": "Overwrite discount in days. Possible values are 1, 5, 7, 10, 14, 21, 28, 30, 60, 90.",
"format": "integer",
"in": "query"
},
{
"name": "paymentDue",
"type": "boolean",
"required": false,
"description": "If true, payment due is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "paymentDueDays",
"type": "integer",
"required": false,
"description": "Overwrite payment due in days.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/pickup_delivery\/generate": {
"post": {
"summary": "Generate pick-up delivery note of an order",
"description": "Generate pick-up delivery note of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty' and 'repair'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/po_delivery_note\/generate": {
"post": {
"summary": "Generate purchase order (PO) delivery note of an order",
"description": "Generate PO delivery note of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'redistribution'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/pro_forma_invoice\/generate": {
"post": {
"summary": "Generate pro forma invoice of an order",
"description": "Generate pro forma invoice of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair', 'advance order' and 'delivery order'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
},
{
"name": "valuta",
"type": "boolean",
"required": false,
"description": "If true, valuta is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "discount",
"type": "boolean",
"required": false,
"description": "If true, discount is enabled for the document.",
"format": "boolean",
"in": "query"
},
{
"name": "discountPercentage",
"type": "integer",
"required": false,
"description": "Overwrite percentage discount value. Possible values are 2, 3, 4, 5.",
"format": "integer",
"in": "query"
},
{
"name": "discountDays",
"type": "integer",
"required": false,
"description": "Overwrite discount in days. Possible values are 1, 5, 7, 10, 14, 21, 28, 30, 60, 90.",
"format": "integer",
"in": "query"
},
{
"name": "paymentDue",
"type": "boolean",
"required": false,
"description": "If true, payment due is enabled.",
"format": "boolean",
"in": "query"
},
{
"name": "paymentDueDays",
"type": "integer",
"required": false,
"description": "Overwrite payment due in days.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/reorder\/generate": {
"post": {
"summary": "Generate reorder document of an order",
"description": "Generate reorder document of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'reorder'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "allowRegenerate",
"type": "boolean",
"required": false,
"description": "If true, existing reorder document is generated once again.",
"format": "boolean",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/repair_bill\/generate": {
"post": {
"summary": "Generate repair slip of an order",
"description": "Generate repair slip of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'repair'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/return_note\/generate": {
"post": {
"summary": "Generate return slip of an order",
"description": "Generate return slip of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair' and 'returns'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/reversal_document\/generate": {
"post": {
"summary": "Generate reversal document of an order",
"description": "Generate reversal document of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair' and 'advance order'. A valid invoice must exist.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/reversal_dunning_letter\/generate": {
"post": {
"summary": "Generate dunning letter reversal document of an order",
"description": "Generate dunning letter reversal document of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'repair' and 'warranty'. A valid dunning letter document must exist.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/reversal_refund\/generate": {
"post": {
"summary": "Generate refund reversal document of an order",
"description": "Generate refund reversal document of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'credit note'. A valid credit note document must exist.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/success_confirmation\/generate": {
"post": {
"summary": "Generate success confirmation of an order",
"description": "Generate success confirmation of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'order', 'warranty', 'repair', 'advance order' and 'offer'.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentDate",
"type": "string",
"required": false,
"description": "If not set, the current date will be used. The date has to be entered in W3C format, e.g. '2019-05-29T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "comment",
"type": "string",
"required": false,
"description": "Comment that appears below the stock units.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/{documentId}": {
"delete": {
"summary": "Delete document of an order",
"description": "Deletes document of an order. The ID of the order and the ID of the document must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "documentId",
"type": "integer",
"required": true,
"description": "The ID of the document",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/{type}": {
"post": {
"summary": "Upload order documents",
"description": "Uploads order documents. The ID of the order and the document type must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Document"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "The document type. Supported types are 'invoiceExternal', 'deliveryNote', 'poDeliveryNote', 'orderConfirmation', 'offer', 'dunningLetter', 'reversalDunningLetter', 'returnNote', 'successConfirmation', 'correction', 'creditNoteExternal', 'reorder', 'uploaded'.",
"format": "string",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/documents\/{type}",
"schema": {
"type": "object",
"required": [
"documents",
"content",
"numberWithPrefix"
],
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DocumentData"
}
},
"content": {
"type": "string",
"description": "The base64 encoded file data."
},
"number": {
"type": "integer",
"description": "The document number optional"
},
"numberWithPrefix": {
"type": "string",
"description": "The document number with prefix"
},
"directoryId": {
"type": "integer",
"description": "The ID of the directory optional"
},
"displayDate": {
"type": "string",
"description": "The date displayed on the document optional"
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/{type}\/current": {
"get": {
"summary": "Get current invoice or credit note of an order",
"description": "Get current invoice or credit note of an order. The ID of the order must be specified. The last valid document for which no reversal document exists is found.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Document"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "The type of the order document. The available types are invoice, creditNote, dunningLetter",
"format": "string",
"in": "path"
},
{
"name": "withContent",
"type": "boolean",
"required": false,
"description": "Load also the document content as base64 encoded string.",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/{type}\/generate": {
"post": {
"summary": "Generate document of an order",
"description": "Generate document of an order. The ID of the order and the type of the document must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "type",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/documents\/{type}\/recent": {
"get": {
"summary": "Get most recent document of an order",
"description": "Get most recent document of an order. The ID of the order must be specified.",
"tags": [
"Document"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Document"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "The type of the order document. The available types are receipt, invoiceExternal, invoice, deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer, dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reversal, reversalRefund, .",
"format": "string",
"in": "path"
},
{
"name": "withContent",
"type": "boolean",
"required": false,
"description": "Load also the document content as base64 encoded string.",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/items": {
"get": {
"summary": "Search order items",
"description": "Searches order items. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of OrderItem",
"items": {
"$ref": "#\/definitions\/OrderItem"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of order items to be displayed per page. The default number of order items per page is 50. The maximum number is 250.",
"format": "integer",
"in": "query"
},
{
"name": "sortBy",
"type": "string",
"required": false,
"description": "Sort search result according to itemVariationId, orderItemName, createdAt, updatedAt or id. The default value is orderItemId.",
"format": "string",
"in": "query"
},
{
"name": "sortOrder",
"type": "string",
"required": false,
"description": "Sort direction desc or asc. The default value is asc.",
"format": "string",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order item. Currently possible are:\n \n - 'variation' = The variation that is associated with the order item.<\/li>\n
- 'giftCardCodes' = The gift card codes that are associated with the order item.<\/li>\n
- 'transactions' = The transactions that are associated with the order item.<\/li>\n
- 'serialNumbers' = The serial numbers that are associated with the order item.<\/li>\n
- 'variationBarcodes' = The barcodes that are associated with variation of the order item.<\/li>\n <\/ul>",
"format": "integer",
"in": "query"
},
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/items\/serialNumbers": {
"get": {
"summary": "List serial numbers of an order",
"description": "Lists all serial numbers of an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderSerialNumber"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/items\/{orderItemId}": {
"delete": {
"summary": "Delete an order item",
"description": "Deletes an order item. The ID of the order and the ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order that the item belongs to.",
"format": "integer",
"in": "path"
},
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item to be deleted.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/items\/{orderItemId}\/serialNumbers": {
"get": {
"summary": "List serial numbers of an order item",
"description": "Lists all serial numbers of an order item. The ID of the order and the ID of the order item must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderSerialNumber"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "orderItemId",
"type": "integer",
"required": true,
"description": "The ID of the order item",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/outgoing_stocks": {
"delete": {
"summary": "Revert outgoing stock",
"description": "Reverts the booking of order items of an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Book out order items",
"description": "Books out the order items of an order. The ID of the order must be specified and a booking date can be specified. The current date and time will be used if no date is specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "date",
"type": "string",
"required": false,
"description": "The date that is saved as booking date for the outgoing stock.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/packagenumbers": {
"get": {
"summary": "List package numbers of an order",
"description": "Lists the package numbers of an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/string"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/properties": {
"post": {
"summary": "Create property for an order",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nCreates a property and links it to an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/properties",
"schema": {
"type": "object",
"required": [
"orderId",
"typeId",
"value"
],
"properties": {
"orderId": {
"type": "integer",
"description": "The ID of the order that the property belongs to"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following types are available:\n\n WAREHOUSE\t\t=\t1\n SHIPPING_PROFILE\t=\t2\n PAYMENT_METHOD\t\t\t=\t3\n PAYMENT_STATUS\t\t\t=\t4\n EXTERNAL_SHIPPING_PROFILE\t\t\t=\t5\n DOCUMENT_LANGUAGE\t\t\t=\t6\n EXTERNAL_ORDER_ID\t\t\t=\t7\n CUSTOMER_SIGN\t\t\t=\t8\n DUNNING_LEVEL\t\t\t=\t9\n SELLER_ACCOUNT\t\t\t=\t10\n WEIGHT\t\t\t=\t11\n WIDTH\t\t\t=\t12\n LENGTH =\t13\n HEIGHT\t\t=\t14\n FLAG\t\t\t=\t15\n EXTERNAL_TOKEN_ID\t\t\t=\t16\n EXTERNAL_ITEM_ID\t\t\t=\t17\n COUPON_CODE\t\t\t=\t18\n COUPON_TYPE = 19\n SALES_TAX_ID_NUMBER = 34\n MAIN_DOCUMENT_NUMBER = 33\n PAYMENT_TRANSACTION_ID = 45\n EXTERNAL_TAX_SERVICE = 47\n MERCHANT_ID = 60\n REPORT_ID = 61\n PREFERRED_STORAGE_LOCATION_ID = 63\n AMAZON_SHIPPING_LABEL = 64\n EBAY_PLUS = 994\n FULFILLMENT_SERVICE = 995"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on the type."
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/properties\/{typeId}": {
"delete": {
"summary": "Delete property of an order by order ID and property type ID",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nDeletes a property of an order. The ID of the order and the ID of the order property type must be specified. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 4 = PAYMENT_STATUS<\/li>\n
- 5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n
- 6 = DOCUMENT_LANGUAGE<\/li>\n
- 7 = EXTERNAL_ORDER_ID<\/li>\n
- 8 = CUSTOMER_SIGN<\/li>\n
- 9 = DUNNING_LEVEL<\/li>\n
- 10 = SELLER_ACCOUNT<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 15 = FLAG<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 45 = PAYMENT_TRANSACTION_ID<\/li>\n
- 47 = EXTERNAL_TAX_SERVICE<\/li>\n
- 60 = MERCHANT_ID<\/li>\n
- 61 = REPORT_ID<\/li>\n
- 63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n
- 64 = AMAZON_SHIPPING_LABEL<\/li>\n
- 994 = EBAY_PLUS<\/li>\n
- 995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/properties\/{typeId}",
"schema": {
"type": "object",
"required": [
"orderId",
"typeId"
],
"properties": {
"orderId": {
"type": "integer",
"description": "The ID of the order that the property belongs to"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following types are available:\n\n WAREHOUSE\t\t=\t1\n SHIPPING_PROFILE\t=\t2\n PAYMENT_METHOD\t\t\t=\t3\n PAYMENT_STATUS\t\t\t=\t4\n EXTERNAL_SHIPPING_PROFILE\t\t\t=\t5\n DOCUMENT_LANGUAGE\t\t\t=\t6\n EXTERNAL_ORDER_ID\t\t\t=\t7\n CUSTOMER_SIGN\t\t\t=\t8\n DUNNING_LEVEL\t\t\t=\t9\n SELLER_ACCOUNT\t\t\t=\t10\n WEIGHT\t\t\t=\t11\n WIDTH\t\t\t=\t12\n LENGTH =\t13\n HEIGHT\t\t=\t14\n FLAG\t\t\t=\t15\n EXTERNAL_TOKEN_ID\t\t\t=\t16\n EXTERNAL_ITEM_ID\t\t\t=\t17\n COUPON_CODE\t\t\t=\t18\n COUPON_TYPE = 19\n SALES_TAX_ID_NUMBER = 34\n MAIN_DOCUMENT_NUMBER = 33\n PAYMENT_TRANSACTION_ID = 45\n EXTERNAL_TAX_SERVICE = 47\n MERCHANT_ID = 60\n REPORT_ID = 61\n PREFERRED_STORAGE_LOCATION_ID = 63\n AMAZON_SHIPPING_LABEL = 64\n EBAY_PLUS = 994\n FULFILLMENT_SERVICE = 995"
}
}
}
}
]
},
"put": {
"summary": "Update property of an order by order ID and property ID",
"description": "DEPRECATED: Use the following route: PUT \/rest\/orders\/{orderId}<\/b>\nUpdates the value of a property already linked to an order. The ID of the order and the ID of the order property type must be specified. The following property types are available by default:\n\n
\n- 1 = WAREHOUSE<\/li>\n
- 2 = SHIPPING_PROFILE<\/li>\n
- 3 = PAYMENT_METHOD<\/li>\n
- 4 = PAYMENT_STATUS<\/li>\n
- 5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n
- 6 = DOCUMENT_LANGUAGE<\/li>\n
- 7 = EXTERNAL_ORDER_ID<\/li>\n
- 8 = CUSTOMER_SIGN<\/li>\n
- 9 = DUNNING_LEVEL<\/li>\n
- 10 = SELLER_ACCOUNT<\/li>\n
- 11 = WEIGHT<\/li>\n
- 12 = WIDTH<\/li>\n
- 13 = LENGTH<\/li>\n
- 14 = HEIGHT<\/li>\n
- 15 = FLAG<\/li>\n
- 16 = EXTERNAL_TOKEN_ID<\/li>\n
- 17 = EXTERNAL_ITEM_ID<\/li>\n
- 18 = COUPON_CODE<\/li>\n
- 19 = COUPON_TYPE<\/li>\n
- 33 = MAIN_DOCUMENT_NUMBER<\/li>\n
- 34 = SALES_TAX_ID_NUMBER<\/li>\n
- 45 = PAYMENT_TRANSACTION_ID<\/li>\n
- 47 = EXTERNAL_TAX_SERVICE<\/li>\n
- 60 = MERCHANT_ID<\/li>\n
- 61 = REPORT_ID<\/li>\n
- 63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n
- 64 = AMAZON_SHIPPING_LABEL<\/li>\n
- 994 = EBAY_PLUS<\/li>\n
- 995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/properties\/{typeId}",
"schema": {
"type": "object",
"required": [
"orderId",
"typeId",
"value"
],
"properties": {
"orderId": {
"type": "integer",
"description": "The ID of the order that the property belongs to"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following types are available:\n\n WAREHOUSE\t\t=\t1\n SHIPPING_PROFILE\t=\t2\n PAYMENT_METHOD\t\t\t=\t3\n PAYMENT_STATUS\t\t\t=\t4\n EXTERNAL_SHIPPING_PROFILE\t\t\t=\t5\n DOCUMENT_LANGUAGE\t\t\t=\t6\n EXTERNAL_ORDER_ID\t\t\t=\t7\n CUSTOMER_SIGN\t\t\t=\t8\n DUNNING_LEVEL\t\t\t=\t9\n SELLER_ACCOUNT\t\t\t=\t10\n WEIGHT\t\t\t=\t11\n WIDTH\t\t\t=\t12\n LENGTH =\t13\n HEIGHT\t\t=\t14\n FLAG\t\t\t=\t15\n EXTERNAL_TOKEN_ID\t\t\t=\t16\n EXTERNAL_ITEM_ID\t\t\t=\t17\n COUPON_CODE\t\t\t=\t18\n COUPON_TYPE = 19\n SALES_TAX_ID_NUMBER = 34\n MAIN_DOCUMENT_NUMBER = 33\n PAYMENT_TRANSACTION_ID = 45\n EXTERNAL_TAX_SERVICE = 47\n MERCHANT_ID = 60\n REPORT_ID = 61\n PREFERRED_STORAGE_LOCATION_ID = 63\n AMAZON_SHIPPING_LABEL = 64\n EBAY_PLUS = 994\n FULFILLMENT_SERVICE = 995"
},
"value": {
"type": "string",
"description": "The value of the property. The value depends on the type."
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/cancel_shipment": {
"delete": {
"summary": "Cancel a shipment",
"description": "Cancel a shipment for an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/packages": {
"delete": {
"summary": "Delete all order shipping packages for an order",
"description": "Deletes all order shipping packages for an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List order shipping packages",
"description": "Lists order shipping packages. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderShippingPackage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "string",
"required": false,
"description": "Possible value is 'labelBase64'",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create an order shipping package",
"description": "Creates an order shipping package. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/shipping\/packages",
"schema": {
"type": "object",
"required": [
"packageId",
"packageType"
],
"properties": {
"packageId": {
"type": "integer",
"description": "The ID of the package"
},
"weight": {
"type": "integer",
"description": "The weight of the package in grams optional"
},
"packageNumber": {
"type": "string",
"description": "The package number optional"
},
"packageType": {
"type": "integer",
"description": "The type of the package. The following types are valid:\n\n0: unpacked\n1: Bale\n2: Dispenser\n3: Coil\n4: Roll pallet\n5: Colli\n6: Container\n7: Bucket\n8: Cask\n9: Bottles\n10: European flat pallet\n11: Structural frame\n12: Gas cylinder\n13: Pallet cage\n14: Hobbock\n15: Half pallet\n16: Pallet of food items\n17: Wooden coaster\n18: IBC container\n19: Pitcher\n20: Wicker bottle\n21: Case\n22: Canister\n23: Customer pallet\n24: Cardboard box\n25: Composite packaging\n26: Package\n27: Ring\n28: Role\n29: Sack\n30: units\n31: Tank\n32: Drum\n34: Crate\n35: Quarter pallet\n36: Other pallets\n37: Bin\n38: One-way pallet\n39: Foil bag"
},
"volume": {
"type": "number",
"description": "The volume of the package optional"
},
"labelPath": {
"type": "string",
"description": "The path to the label optional"
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/packages\/items": {
"get": {
"summary": "List items contained in packages of an order",
"description": "Lists items contained in packages of a specific order. The ID of the order is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackageItems"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/packages\/packed_items": {
"get": {
"summary": "List packed items of a shipping package by the order ID",
"description": "Lists packed items of a shipping package by a specific order ID. The ID of the order is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/packages\/unpacked_items": {
"get": {
"summary": "List unpacked items of a shipping package by the order ID",
"description": "Lists unpacked items of a shipping package by a specific order ID. The ID of the order is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/packages\/{orderShippingPackageId}": {
"delete": {
"summary": "Delete an order shipping package",
"description": "Deletes an order shipping package. The ID of the order and the ID of the order shipping package must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "orderShippingPackageId",
"type": "integer",
"required": true,
"description": "The ID of the order shipping package",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an order shipping package",
"description": "Gets an order shipping package. The ID of the order and the ID of the order shipping package must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "orderShippingPackageId",
"type": "integer",
"required": true,
"description": "The ID of the order shipping package",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
}
]
},
"put": {
"summary": "Update an order shipping package",
"description": "Updates an order shipping package. The ID of the order and the ID of the order shipping package must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "orderShippingPackageId",
"type": "integer",
"required": true,
"description": "The ID of the order shipping package",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/shipping\/packages\/{orderShippingPackageId}",
"schema": {
"type": "object",
"properties": {
"packageId": {
"type": "integer",
"description": "The ID of the package optional"
},
"weight": {
"type": "integer",
"description": "The weight of the package in grams optional"
},
"packageNumber": {
"type": "string",
"description": "The package number optional"
},
"packageType": {
"type": "integer",
"description": "The type of the package. The following types are valid:\n\n0: unpacked\n1: Bale\n2: Dispenser\n3: Coil\n4: Roll pallet\n5: Colli\n6: Container\n7: Bucket\n8: Cask\n9: Bottles\n10: European flat pallet\n11: Structural frame\n12: Gas cylinder\n13: Pallet cage\n14: Hobbock\n15: Half pallet\n16: Pallet of food items\n17: Wooden coaster\n18: IBC container\n19: Pitcher\n20: Wicker bottle\n21: Case\n22: Canister\n23: Customer pallet\n24: Cardboard box\n25: Composite packaging\n26: Package\n27: Ring\n28: Role\n29: Sack\n30: units\n31: Tank\n32: Drum\n34: Crate\n35: Quarter pallet\n36: Other pallets\n37: Bin\n38: One-way pallet\n39: Foil bag\n optional"
},
"volume": {
"type": "number",
"description": "The volume of the package optional"
}
}
}
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/pallets\/packages\/items": {
"get": {
"summary": "List items contained in package pallets of an order",
"description": "Lists items contained in package pallets of an order. The ID of the order is mandatory.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderShippingPackageItems"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/pallets\/{palletId}\/packages": {
"delete": {
"summary": "Delete all order shipping packages in a pallet",
"description": "Deletes all order shipping packages in a pallet. The ID of the order and the ID of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "List all packages contained in pallets of an order",
"description": "Lists all packages contained in pallets of an order. The ID of the order and of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderShippingPackage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update all packages in a pallet",
"description": "Updates all the packages in a pallet. The ID of the order and the ID of the pallet must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"name": "palletId",
"type": "integer",
"required": true,
"description": "The ID of the pallet",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/register_shipment": {
"post": {
"summary": "Register a shipment",
"description": "Register a shipment for an order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/returns": {
"get": {
"summary": "",
"description": "",
"tags": [
"Returns"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of OrderReturns",
"items": {
"$ref": "#\/definitions\/OrderReturns"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The id of the order to search the orders returns",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page to get. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of orders to be displayed per page. The default number of orders per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for an order. Currently possible are:\n\t
\n\t- 'documents' = The document objects that are associated with the order returns.<\/li>\n\t
- 'labels' = The base64 encoded labels that are associated with the order returns.<\/li>\n\t<\/ul>\n\tExample:
?with[]=documents&with[]=labels<\/code>",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/returns\/assign_label\/{returnsId}": {
"put": {
"summary": "",
"description": "",
"tags": [
"Returns"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/OrderReturns"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "returnsId",
"type": "integer",
"required": true,
"description": "The id of the order returns to be assigned.",
"format": "integer",
"in": "path"
},
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The id of the order that the order returns has to be assigned to.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/shipping_information": {
"delete": {
"summary": "Delete shipping information",
"description": "Deletes the shipping information. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get shipping information",
"description": "Gets the shipping information. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/shipping_information\/additional_data": {
"put": {
"summary": "Update additional data of the shipping information",
"description": "Updates additional data of the shipping information. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/shipping\/shipping_information\/status": {
"put": {
"summary": "Update the shipping status of the shipping information",
"description": "Updates the shipping status of the shipping information. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ShippingInformation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/status-history": {
"get": {
"summary": "Get the status history of an order",
"description": "Gets the status history of an order. The status history is a list that contains information of status changes of the order. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/StatusHistoryEntry"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/orders\/{orderId}\/transactions": {
"post": {
"summary": "Create order item transactions for an order",
"description": "Creates transactions including the full quantity for every order item that does not have an existing transaction. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OrderItemTransaction"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/orders\/{orderId}\/transactions",
"schema": {
"type": "object",
"required": [
"direction",
"status"
],
"properties": {
"direction": {
"type": "string",
"description": "The direction. Possible values are 'in' and 'out'. allowed values are in, out"
},
"status": {
"type": "string",
"description": "The status. Possible values are 'regular' and 'cancelled'. allowed values are regular, cancelled"
}
}
}
}
]
}
},
"\/rest\/payment\/properties\/types\/names": {
"post": {
"summary": "Create a name of a property type",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentPropertyTypeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payment\/properties\/types\/names",
"schema": {
"type": "object",
"required": [
"typeId",
"lang",
"name"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the property type matching to \/^[0-9]+$\/"
},
"lang": {
"type": "string",
"description": "The language of the name of the property type matching to \/^[A-Z]{2}$\/"
},
"name": {
"type": "string",
"description": "The name of the property type matching to \/^[A-Za-z]{3,255}$\/"
}
}
}
}
]
},
"put": {
"summary": "Update a name of a property type",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentPropertyTypeName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payment\/properties\/types\/names",
"schema": {
"type": "object",
"required": [
"typeId",
"lang",
"name"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the property type matching to \/^[0-9]+$\/"
},
"lang": {
"type": "string",
"description": "The language of the name of the property type matching to \/^[A-Z]{2}$\/"
},
"name": {
"type": "string",
"description": "The name of the property type matching to \/^[A-Za-z]{3,255}$\/"
}
}
}
}
]
}
},
"\/rest\/payment\/properties\/types\/names\/{nameId}": {
"get": {
"summary": "Get a name of a property type",
"description": "Gets a name of a property type. The ID of the name must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentPropertyTypeName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "nameId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payment\/{paymentId}\/contact": {
"delete": {
"summary": "Delete Payment-Contact-Relation",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payment\/{paymentId}\/contact\/{contactId}": {
"post": {
"summary": "Create Payment-Contact-Relation",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentContactRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "contactId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payment\/{paymentId}\/order": {
"delete": {
"summary": "Delete Payment-Order-Relation",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payment\/{paymentId}\/order\/{orderId}": {
"post": {
"summary": "Create Payment-Order-Relation",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentOrderRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments": {
"get": {
"summary": "List payments",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a payment",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Payment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments",
"schema": {
"type": "object",
"required": [
"amount",
"exchangeRatio",
"mopId",
"currency",
"type",
"status",
"transactionType"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount of the payment matching to \/^[0-9]{1,9}[\\.][0-9]{4}+$\/"
},
"exchangeRatio": {
"type": "number",
"description": "The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. matching to \/^[0-9]{1,9}[\\.][0-9]{4}+$\/"
},
"mopId": {
"type": "integer",
"description": "The ID of the payment method matching to \/^[0-9]+$\/"
},
"parentId": {
"type": "integer",
"description": "The ID of the parent payment optional matching to \/^[0-9]+$\/"
},
"deleted": {
"type": "integer",
"description": "A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. optional matching to \/^[0-1]$\/"
},
"unaccountable": {
"type": "integer",
"description": "An unassigned payment. Unassigned payments have the value 1. optional matching to \/^[0-1]$\/"
},
"currency": {
"type": "string",
"description": "The currency of the payment in ISO 4217 code. matching to \/^[A-Z]{3}$\/"
},
"type": {
"type": "string",
"description": "The payment type. Available types are credit and debit. allowed values are debit, credit"
},
"status": {
"type": "integer",
"description": "The status of the payment matching to \/^[1-9][0]?$\/"
},
"transactionType": {
"type": "integer",
"description": "The transaction type of the payment. The following transaction types are available:\n\n Interim transaction report = 1\n Booked payment = 2\n Split payment = 3\n matching to \/^[1-3]$\/"
},
"regenerateHash": {
"type": "boolean",
"description": "If $regenerateHash is true, regenerate the payment hash value. Default is false. optional"
}
}
}
}
]
},
"put": {
"summary": "Update a payment",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Payment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments",
"schema": {
"type": "object",
"required": [
"amount",
"exchangeRatio",
"mopId",
"currency",
"type",
"status",
"transactionType"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount of the payment matching to \/^[0-9]{1,9}[\\.][0-9]{4}+$\/"
},
"exchangeRatio": {
"type": "number",
"description": "The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. matching to \/^[0-9]{1,9}[\\.][0-9]{4}+$\/"
},
"mopId": {
"type": "integer",
"description": "The ID of the payment method matching to \/^[0-9]+$\/"
},
"parentId": {
"type": "integer",
"description": "The ID of the parent payment optional matching to \/^[0-9]+$\/"
},
"deleted": {
"type": "integer",
"description": "A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. optional matching to \/^[0-1]$\/"
},
"unaccountable": {
"type": "integer",
"description": "An unassigned payment. Unassigned payments have the value 1. optional matching to \/^[0-1]$\/"
},
"currency": {
"type": "string",
"description": "The currency of the payment in ISO 4217 code. matching to \/^[A-Z]{3}$\/"
},
"type": {
"type": "string",
"description": "The payment type. Available types are credit and debit. allowed values are debit, credit"
},
"status": {
"type": "integer",
"description": "The status of the payment matching to \/^[1-9][0]?$\/"
},
"transactionType": {
"type": "integer",
"description": "The transaction type of the payment. The following transaction types are available:\n\n Interim transaction report = 1\n Booked payment = 2\n Split payment = 3\n matching to \/^[1-3]$\/"
},
"regenerateHash": {
"type": "boolean",
"description": "If $regenerateHash is true, regenerate the payment hash value. Default is false. optional"
},
"updateOrderPaymentStatus": {
"type": "boolean",
"description": "If $updateOrderPaymentStatus is true, update the order payment status. Default is false. optional"
}
}
}
}
]
}
},
"\/rest\/payments\/entrydate": {
"get": {
"summary": "List payments by entry date",
"description": "Lists all payments by entry date within a certain date range. The start and the end of the date range must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "startDate",
"type": "string",
"required": false,
"description": "The start date of the date range for the entry date of the payment",
"format": "string",
"in": "query"
},
{
"name": "endDate",
"type": "string",
"required": false,
"description": "The end date of the date range for the entry date of the payment",
"format": "string",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/payments\/importdate": {
"get": {
"summary": "List payments by import date",
"description": "Lists all payments by import date within a certain date range. The start and the end of the date range must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "startDate",
"type": "string",
"required": false,
"description": "The start date of the date range for the import date of the payment",
"format": "string",
"in": "query"
},
{
"name": "endDate",
"type": "string",
"required": false,
"description": "The end date of the date range for the import date of the payment",
"format": "string",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/payments\/methodNames": {
"get": {
"summary": "List payment methods names",
"description": "Lists all payment method names.",
"tags": [
"Payment"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentMethodName"
}
}
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/payments\/methodNames\/{paymentMethodId}": {
"get": {
"summary": "List all payment method names for a payment method id",
"description": "List all payment method names for a payment method id. The payment method id must be specified.",
"tags": [
"Payment"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentMethodName"
}
}
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "paymentMethodId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/methodNames\/{paymentMethodId}\/{lang}": {
"get": {
"summary": "Gets a payment method name by id and lang",
"description": "Gets a payment method name by id and lang. The ID and the requested lang of the payment method must be specified.",
"tags": [
"Payment"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentMethodName"
}
}
},
"parameters": [
{
"name": "paymentMethodId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "lang",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/methods": {
"get": {
"summary": "List payment methods",
"description": "Lists all payment method plugins.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentMethod"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a payment method",
"description": "Creates a payment method. The plugin key, the payment key and the name of the payment method must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentMethod"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/methods",
"schema": {
"type": "object",
"required": [
"name",
"pluginKey",
"paymentKey"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the payment method matching to \/^[A-Za-z]+[A-Za-z0-9]+$\/"
},
"pluginKey": {
"type": "string",
"description": "The plugin key of the payment method matching to \/^[A-Za-z]+[A-Za-z0-9]+$\/ value must be unique"
},
"paymentKey": {
"type": "string",
"description": "The payment key of the payment method matching to \/^[A-Za-z]+[A-Za-z0-9]+$\/ value must be unique"
}
}
}
}
]
},
"put": {
"summary": "Update a payment method",
"description": "Updates the name of the payment method. The name of the payment method must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentMethod"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/methods",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the payment method matching to \/^[A-Za-z]+[A-Za-z0-9]+$\/"
}
}
}
}
]
}
},
"\/rest\/payments\/methods\/ebics": {
"get": {
"summary": "Get EBICS Accounts",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create an EBICS Account",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of the EBICS Account",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/payments\/methods\/hbci": {
"get": {
"summary": "Returns the HBCI-Account count",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/payments\/methods\/list": {
"get": {
"summary": "Returns all payment methods with id and name",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/payments\/methods\/list\/backend_active\/{language}": {
"get": {
"summary": "Returns all payment methods with id and name which are active for the backend",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "language",
"type": "string",
"required": true,
"description": "",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/payments\/methods\/list\/backend_icon": {
"get": {
"summary": "Returns all payment methods with id and backend icon url",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/payments\/methods\/list\/backend_searchable\/{language}": {
"get": {
"summary": "Returns all payment methods with id and name which are searchable for the backend",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "language",
"type": "string",
"required": true,
"description": "",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/payments\/methods\/list\/handle_subscription\/{language}": {
"get": {
"summary": "",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "language",
"type": "string",
"required": true,
"description": "",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/payments\/methods\/plugins\/{pluginKey}": {
"get": {
"summary": "Get a payment method",
"description": "Gets a payment method plugin. The plugin key must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentMethod"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "pluginKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/methods\/{methodId}": {
"get": {
"summary": "List payments of a payment method",
"description": "Lists all payments of the a payment method. The ID of the payment method must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "methodId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/orders\/{orderId}": {
"get": {
"summary": "List payments of an order",
"description": "Lists all payments of an order. The ID of the order must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/properties": {
"get": {
"summary": "List properties",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentProperty"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a payment property",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/properties",
"schema": {
"type": "object",
"required": [
"paymentId",
"typeId"
],
"properties": {
"paymentId": {
"type": "integer",
"description": "The ID of the payment matching to \/^[0-9]+$\/"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following property types are available:\n\n Transaction ID = 1\n Reference ID = 2\n Booking text = 3\n Transaction password = 4\n Transaction code = 5\n Authorisation ID = 6\n Capture ID = 7\n Refund ID = 8\n Credit note ID = 9\n Order reference = 10\n Name of the sender = 11\n Email of the sender = 12\n The sender's sort code = 13\n The sender's bank name = 14\n The sender's bank account number = 15\n The holder of the bank account = 16\n The country of the sender's bank account = 17\n The sender's IBAN = 18\n The sender's BIC = 19\n Name of the recipient = 20\n The recipient's bank account = 21\n Reference text of the payment = 22\n Payment origin = 23\n Shipping address ID = 24\n Invoice address ID = 25\n Item buyer = 26\n Item number = 27\n Item transaction ID = 28\n External transaction type = 29\n External transaction status = 30\n The receiver's IBAN = 31\n The receiver's BIC = 32\n Transaction fee = 33\n Transaction lifespan = 34\n matching to \/^[0-9]+$\/"
},
"value": {
"type": "string",
"description": "The value of the property type optional matching to \/.{0,255}\/"
}
}
}
}
]
},
"put": {
"summary": "Update a payment property",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/properties",
"schema": {
"type": "object",
"required": [
"paymentId",
"typeId"
],
"properties": {
"paymentId": {
"type": "integer",
"description": "The ID of the payment matching to \/^[0-9]+$\/"
},
"typeId": {
"type": "integer",
"description": "The ID of the property type. The following property types are available:\n\n Transaction ID = 1\n Reference ID = 2\n Booking text = 3\n Transaction password = 4\n Transaction code = 5\n Authorisation ID = 6\n Capture ID = 7\n Refund ID = 8\n Credit note ID = 9\n Order reference = 10\n Name of the sender = 11\n Email of the sender = 12\n The sender's sort code = 13\n The sender's bank name = 14\n The sender's bank account number = 15\n The holder of the bank account = 16\n The country of the sender's bank account = 17\n The sender's IBAN = 18\n The sender's BIC = 19\n Name of the recipient = 20\n The recipient's bank account = 21\n Reference text of the payment = 22\n Payment origin = 23\n Shipping address ID = 24\n Invoice address ID = 25\n Item buyer = 26\n Item number = 27\n Item transaction ID = 28\n External transaction type = 29\n External transaction status = 30\n The receiver's IBAN = 31\n The receiver's BIC = 32\n Transaction fee = 33\n Transaction lifespan = 34\n matching to \/^[0-9]+$\/"
},
"value": {
"type": "string",
"description": "The value of the property type optional matching to \/.{0,255}\/"
}
}
}
}
]
}
},
"\/rest\/payments\/properties\/date": {
"get": {
"summary": "List properties by creation date",
"description": "Lists all properties by creation date. The start and the end of the date range must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentProperty"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "startDate",
"type": "string",
"required": false,
"description": "The start date of the date range for the date of creation of the property",
"format": "string",
"in": "query"
},
{
"name": "endDate",
"type": "string",
"required": false,
"description": "The end date of the date range for the date of creation of the property",
"format": "string",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/payments\/properties\/types": {
"get": {
"summary": "List property types",
"description": "Lists all property types. The language must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentPropertyType"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a property type",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentPropertyType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/properties\/types",
"schema": {
"type": "object",
"required": [
"erasable"
],
"properties": {
"erasable": {
"type": "integer",
"description": "Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted. matching to \/^[1-9]+$\/"
},
"position": {
"type": "integer",
"description": "The position number of the property type optional matching to \/^[0-9]+$\/"
}
}
}
}
]
},
"put": {
"summary": "Update a property type",
"description": "",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentPropertyType"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/payments\/properties\/types",
"schema": {
"type": "object",
"required": [
"erasable"
],
"properties": {
"erasable": {
"type": "integer",
"description": "Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted. matching to \/^[1-9]+$\/"
},
"position": {
"type": "integer",
"description": "The position number of the property type optional matching to \/^[0-9]+$\/"
}
}
}
}
]
}
},
"\/rest\/payments\/properties\/types\/{typeId}": {
"get": {
"summary": "Get a property type",
"description": "Gets a property type. The ID of the type must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentPropertyType"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "typeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/properties\/{propertyId}": {
"get": {
"summary": "Get a property",
"description": "Gets a property. The ID of the property must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PaymentProperty"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/property\/{propertyTypeId}\/{propertyValue}": {
"get": {
"summary": "List payments by property type ID and value",
"description": "Lists all payments by the given property type ID and the value.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "propertyTypeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "propertyValue",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/status\/{statusId}": {
"get": {
"summary": "List payments of a payment status",
"description": "Lists all payments of a payment status. The ID of the payment status<\/a> must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "statusId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/transactions\/{transactionTypeId}": {
"get": {
"summary": "List payments of a transaction type",
"description": "Lists all payments of a transaction type. The ID of the transaction type must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Payment"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "transactionTypeId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/{paymentId}": {
"get": {
"summary": "Get a payment",
"description": "Gets a payment. The ID of the payment must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Payment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/payments\/{paymentId}\/properties": {
"get": {
"summary": "List properties for a payment",
"description": "Lists all properties for a payment. The ID of the payment must be specified.",
"tags": [
"Payment"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentProperty"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "paymentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/pim\/attributes": {
"delete": {
"summary": "Delete attributes",
"description": "Deletes attributes.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "Search attributes",
"description": "Searches attributes.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Attribute",
"items": {
"$ref": "#\/definitions\/Attribute"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:- 'attributeNames' = The attribute names of the attribute.<\/li>
- 'values' = The attribute values of the attribute.<\/li>
- 'maps' = The attribute maps of the attribute.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "ids",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified IDs. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "backendName",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified backend name. Allowed comparators: 'eq' and 'in'.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified name. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": false,
"description": "Filter restricts the result to attributes with the specified position. Allowed comparator: 'eq', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "integer",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes which have been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead. Allowed comparator: 'eq'', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create attributes",
"description": "Creates attributes.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Update attributes",
"description": "Updates attributes.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/pim\/attributes\/names": {
"delete": {
"summary": "Delete attribute names",
"description": "Deletes attribute names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "Search attribute names",
"description": "Searches attribute names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of AttributeName",
"items": {
"$ref": "#\/definitions\/AttributeName"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'attribute' = The attribute to the attribute name.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "attributeId",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified attribute ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified language. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'in'.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to attributes with the specified name. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create attribute names",
"description": "Creates attribute names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Update attribute names",
"description": "Updates attribute names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/pim\/attributes\/values": {
"delete": {
"summary": "Delete attribute values",
"description": "Deletes attribute values.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "Search attribute values",
"description": "Searches attribute values.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of AttributeValue",
"items": {
"$ref": "#\/definitions\/AttributeValue"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'valueNames' = The names of the attribute value.<\/li>
- 'attribute' = The attribute of the attribute value.<\/li>
- 'valueMaps' = The maps of the attribute value.<\/li>
- 'valueMarketNames' = The value market names of the attribute value.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "ids",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values with the specified IDs. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "attributeId",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values with the specified attribute ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "backendName",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values with the specified backend name. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'in'.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values with the specified name. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values with the specified IDs. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute values which have been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead. Allowed comparator: 'eq'', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create attribute values",
"description": "Creates attribute values.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Update attribute values",
"description": "Updates attribute values.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/pim\/attributes\/values\/names": {
"delete": {
"summary": "Delete attribute value names",
"description": "Deletes attribute value names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "Search attribute value names",
"description": "Searches attribute value names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of AttributeValueName",
"items": {
"$ref": "#\/definitions\/AttributeValueName"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'attributeValue' = The attribute value to the attribute value name.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "valueId",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute value names with the specified value ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute value names with the specified language. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'in'.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to attribute value names with the specified name. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create attribute value names",
"description": "Creates attribute value names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Update attribute value names",
"description": "Updates attribute value names.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/pim\/attributes\/values\/{id}": {
"get": {
"summary": "Get one attribute value",
"description": "Gets one attribute value. The ID must be specified.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AttributeValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/pim\/attributes\/{id}": {
"get": {
"summary": "Get one attribute",
"description": "Gets one attribute. The ID must be specified.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Attribute"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/pim\/categories": {
"get": {
"summary": "Search categories",
"description": "Searches categories.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Category",
"items": {
"$ref": "#\/definitions\/Category"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'details' = The names of the category.<\/li>
- 'clients' = The clients of the category.<\/li>
- 'branch' = The branch of the category.<\/li>
- 'tagRelationship' = The tags linked with the category and their data.<\/li>
- 'elmarCategories' = The elmar categories of the category.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "ids",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories with the specified IDs. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories with the specified type. Allowed comparators: 'eq', 'in' and 'not'.",
"format": "string",
"in": "query"
},
{
"name": "level",
"type": "integer",
"required": false,
"description": "Filter restricts the result to categories with the specified level. Allowed comparators: 'eq', 'not', 'gte', 'lte', 'gt' and 'lt'.",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories with a category detail in the specified name. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories with a category detail in the specified lang. Allowed comparators: 'eq' and 'not'.",
"format": "string",
"in": "query"
},
{
"name": "parentId",
"type": "integer",
"required": false,
"description": "Filter restricts the result to categories with the specified parent ID. Allowed comparator: 'eq'.",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter restricts the result to categories with the specified plenty ID. Allowed comparator: 'eq'.",
"format": "integer",
"in": "query"
},
{
"name": "linklist",
"type": "boolean",
"required": false,
"description": "Filter restricts the result to categories with the specified linklist value. Allowed comparator: 'eq'.",
"format": "boolean",
"in": "query"
},
{
"name": "tagId",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories with the specified tag id. Allowed comparator: 'eq', 'in' and 'not'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the result to categories which have been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead. Allowed comparator: 'eq'', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/pim\/categories\/branches": {
"get": {
"summary": "Search category branches",
"description": "Searches category branches.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of CategoryBranch",
"items": {
"$ref": "#\/definitions\/CategoryBranch"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'category' = The category of the category branch.<\/li><\/ub>",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/pim\/categories\/clients": {
"get": {
"summary": "Search category clients",
"description": "Searches category clients.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of CategoryClient",
"items": {
"$ref": "#\/definitions\/CategoryClient"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'category' = The category of the category client.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "categoryId",
"type": "string",
"required": false,
"description": "Filter restricts the result to category clients with the specified category ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter restricts the result to category clients with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/pim\/categories\/details": {
"get": {
"summary": "Search category details",
"description": "Searches category details.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of CategoryDetails",
"items": {
"$ref": "#\/definitions\/CategoryDetails"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'category' = The category of the category detail.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "categoryId",
"type": "string",
"required": false,
"description": "Filter restricts the result to category details with the specified category ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter restricts the result to category details with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "integer",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": false,
"description": "Filter restricts the result to category details with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in' and 'not'.",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Filter restricts the result to category details with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'like'.",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "string",
"required": false,
"description": "Filter restricts the result to category details with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/pim\/categories\/properties": {
"get": {
"summary": "Search category properties",
"description": "Searches category properties.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of CategoryProperty",
"items": {
"$ref": "#\/definitions\/CategoryProperty"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'category' = The category of the property.<\/li><\/ub>",
"format": "string",
"in": "query"
},
{
"name": "categoryId",
"type": "string",
"required": false,
"description": "Filter restricts the result to category properties with the specified category ID. More than one parameter should be separated by commas. Allowed comparators: 'eq', 'in', 'between', 'gte', 'lte', 'gt' and 'lt'.",
"format": "string",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter restricts the result to category properties with the specified plenty ID. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "integer",
"in": "query"
},
{
"name": "value",
"type": "string",
"required": false,
"description": "Filter restricts the result to category properties with the specified value. More than one parameter should be separated by commas. Allowed comparators: 'eq'.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/pim\/categories\/{id}": {
"get": {
"summary": "Get one category",
"description": "Gets one category. The ID must be specified.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Category"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/pim\/variations": {
"get": {
"summary": "Lists variations",
"description": "Lists variations with the specified data.",
"tags": [
"Pim"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Variation",
"items": {
"$ref": "#\/definitions\/Variation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified information in the results. More than one parameter should be separated by commas. The following parameters are available:
- 'additionalSkus' = The additional skus of the variation.<\/li>
- 'attributeValues' = The attribute values of the variation.<\/li>
- 'attributeValues.attribute'\/b> = Includes attributeValues. The attribute data to the related attribute ID.<\/li>
- 'attributeValues.attributeValue' = Includes attributeValues. The attribute value data to the related attribute value ID.<\/li>
- 'barcodes' = The barcodes of the variation.<\/li>
- 'barcodes.barcode' = Includes barcodes. The barcode data to the related barcode ID.<\/li>
- 'base' = The variation base.<\/li>
- 'base.item' = Includes base. The item data of the variation.<\/li>
- 'base.itemSerialNumber' = Includes base. The item serial numbers of the variation.<\/li>
- 'base.feedback' = Includes base. The feedback of the variation.<\/li>
- 'base.characteristics' = Includes base. The characteristics of the variation.<\/li>
- 'base.crossSelling' = Includes base. The cross selling items of the variation.<\/li>
- 'base.texts' = Includes base. The texts of the variation.<\/li>
- 'base.availability' = Includes base. The availability data related to the variation's availability ID.<\/li>
- 'base.images' = Includes base. The images linked to the item.<\/li>
- 'base.shippingProfiles' = Includes base. The shipping profiles linked to the item.<\/li>
- 'base.stock' = Includes base. The stock of the variation.<\/li>
- 'base.stockStorageLocations' = Includes base. The stock storage locations of the variation.<\/li>
- 'bundleComponents' = The bundle components of the variation.<\/li>
- 'categories' = The categories of the variation.<\/li>
- 'categories.category' = Includes categories. The related category data for each category ID.<\/li>
- 'categories.categoryBranch' = Includes categories. The related category branch data for each category ID.<\/li>
- 'clients' = The clients of the variation.<\/li>
- 'defaultCategories' = The default categories of the variation<\/li>
- 'defaultCategories.category' = Includes defaultCategories. The category data to the related category ID.<\/li>
- 'images' = The images of the variation<\/li>
- 'images.image' = Includes images. The image data to the related image ID.<\/li>
- 'markets' = The markets of the variation.<\/li>
- 'marketIdentNumbers' = The market ident numbers of the variation<\/li>
- 'salesPrices' = The sales prices of the variation.<\/li>
- 'salesPrices.salesPrice' = Includes salesPrices. The sales price data to the related sales price ID.<\/li>
- 'skus' = The skus of the variation.<\/li>
- 'supplier' = The supplier of the variation.<\/li>
- 'supplier.supplier' = Includes supplier. The contact data to the related supplier ID.<\/li>
- 'timestamps' = The timetamps of the variation.<\/li>
- 'warehouses' = The warehouses of the variation<\/li>
- 'warehouses.warehouse' = Includes warehouses. The warehouse data to the related warehouse ID.<\/li>
- 'unit' = The unit of the variation<\/li>
- 'unit.unit' = Includes unit. The unit data of the related unit ID.<\/li>
- 'tags' = The tags of the variation.<\/li>
- 'tags.tag' = Includes tags. The tag data to the related tag ID.<\/li>
- 'properties' = The properties of the variation.<\/li>
- 'properties.property' = Includes properties. The property data to the related property ID.<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "sortBy",
"type": "string",
"required": false,
"description": "Sorts the results. Append '_asc' or '_desc' to specify the sorting order. '_desc' is the default value if no other is specified. More than one parameter should be separated by commas. The following parameters are available:
- 'id'<\/li>
- 'itemId'<\/li>
- 'isMain'<\/li>
- 'position'<\/li>
- 'availabilityId'<\/li>
- 'createdAt'<\/li>
- 'updatedAt'<\/li>
- 'itemUpdatedAt'<\/li>
- 'relatedUpdatedAt'<\/li>
- 'variationName'<\/li>
- 'number'<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "groupBy",
"type": "string",
"required": false,
"description": "Groups the result. The following parameters are available:
- 'itemId' = Groups the result by the item ID.<\/li>
- 'itemAttributeValue' = Groups the result by the attribute with the flag 'isGroupable'.<\/li><\/ul>",
"format": "string",
"in": "query"
},
{
"name": "ids",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified item ID.",
"format": "integer",
"in": "query"
},
{
"name": "itemIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified item IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "isActive",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations which are active\/inactive.",
"format": "boolean",
"in": "query"
},
{
"name": "isMain",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations which are main\/not main.",
"format": "boolean",
"in": "query"
},
{
"name": "isSalable",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations which are salable.",
"format": "boolean",
"in": "query"
},
{
"name": "supplierId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the given supplier ID.",
"format": "integer",
"in": "query"
},
{
"name": "availabilityIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified availability IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "hasChildren",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations which have children.",
"format": "boolean",
"in": "query"
},
{
"name": "hasActiveChildren",
"type": "boolean",
"required": false,
"description": "Filter restricts the list of results to variations which have active children.",
"format": "boolean",
"in": "query"
},
{
"name": "attributeId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified attribute ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyAttributeId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified attribute IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "allAttributeIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified attribute IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "attributeValueId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified attribute value ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyAttributeValueId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have the any of the specified attribute value IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "allAttributeValueIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified attribute value IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "barcodeCode",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have a barcode with the specified code.",
"format": "string",
"in": "query"
},
{
"name": "barcodeId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have a barcode with the specified ID.",
"format": "integer",
"in": "query"
},
{
"name": "bundleType",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with the specified bundle type.",
"format": "string",
"in": "query"
},
{
"name": "categoryId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified category ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyCategoryId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified category IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "allCategoryIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified category IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "anyCharacteristicId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified characteristic IDs.",
"format": "string",
"in": "query"
},
{
"name": "allCharacteristicIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified characteristic IDs.",
"format": "string",
"in": "query"
},
{
"name": "clientId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified client ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyClientId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified client IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "allClientIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified client IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "automaticClientVisibilities",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified automatic client visibilities. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "imageHasMarketId",
"type": "number",
"required": false,
"description": "Filter restricts the list of results to variations which have an image available for the specified market ID.",
"format": "",
"in": "query"
},
{
"name": "flag1",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified flag one.",
"format": "integer",
"in": "query"
},
{
"name": "flag2",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified flag two.",
"format": "integer",
"in": "query"
},
{
"name": "manufacturerId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations with the specified manufacturer ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyManufacturerId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations with any of the specified manufacturer IDs.",
"format": "string",
"in": "query"
},
{
"name": "itemType",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified item type.",
"format": "string",
"in": "query"
},
{
"name": "marketId",
"type": "number",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified market ID.",
"format": "",
"in": "query"
},
{
"name": "anyMarketId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified market IDs.",
"format": "string",
"in": "query"
},
{
"name": "allMarketIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified market IDs.",
"format": "string",
"in": "query"
},
{
"name": "priceBetween",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have a sales price between the specified minimum and maximum value. Minimum and maximum value should be separated by a comma.",
"format": "string",
"in": "query"
},
{
"name": "priceBetweenById",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations where the specified sales price is between the specified minimum and maximum value. Sales price ID, Minimum and maximum value should be separated by a comma.",
"format": "string",
"in": "query"
},
{
"name": "anySalesPriceId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified sales price IDs. More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "propertySelectionId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to variations which have the specified property selection ID.",
"format": "integer",
"in": "query"
},
{
"name": "anyPropertySelectionId",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have any of the specified property selection IDs.",
"format": "string",
"in": "query"
},
{
"name": "allPropertySelectionIds",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have all specified property selection IDs.",
"format": "string",
"in": "query"
},
{
"name": "hasNameInLanguage",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have a name in the specified language.",
"format": "string",
"in": "query"
},
{
"name": "createdAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have been created in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "updatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations which have been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "itemCreatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations whose item has been created in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "itemUpdatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations whose item has been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "availabilityUpdatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations whose availablity has been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "stockUpdatedAt",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to variations whose stock has been updated in the specified time frame. The from and to parameter should be separated by a comma. If there is no to value, the current time is used instead.",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page of results. Default value is 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of results per page. Maximum value is 250. Default value is 50.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/plugin_sets": {
"get": {
"summary": "List all Sets",
"description": "Lists all available sets.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PluginSet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a Set",
"description": "Creates a new plugin set with the given name. If a 'copyPluginSetId' is given, all set entries from that set will be copied into the new set",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "copyPluginSetId",
"type": "integer",
"required": false,
"description": "The ID of the plugin set of which to copy the set entries from into the\n * new set",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/plugin_sets\/preview_hash": {
"get": {
"summary": "Get the preview hash for a set",
"description": "Get the hash required to preview a plugin set. Response content will be in the form ['previewHash' => 'adf245o9nwu90sdfjw409u4'].",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/plugin_sets\/s3-inbox-opensource-plugins": {
"get": {
"summary": "",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PluginSet"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/plugin_sets\/{pluginSetId}\/languages": {
"get": {
"summary": "List all the plugins translations for a plugin set",
"description": "Lists all translations for all plugins in a plugin set",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PluginTranslation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{pluginSetId}\/languages\/csv\/{languageCode}": {
"get": {
"summary": "List all plugin translations csv.",
"description": "Lists all plugin translations as a CSV file.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$languageCode",
"type": "string",
"required": true,
"description": "The code of the language",
"format": "string",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "languageCode",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{pluginSetId}\/languages\/{languageCode}": {
"delete": {
"summary": "Delete multiple translation",
"description": "Deletes multiple translation. The pluginSetId and languageCode must be specified.",
"tags": [
"PluginMultilingualism"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$languageCode",
"type": "string",
"required": true,
"description": "The code of the language",
"format": "string",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "languageCode",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{pluginSetId}\/languages\/{targetLanguage}": {
"get": {
"summary": "List all plugin translations merged.",
"description": "Lists all plugin translations that have been merged.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PluginTranslation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$targetLanguage",
"type": "string",
"required": true,
"description": "The code of the language we target",
"format": "string",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "targetLanguage",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Update all plugin translations",
"description": "Update all plugin translations from a csv file",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$pluginSetId",
"type": "integer",
"required": true,
"description": "The ID of the plugin set",
"format": "integer",
"in": "query"
},
{
"name": "$targetLanguage",
"type": "string",
"required": true,
"description": "The code of the language",
"format": "string",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "targetLanguage",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}": {
"delete": {
"summary": "Delete a set",
"description": "Deletes a plugin set. Response content will be the number of sets deleted (i. e. '1' or '0').",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a set",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a set",
"description": "Updates a set. Response content will be 'true' if the update was successful, 'false' if not.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins": {
"get": {
"summary": "List all Plugins of Set",
"description": "Lists all active Plugins of given Set.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "'includeStage",
"type": "boolean",
"required": false,
"description": "Include staged plugins in the result.",
"format": "boolean",
"in": "query"
},
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins\/get_compatibility\/{pluginName}\/{variationId}": {
"get": {
"summary": "",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginName",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins\/search": {
"get": {
"summary": "Search plugins",
"description": "Searches for plugins. The search can be refined with numerous parameters.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Plugin",
"items": {
"$ref": "#\/definitions\/Plugin"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginSetId",
"type": "integer",
"required": false,
"description": "Search for plugins from a specific plugin set.",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "Search for plugins with a specific name.",
"format": "string",
"in": "query"
},
{
"name": "in-stage",
"type": "boolean",
"required": false,
"description": "Search for plugins that are in stage.",
"format": "boolean",
"in": "query"
},
{
"name": "in-productive",
"type": "boolean",
"required": false,
"description": "Search for plugins that are in productive.",
"format": "boolean",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "Search for plugins of a given type. Available types are 'Template' and 'Export'.",
"format": "string",
"in": "query"
},
{
"name": "checkRequirements",
"type": "boolean",
"required": false,
"description": "Add the requirements to the response. This will add the 'notInstalledRequirements',\n * 'notActiveStageRequirements' and 'notActiveProductiveRequirements' fields to the returned plugin model(s).",
"format": "boolean",
"in": "query"
},
{
"name": "checkUpdate",
"type": "boolean",
"required": false,
"description": "Check for updates. If an update for a plugin is available, this will add the\n * 'updateInformation' field to the returned plugin model(s).",
"format": "boolean",
"in": "query"
},
{
"name": "source",
"type": "string",
"required": false,
"description": "Search for plugins from a specific source. Available sources are 'marketplace', 'git', and\n * 'local'.",
"format": "string",
"in": "query"
},
{
"name": "installed",
"type": "boolean",
"required": false,
"description": "Only search for installed \/ not installed plugins.",
"format": "boolean",
"in": "query"
},
{
"name": "active",
"type": "boolean",
"required": false,
"description": "Only search for plugins that are active \/ inactive.",
"format": "boolean",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "How many plugins to include per page of the search result.",
"format": "integer",
"in": "query"
},
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins\/{pluginId}": {
"delete": {
"summary": "Remove a plugin from a set",
"description": "Removes a plugin from a set and deletes all plugin files. Response content will be 'true' if the deletion was successful,\n'false' if not. If no plugin set with the given id can be found or the plugin is not associated to the set, a 404 will be returned.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Add a plugin to a set",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Change a plugin's 'active' status for a set.",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins\/{pluginId}\/install_git_plugin": {
"post": {
"summary": "Install a git plugin into a set",
"description": "Installs a git plugin into a set. Response content will be in the form ['gitPluginInstalled' => 'true' \/ 'false'].",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/plugins\/{pluginId}\/setPosition": {
"post": {
"summary": "Set a plugin's position in a set",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginSetEntry"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets\/{setId}\/set_entries": {
"get": {
"summary": "List all SetEntries of Set",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PluginSetEntry"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "setId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets_new\/git_plugin_details\/{pluginName}": {
"get": {
"summary": "get git plugin description data",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginName",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugin_sets_new\/plugin_details\/{pluginName}\/{variationId}": {
"get": {
"summary": "get plugin description data",
"description": "",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginName",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins": {
"get": {
"summary": "List plugins",
"description": "Lists all plugins saved in the inbox folder. Plugins that have not been provisioned to Stage or Productive will\nalso be shown.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Plugin"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a plugin",
"description": "Creates a plugin with empty plugin folders and a plugin.json file.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Plugin"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/plugins",
"schema": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the plugin matching to \/^[A-Za-z]+[A-Za-z0-9]+$\/ value must be unique"
},
"type": {
"type": "string",
"description": "The type of the plugin. The following plugin types are available:\n\n Template\n Export"
},
"description": {
"type": "string",
"description": "The description text of the plugin optional"
},
"serviceProvider": {
"type": "string",
"description": "The class name of the service provider optional"
}
}
}
}
]
}
},
"\/rest\/plugins\/plugin_sets\/{pluginSetId}\/configurations\/export": {
"get": {
"summary": "",
"description": "",
"tags": [
"Configuration"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins\/plugin_sets\/{pluginSetId}\/configurations\/import": {
"post": {
"summary": "",
"description": "",
"tags": [
"Configuration"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins\/plugin_sets\/{pluginSetId}\/plugins": {
"get": {
"summary": "List all Plugins of Set",
"description": "Lists all active Plugins of given Set.",
"tags": [
"PluginSet"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "'includeStage",
"type": "boolean",
"required": false,
"description": "Include staged plugins in the result.",
"format": "boolean",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins\/search": {
"get": {
"summary": "List plugins",
"description": "Lists all plugins saved in the inbox folder. Plugins that have not been provisioned to Stage or Productive will\nalso be shown.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Plugin",
"items": {
"$ref": "#\/definitions\/Plugin"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of the plugin",
"format": "string",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "The type of the plugin (template, theme, etc.)",
"format": "string",
"in": "query"
},
{
"name": "webstoreId",
"type": "integer",
"required": false,
"description": "The ID of the client (store)",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/plugins\/seo\/sitemap": {
"get": {
"summary": "Load sitemap patterns",
"description": "Loads all given sitemap patterns from booted plugins.",
"tags": [
"Plugins"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/string"
}
}
}
}
}
},
"\/rest\/plugins\/ui": {
"get": {
"summary": "List plugins for backend UI",
"description": "Lists all plugins provisioned in Stage or Productive that contain a plugin.js file.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Plugin"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/plugins\/{pluginId}": {
"delete": {
"summary": "Delete a plugin",
"description": "Deletes a plugin. This call also deletes all plugin files in the inbox folder! To commit the deletion, the\nplugin must be provisioned in Stage or Productive. The ID of the plugin must be specified.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a plugin",
"description": "Gets a plugin. The ID of the plugin must be specified.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Plugin"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a plugin",
"description": "Updates a plugin. The plugin position can be changed. The plugin can be activated or deactivated for Stage or\nProductive. The plugin can be activated or deactivated for online stores. The ID of the plugin must be\nspecified.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Plugin"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/plugins\/{pluginId}",
"schema": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"description": "The position of the plugin. The position is used to determine the plugin\norder. optional"
},
"activeStage": {
"type": "boolean",
"description": "Shows whether the plugin is active in Stage. Inactive plugins will not\nbe provisioned in Stage. optional"
},
"activeProductive": {
"type": "boolean",
"description": "Shows whether the plugin is active in Productive. Inactive plugins will\nnot be provisioned in Productive. optional"
},
"webstores": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Webstore"
}
}
}
}
}
]
}
},
"\/rest\/plugins\/{pluginId}\/plugin_sets\/{pluginSetId}": {
"delete": {
"summary": "Delete a plugin",
"description": "Deletes a plugin. This call also deletes all plugin files in the inbox folder! To commit the deletion, the\nplugin must be provisioned in Stage or Productive. The ID of the plugin must be specified.",
"tags": [
"Plugins"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins\/{pluginId}\/plugin_sets\/{pluginSetId}\/configuration_layout": {
"get": {
"summary": "",
"description": "",
"tags": [
"Configuration"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins\/{pluginId}\/plugin_sets\/{pluginSetId}\/configurations": {
"get": {
"summary": "",
"description": "",
"tags": [
"Configuration"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Configuration"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "",
"description": "",
"tags": [
"Configuration"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "pluginId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "pluginSetId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/plugins_mail": {
"post": {
"summary": "Send mail",
"description": "Send mail from booted plugins.",
"tags": [
"Plugins"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
}
}
}
},
"\/rest\/properties": {
"get": {
"summary": "List properties",
"description": "Lists properties.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Property"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property",
"description": "Creates a property",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "cast",
"type": "string",
"required": true,
"description": "The cast of the property",
"format": "string",
"in": "query"
},
{
"name": "typeIdentifier",
"type": "string",
"required": true,
"description": "The identifier of the property type",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the property",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties",
"schema": {
"type": "object",
"required": [
"cast",
"position",
"names"
],
"properties": {
"cast": {
"type": "string",
"description": "The cast of the property (array values: 'empty','int','float','selection','shortText','longText','date','file') allowed values are empty, int, float, selection, shortText, longText, date, file, multiSelection"
},
"position": {
"type": "integer",
"description": "The position of the property"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Collection"
}
}
}
}
}
]
}
},
"\/rest\/properties\/amazons": {
"get": {
"summary": "List property amazons",
"description": "Lists property amazons",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyAmazon"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create one or multiple property amazon",
"description": "Creates one or multiple property amazon.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAmazon"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "platform",
"type": "string",
"required": true,
"description": "The platform of the property amazon",
"format": "string",
"in": "query"
},
{
"name": "category",
"type": "string",
"required": true,
"description": "The category of the property amazon",
"format": "string",
"in": "query"
},
{
"name": "field",
"type": "string",
"required": true,
"description": "The field of the property amazon",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/amazons",
"schema": {
"type": "object",
"required": [
"propertyId",
"platform",
"category",
"field"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"platform": {
"type": "string",
"description": "The platform of the property amazon"
},
"category": {
"type": "string",
"description": "The category of the property amazon"
},
"field": {
"type": "string",
"description": "The field of the property amazon"
}
}
}
}
]
},
"put": {
"summary": "Update one or multiple property amazon",
"description": "Updates one or multiple property amazon",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAmazon"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/amazons\/{propertyAmazonId}": {
"delete": {
"summary": "Delete a property amazon",
"description": "Deletes a property amazon",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyAmazonId",
"type": "integer",
"required": true,
"description": "The ID of the property amazon",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property amazon",
"description": "Gets a proeprty amazon. The ID of the property amazon must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAmazon"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyAmazonId",
"type": "integer",
"required": true,
"description": "The ID of the property amazon",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/availabilities": {
"get": {
"summary": "List availabilities",
"description": "Lists availabilities.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyAvailability"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create an availability",
"description": "Creates an availability.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAvailability"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "type",
"type": "integer",
"required": true,
"description": "The type of the availability",
"format": "integer",
"in": "query"
},
{
"name": "value",
"type": "integer",
"required": true,
"description": "The value of the availability",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/availabilities",
"schema": {
"type": "object",
"required": [
"propertyId",
"type",
"value"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"type": {
"type": "string",
"description": "The type of the property availability"
},
"value": {
"type": "number",
"description": "The value of the property availability"
}
}
}
}
]
}
},
"\/rest\/properties\/availabilities\/{availabilityId}": {
"delete": {
"summary": "Delete an availability",
"description": "Deletes an availability. The ID ot the availability must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "availabilityId",
"type": "integer",
"required": true,
"description": "The ID of the availability",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get an availability",
"description": "Gets an availability. The ID of the availability must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAvailability"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "availabilityId",
"type": "integer",
"required": true,
"description": "The ID of the property availability",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update an availability",
"description": "Updates an availability. The ID of the availabilty must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyAvailability"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "availabilityId",
"type": "integer",
"required": true,
"description": "The ID of the availability",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/destinations": {
"get": {
"summary": "Get property destinations",
"description": "Returns a json with the destinations processed: data from providers and translations.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/groups": {
"get": {
"summary": "List property groups",
"description": "Lists property groups.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyGroup"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a property group",
"description": "Creates a property group.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the group",
"format": "integer",
"in": "query"
},
{
"name": "names",
"type": "integer",
"required": false,
"description": "The names of the group.",
"format": "integer",
"in": "query"
},
{
"name": "options",
"type": "integer",
"required": false,
"description": "The options of the group",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/groups",
"schema": {
"type": "object",
"required": [
"position"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the property group"
}
}
}
}
]
}
},
"\/rest\/properties\/groups\/names": {
"get": {
"summary": "List group names",
"description": "Lists group names.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyGroupName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create an group name",
"description": "Creates a group name",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The lang of the group name",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the group name",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/groups\/names",
"schema": {
"type": "object",
"required": [
"propertyGroupId",
"lang",
"name"
],
"properties": {
"propertyGroupId": {
"type": "integer",
"description": "The ID of the property group"
},
"lang": {
"type": "string",
"description": "The language of the property group name as ISO 639-1 language code, e.g. en for English"
},
"name": {
"type": "string",
"description": "The name of the property group"
},
"description": {
"type": "string",
"description": "The description of the property group optional"
}
}
}
}
]
}
},
"\/rest\/properties\/groups\/names\/{groupNameId}": {
"delete": {
"summary": "Delete a group name",
"description": "Deletes a group name. The ID of the group name must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupNameId",
"type": "integer",
"required": true,
"description": "The ID of the group name",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a group name",
"description": "Gets a group name. The ID of the group name must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupNameId",
"type": "integer",
"required": true,
"description": "The ID of the group name",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a group name",
"description": "Updates a group name. The ID of the group name must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupNameId",
"type": "integer",
"required": true,
"description": "The ID of the group name",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/groups\/options": {
"get": {
"summary": "List group options",
"description": "Lists group options.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyGroupOption"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a group option",
"description": "Creates a group option",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyGroupId",
"type": "integer",
"required": true,
"description": "The ID of the property group",
"format": "integer",
"in": "query"
},
{
"name": "groupOptionIdentifier",
"type": "string",
"required": true,
"description": "The groupOptionIdentifier of the group name",
"format": "string",
"in": "query"
},
{
"name": "value",
"type": "string",
"required": true,
"description": "The value of the group name",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/groups\/options",
"schema": {
"type": "object",
"required": [
"propertyGroupId",
"groupOptionIdentifier",
"value"
],
"properties": {
"propertyGroupId": {
"type": "integer",
"description": "The ID of the property group"
},
"groupOptionIdentifier": {
"type": "string",
"description": "The identifier of the property group option"
},
"value": {
"type": "string",
"description": "The value of the property group option"
}
}
}
}
]
}
},
"\/rest\/properties\/groups\/options\/{groupOptionId}": {
"delete": {
"summary": "Delete a group option",
"description": "Deletes a group option. The ID of the group option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupOptionId",
"type": "integer",
"required": true,
"description": "The ID of the group option",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a group option",
"description": "Gets a group option. The ID of the group option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupOptionId",
"type": "integer",
"required": true,
"description": "The ID of the group option",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a group option",
"description": "Updates a group option. The ID of the group option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroupOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupOptionId",
"type": "integer",
"required": true,
"description": "The ID of the group option",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/groups\/surcharge\/types": {
"get": {
"summary": "Get surcharge types from module configuration",
"description": "",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/groups\/types": {
"get": {
"summary": "Get group types from module configuration",
"description": "",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/groups\/{groupId}": {
"get": {
"summary": "Get a property group",
"description": "Gets a property group. The ID of the property group must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property group",
"description": "Updates a property group. The ID of the property group must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyGroup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "position",
"type": "integer",
"required": false,
"description": "The position of the group",
"format": "integer",
"in": "query"
},
{
"name": "names",
"type": "integer",
"required": false,
"description": "The names of the group.",
"format": "integer",
"in": "query"
},
{
"name": "options",
"type": "integer",
"required": false,
"description": "The options of the group",
"format": "integer",
"in": "query"
},
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/properties\/groups\/{groupId}",
"schema": {
"type": "object",
"required": [
"position"
],
"properties": {
"position": {
"type": "integer",
"description": "The position of the property group"
}
}
}
}
]
}
},
"\/rest\/properties\/groups\/{groupId}\/properties": {
"post": {
"summary": "Mass attach propertyId and groupId collection into the pivot table.",
"description": "",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/groups\/{groupId}\/properties\/{propertyId}": {
"delete": {
"summary": "Detach a property from a property group.",
"description": "Detaches a property from a property group. The ID of the property and the ID of the property group must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Attach a property to a property group",
"description": "Attaches a property to a property group. The ID of the property and the ID of the property group must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "path"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/groups\/{propertyId}": {
"delete": {
"summary": "Delete a property group",
"description": "Deletes a property group. The ID of the property group must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "groupId",
"type": "integer",
"required": true,
"description": "The ID of the group",
"format": "integer",
"in": "query"
},
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/markets": {
"get": {
"summary": "List property markets",
"description": "Lists property markets",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyMarket"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property market",
"description": "Creates a property market.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "Property id",
"format": "integer",
"in": "query"
},
{
"name": "referrerId",
"type": "number",
"required": true,
"description": "The referrer id of the property market",
"format": "",
"in": "query"
},
{
"name": "referrerSubId",
"type": "integer",
"required": true,
"description": "The referrer sub id of the property market",
"format": "integer",
"in": "query"
},
{
"name": "value",
"type": "string",
"required": true,
"description": "The value of the property market",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/markets",
"schema": {
"type": "object",
"required": [
"propertyId"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"referrerId": {
"type": "number",
"description": "The ID of the referrer optional"
},
"referrerSubId": {
"type": "integer",
"description": "The ID of the sub referrer optional"
},
"value": {
"type": "string",
"description": "The value of the property market optional"
}
}
}
}
]
}
},
"\/rest\/properties\/markets\/{propertiesMarketId}": {
"delete": {
"summary": "Delete a property market",
"description": "Deletes a property market. The ID of the property market must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyMarketId",
"type": "integer",
"required": true,
"description": "The ID of the property market",
"format": "integer",
"in": "query"
},
{
"name": "propertiesMarketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property market",
"description": "Gets a property market. The ID of the property market must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyMarketId",
"type": "integer",
"required": true,
"description": "The ID of the property market",
"format": "integer",
"in": "query"
},
{
"name": "propertiesMarketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property market",
"description": "Updates a property market. The ID of the property market must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyMarket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertiesMarketId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/properties\/markets\/{propertiesMarketId}",
"schema": {
"type": "object",
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property optional"
}
}
}
}
]
}
},
"\/rest\/properties\/multiple\/options": {
"delete": {
"summary": "Delete property options",
"description": "Deletes property options.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create property options",
"description": "Creates property options.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "typeOptionIdentifier",
"type": "string",
"required": true,
"description": "The identifier of the property option type",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/properties\/names": {
"get": {
"summary": "List names",
"description": "Lists names.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a name",
"description": "Creates a name",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The id of the property name",
"format": "integer",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The lang of the property name",
"format": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the property name",
"format": "string",
"in": "query"
},
{
"name": "description",
"type": "string",
"required": false,
"description": "The description of the property name",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/names",
"schema": {
"type": "object",
"required": [
"propertyId",
"lang",
"name"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"lang": {
"type": "string",
"description": "The language of the property name as ISO 639-1 language code, e.g. en for English"
},
"name": {
"type": "string",
"description": "The name of the property"
},
"description": {
"type": "string",
"description": "The description of the property optional"
}
}
}
}
]
}
},
"\/rest\/properties\/names\/{nameId}": {
"delete": {
"summary": "Delete a property name",
"description": "Deletes a property name. The ID of the property name must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "nameId",
"type": "integer",
"required": true,
"description": "The ID of the property name",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property name",
"description": "Gets a proeprty name. The ID of the property name must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "nameId",
"type": "integer",
"required": true,
"description": "The ID of the property name",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property name",
"description": "Updates a property name. The ID of the property name must be specified",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyName"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "nameId",
"type": "integer",
"required": true,
"description": "The ID of the property name",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/options": {
"get": {
"summary": "List property options",
"description": "Lists property options.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyOption"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property option",
"description": "Creates a property option.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "typeOptionIdentifier",
"type": "string",
"required": true,
"description": "The identifier of the property option type",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/options",
"schema": {
"type": "object",
"required": [
"propertyId",
"typeOptionIdentifier"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"typeOptionIdentifier": {
"type": "string",
"description": "The identifier of the type option"
}
}
}
}
]
}
},
"\/rest\/properties\/options\/{propertyOptionId}": {
"delete": {
"summary": "Delete a property option",
"description": "Deletes a property option. The ID of the proeprty option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyOptionId",
"type": "integer",
"required": true,
"description": "The ID of the property option",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property option",
"description": "Gets a property option. The ID of the property option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyOptionId",
"type": "integer",
"required": true,
"description": "The ID of the property option",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property option",
"description": "Updates a property option. The ID of the property option must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyOption"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$propertyOptionId",
"type": "integer",
"required": true,
"description": "The ID of the property option",
"format": "integer",
"in": "query"
},
{
"name": "propertyOptionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/relations": {
"delete": {
"summary": "Delete property relations",
"description": "Deletes property relations. The ID of the property relations must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "query"
}
]
},
"get": {
"summary": "List property relations",
"description": "Lists property relations.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "Current page of the response",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The requested amount of items per result page",
"format": "integer",
"in": "query"
},
{
"name": "paginate",
"type": "integer",
"required": false,
"description": "The condition that determines if the pagination should be used (default value is set to 0)",
"format": "integer",
"in": "query"
},
{
"name": "relationTypeIdentifier",
"type": "string",
"required": false,
"description": "The parameter that decides the type of relation",
"format": "string",
"in": "query"
},
{
"name": "relationTargetId",
"type": "integer",
"required": false,
"description": "The ID of the target of the relation",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a property relation",
"description": "Creates a property relation",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "relationTypeIdentifier",
"type": "string",
"required": true,
"description": "The identifier of the property relation type",
"format": "string",
"in": "query"
},
{
"name": "relationTargetId",
"type": "integer",
"required": true,
"description": "The ID of the property relation target",
"format": "integer",
"in": "query"
},
{
"name": "selectionRelationId",
"type": "integer",
"required": true,
"description": "The ID of the property selection relation",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/relations",
"schema": {
"type": "object",
"required": [
"propertyId"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"selectionRelationId": {
"type": "integer",
"description": "The ID of the selection relation optional"
}
}
}
}
]
},
"put": {
"summary": "Update relations",
"description": "Updates relations",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/properties\/relations\/markups": {
"get": {
"summary": "List relation markups",
"description": "Lists relation markups.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelationMarkup"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property relation markup",
"description": "Creates a property relation markup",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationMarkup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyRelationId",
"type": "integer",
"required": true,
"description": "The ID of the property elation",
"format": "integer",
"in": "query"
},
{
"name": "variationSalesPriceId",
"type": "integer",
"required": true,
"description": "The ID of a variation's sales price",
"format": "integer",
"in": "query"
},
{
"name": "markup",
"type": "number",
"required": true,
"description": "The property relation markup",
"format": "",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/relations\/markups",
"schema": {
"type": "object",
"required": [
"propertyRelationId",
"variationSalesPriceId",
"markup"
],
"properties": {
"propertyRelationId": {
"type": "integer",
"description": "The ID of the property relation"
},
"variationSalesPriceId": {
"type": "integer",
"description": "The variation sales price id of the property relation markup"
},
"markup": {
"type": "number",
"description": "The markup of the property relation markup"
}
}
}
}
]
}
},
"\/rest\/properties\/relations\/markups\/{relationMarkupId}": {
"delete": {
"summary": "Delete a property relation markup",
"description": "Deletes a property relation markup",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationMarkupId",
"type": "integer",
"required": true,
"description": "The ID of the relation markup",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property relation markup",
"description": "Gets a property relation markup. The ID of the property relation markup must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationMarkup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationMarkupId",
"type": "integer",
"required": true,
"description": "The ID of the relation markup",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property relation markup",
"description": "Updates a property relation markup",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationMarkup"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationMarkupId",
"type": "integer",
"required": true,
"description": "The ID of the property relation markup",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/relations\/values": {
"get": {
"summary": "List property relation values",
"description": "Lists property relation values.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelationValue"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property relation value",
"description": "Creates a property relation value.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "lang",
"type": "string",
"required": true,
"description": "The lang of the property relation value",
"format": "string",
"in": "query"
},
{
"name": "value",
"type": "string",
"required": true,
"description": "The value of the property relation",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/relations\/values",
"schema": {
"type": "object",
"required": [
"propertyRelationId"
],
"properties": {
"propertyRelationId": {
"type": "integer",
"description": "The ID of the property relation"
},
"lang": {
"type": "string",
"description": "The language of the property relation value optional"
},
"value": {
"type": "string",
"description": "The value of the property relation optional"
}
}
}
}
]
},
"put": {
"summary": "Update multiple property relation value",
"description": "Updates multiple property relation value",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/relations\/values\/{propertiesRelationValueId}": {
"delete": {
"summary": "Delete a property relation value",
"description": "Deletes a property relation value. The ID of the property relation value must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyRelationValueId",
"type": "integer",
"required": true,
"description": "The ID of the property relation value",
"format": "integer",
"in": "query"
},
{
"name": "propertiesRelationValueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property relation value",
"description": "Updates a property relation value. The ID of the property relation value must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$propertyRelationValueId",
"type": "integer",
"required": true,
"description": "The ID of the property relation value",
"format": "integer",
"in": "query"
},
{
"name": "propertiesRelationValueId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/relations\/values\/{relationMarkupId}": {
"get": {
"summary": "Get a property relation value",
"description": "Gets a property relation value. The ID of the property relation value must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelationValue"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyRelationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "query"
},
{
"name": "relationMarkupId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/relations\/{relationId}": {
"delete": {
"summary": "Delete a property relation",
"description": "Deletes a property relation. The ID of the property relation must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property relation",
"description": "Gets a property relation. The ID of the property relation must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the relation",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property relation",
"description": "Updates a property relation. The ID of the property relation must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertyRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/relations\/{relationId}\/file": {
"post": {
"summary": "Save property relation file to S3",
"description": "Saves property relation file to S3.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "The ID of the property relation",
"format": "integer",
"in": "path"
},
{
"name": "key",
"type": "string",
"required": true,
"description": "The name of the file that needs to be saved",
"format": "string",
"in": "query"
},
{
"name": "content",
"type": "string",
"required": true,
"description": "The actual file content in text format",
"format": "string",
"in": "query"
},
{
"name": "deleteIfExists",
"type": "boolean",
"required": true,
"description": "Condition for the check of already existing file",
"format": "boolean",
"in": "query"
}
]
}
},
"\/rest\/properties\/relations\/{relationId}\/values": {
"delete": {
"summary": "Delete all property relation values of a specified property relation",
"description": "Delete all property relation values of a specified property relation.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/selections": {
"get": {
"summary": "List property selections",
"description": "Lists property selections",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertySelection"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create a property selection",
"description": "Creates a property selection.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the property selection",
"format": "integer",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/properties\/selections",
"schema": {
"type": "object",
"required": [
"propertyId",
"relation"
],
"properties": {
"propertyId": {
"type": "integer",
"description": "The ID of the property"
},
"position": {
"type": "integer",
"description": "The position of the property selection optional"
},
"relation": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PropertyRelation"
}
}
}
}
}
]
}
},
"\/rest\/properties\/selections\/{propertySelectionId}": {
"delete": {
"summary": "Delete a property selection",
"description": "Deletes a property selection",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertySelectionId",
"type": "integer",
"required": true,
"description": "The ID of the property selection",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property selection",
"description": "Gets a property selection. The ID of property selection must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertySelectionId",
"type": "integer",
"required": true,
"description": "The ID of the property selection",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property selection",
"description": "Updates a property selection. The ID of the property selection must be specifed.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PropertySelection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$propertySelectionId",
"type": "integer",
"required": true,
"description": "The ID of the property selection",
"format": "integer",
"in": "query"
},
{
"name": "propertySelectionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/properties\/systemlang": {
"get": {
"summary": "Get system language",
"description": "Gets the system language.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/properties\/{propertyId}": {
"delete": {
"summary": "Delete a property",
"description": "Deletes a property. The ID of the property must be specified",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a property.",
"description": "Gets a property. The ID of the property must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a property",
"description": "Updates a property. The ID of the property must be specified.",
"tags": [
"Property"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Property"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "propertyId",
"type": "integer",
"required": true,
"description": "The ID of the property",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/quick_login": {
"post": {
"summary": "",
"description": "",
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
}
}
}
},
"\/rest\/redistributions": {
"post": {
"summary": "Create a redistribution",
"description": "Create a redistribution",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/redistributions",
"schema": {
"type": "object",
"required": [
"relations"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the order type\n It is possible to define individual order types. However,\n the following types are available by default:\n\n 1 = Sales order\n 2 = Delivery\n 3 = Returns\n 4 = Credit note\n 5 = Warranty\n 6 = Repair\n 7 = Offer\n 8 = Advance order\n 9 = Multi-order\n 10 = Multi credit note\n 11 = Multi delivery\n 12 = Reorder\n 13 = Partial delivery\n 14 = Subscription\n 15 = Redistribution\n optional allowed values are 15"
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/redistributions\/{orderId}": {
"delete": {
"summary": "Delete a redistribution",
"description": "Deletes a redistribution. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a redistribution",
"description": "Updates a redistribution. The ID of the order must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/redistributions\/{orderId}",
"schema": {
"type": "object",
"required": [
"relations"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the order type\n It is possible to define individual order types. However,\n the following types are available by default:\n\n 1 = Sales order\n 2 = Delivery\n 3 = Returns\n 4 = Credit note\n 5 = Warranty\n 6 = Repair\n 7 = Offer\n 8 = Advance order\n 9 = Multi-order\n 10 = Multi credit note\n 11 = Multi delivery\n 12 = Reorder\n 13 = Partial delivery\n 14 = Subscription\n 15 = Redistribution\n optional allowed values are 15"
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/reorders": {
"post": {
"summary": "Create a reorder",
"description": "Create a reorder",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/reorders",
"schema": {
"type": "object",
"required": [
"relations"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the order type\n It is possible to define individual order types. However,\n the following types are available by default:\n\n 1 = Sales order\n 2 = Delivery\n 3 = Returns\n 4 = Credit note\n 5 = Warranty\n 6 = Repair\n 7 = Offer\n 8 = Advance order\n 9 = Multi-order\n 10 = Multi credit note\n 11 = Multi delivery\n 12 = Reorder\n 13 = Partial delivery\n 14 = Subscription\n 15 = Redistribution\n optional allowed values are 12"
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/reorders\/{orderId}": {
"delete": {
"summary": "Delete a reorder",
"description": "Deletes a reorder. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a reorder",
"description": "Updates a reorder. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/reorders\/{orderId}",
"schema": {
"type": "object",
"required": [
"relations"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The ID of the order type\n It is possible to define individual order types. However,\n the following types are available by default:\n\n 1 = Sales order\n 2 = Delivery\n 3 = Returns\n 4 = Credit note\n 5 = Warranty\n 6 = Repair\n 7 = Offer\n 8 = Advance order\n 9 = Multi-order\n 10 = Multi credit note\n 11 = Multi delivery\n 12 = Reorder\n 13 = Partial delivery\n 14 = Subscription\n 15 = Redistribution\n optional allowed values are 12"
},
"relations": {
"type": "array",
"items": {}
}
}
}
}
]
}
},
"\/rest\/reorders\/{orderId}\/currency": {
"put": {
"summary": "Update the currency",
"description": "Update the currency for a reorder",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/reorders\/{orderId}\/delivery_date": {
"get": {
"summary": "Get the delivery date",
"description": "Get the delivery date for a reorder",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/reorders\/{orderId}\/delivery_dates": {
"put": {
"summary": "Calculate and save the delivery dates",
"description": "Calculates and saves the delivery dates for the reorder and the reorder items. The order ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Order"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "orderId",
"type": "integer",
"required": true,
"description": "The ID of the order.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/reports\/key-figures": {
"get": {
"summary": "Return list of key figure classes",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/key-figures\/config": {
"get": {
"summary": "Returns all key figure configs",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureConfigSearchResult"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Add a key figure configuration",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/key-figures\/config\/template": {
"post": {
"summary": "Generate key figure config from template class",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyFigureClass",
"type": "string",
"required": true,
"description": "Template class name",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/reports\/key-figures\/config\/templates": {
"get": {
"summary": "Get key figure templates",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/key-figures\/config\/{keyFigureConfigId}": {
"delete": {
"summary": "Delete key figure configuration",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyFigureConfigId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get key figure config",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyFigureConfigId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update key figure configuration",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureConfig"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyFigureConfigId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/reports\/key-figures\/configs": {
"delete": {
"summary": "Delete multiple key figure configurations",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/key-figures\/details\/{keyFigureName}": {
"get": {
"summary": "Return key figure calculation details",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigure"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyFigureName",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/reports\/key-figures\/results": {
"post": {
"summary": "Search for key figure calculation results",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/KeyFigureResultSearchResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/order-types": {
"get": {
"summary": "Get order types in string format",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/raw-data": {
"get": {
"summary": "Get list of raw data files. Valid filter combinations: (dataName), (dataName & processStatus), (createdAtTimestamp)",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/RawDataSearchResult"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "dataName",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to raw data files e.g. orders,orderItems.",
"format": "string",
"in": "query"
},
{
"name": "processStatus",
"type": "string",
"required": false,
"description": "Current process status, the status is only changed by internal processing. If this filter is used, the filter dataNames may only contain one value.",
"format": "string",
"in": "query"
},
{
"name": "createdAtTimestamp",
"type": "integer",
"required": false,
"description": "Timestamp from when daily generated raw data are to be filtered. This filter cannot be combined with the following filters: dataNames, processStatus",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of raw data files to be returned. The default number of files is 20 and the maximum is 100.",
"format": "integer",
"in": "query"
},
{
"name": "sortOrder",
"type": "string",
"required": false,
"description": "Defines the sort order, possible values are: asc, desc",
"format": "string",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Page",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/reports\/raw-data\/config": {
"get": {
"summary": "Returns list of all saved configurations",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/RawDataConfigs"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"put": {
"summary": "Resets all saved raw data configurations with given data",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/RawDataConfigs"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "configs",
"type": "integer",
"required": true,
"description": "Resets all saved raw data configurations with given configs",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/reports\/raw-data\/creators": {
"get": {
"summary": "Get list of all raw data creators",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/raw-data\/creators-configs": {
"get": {
"summary": "Return a list of raw data creators with their configurations",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/reports\/raw-data\/file": {
"get": {
"summary": "Get a raw data file from the storage, the storage path of the file must be specified.",
"description": "",
"tags": [
"Report"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "path",
"type": "string",
"required": true,
"description": "The raw data file path",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/session_limits": {
"get": {
"summary": "",
"description": "",
"tags": [
"Authentication"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/shop_builder\/content_links": {
"get": {
"summary": "List all content links for a given plugin set",
"description": "List all content links for a given plugin set",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ContentLink"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Link a content to a layout container of a frontend plugin.",
"description": "Link a content to a layout container of a frontend plugin",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ContentLink"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/shop_builder\/content_links",
"schema": {
"type": "object",
"required": [
"contentId",
"containerName",
"pluginSetId"
],
"properties": {
"contentId": {
"type": "integer",
"description": "The ID of the content"
},
"containerName": {
"type": "string",
"description": "The name of the container"
},
"pluginSetId": {
"type": "integer",
"description": "The Id of the plugin set"
},
"language": {
"type": "string",
"description": "The language where the content is linked to. optional"
},
"inherit": {
"type": "boolean",
"description": "Indicates if this content should be inherited to child contents. optional"
}
}
}
}
]
}
},
"\/rest\/shop_builder\/content_links\/{contentLinkId}": {
"delete": {
"summary": "Delete a content link.",
"description": "Delete a content link",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentLinkId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Find a content link by id.",
"description": "Find a content link by id",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ContentLink"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentLinkId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a content link.",
"description": "Update a content link",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/ContentLink"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentLinkId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/shop_builder\/content_links\/{contentLinkId}",
"schema": {
"type": "object",
"required": [
"contentId",
"containerName",
"pluginSetId"
],
"properties": {
"contentId": {
"type": "integer",
"description": "The ID of the content"
},
"containerName": {
"type": "string",
"description": "The name of the container"
},
"pluginSetId": {
"type": "integer",
"description": "The Id of the plugin set"
},
"language": {
"type": "string",
"description": "The language where the content is linked to. optional"
},
"inherit": {
"type": "boolean",
"description": "Indicates if this content should be inherited to child contents. optional"
}
}
}
}
]
}
},
"\/rest\/shop_builder\/content_links\/{contentLinkId}\/preview_url": {
"get": {
"summary": "Generate a preview link for a contentLink.",
"description": "Generate a preview link for a contentLink",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentLinkId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/shop_builder\/contents": {
"get": {
"summary": "List all contents.",
"description": "Lists all available ShopBuilder contents.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Content"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "Create new content.",
"description": "Creates a new ShopBuilder content.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Content"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "frontendLang",
"type": "string",
"required": false,
"description": "Language to be used when rendering frontend widgets.",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/shop_builder\/contents",
"schema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the content"
},
"dataProviderName": {
"type": "string",
"description": "The name of the data provider optional"
},
"widgets": {
"type": "string",
"description": "The configured widgets of the content. This attribute is deprecated. Use $dropzones instead. array"
},
"link": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ContentLink"
}
}
}
}
}
]
},
"put": {
"summary": "Generate templates for all contents.",
"description": "Re-generates the templates for all ShopBuilder contents.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/shop_builder\/contents\/search": {
"get": {
"summary": "Search for contents.",
"description": "Searches for specific contents based on the provided parameters.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"items": {}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The page of results to search for",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items to list per page",
"format": "integer",
"in": "query"
},
{
"name": "dataProviderName",
"type": "string",
"required": false,
"description": "Name of the content",
"format": "string",
"in": "query"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "Type of the content",
"format": "string",
"in": "query"
},
{
"name": "containerName",
"type": "string",
"required": false,
"description": "Name of the linked container",
"format": "string",
"in": "query"
},
{
"name": "pluginSetId",
"type": "integer",
"required": false,
"description": "Id of the linked plugin set",
"format": "integer",
"in": "query"
},
{
"name": "language",
"type": "string",
"required": false,
"description": "Language of the content link",
"format": "string",
"in": "query"
},
{
"name": "active",
"type": "integer",
"required": false,
"description": "Active state of the content link",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/shop_builder\/contents\/{contentId}": {
"delete": {
"summary": "Delete a content",
"description": "Deletes a ShopBuilder content.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Find a content by id.",
"description": "Finds a ShopBuilder content by its id.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Content"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"options": {
"summary": "Get cross origin headers.",
"description": "Get cross origin headers.",
"tags": [
"Shop"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
}
},
"parameters": [
{
"name": "contentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Duplicate a content by id.",
"description": "Duplicates a ShopBuilder content by id.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Content"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "contentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a content.",
"description": "Updates a ShopBuilder content. If not data are provided, content will be rebuilt.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Content"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "frontendLang",
"type": "string",
"required": false,
"description": "Language to be used when rendering frontend widgets.",
"format": "string",
"in": "query"
},
{
"name": "contentId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/shop_builder\/contents\/{contentId}",
"schema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the content"
},
"dataProviderName": {
"type": "string",
"description": "The name of the data provider optional"
},
"widgets": {
"type": "string",
"description": "The configured widgets of the content. This attribute is deprecated. Use $dropzones instead. array"
},
"link": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ContentLink"
}
}
}
}
}
]
}
},
"\/rest\/shop_builder\/pages": {
"get": {
"summary": "List content pages",
"description": "List content pages from all plugins in a given plugin set.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ContentPage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/shop_builder\/widgets": {
"get": {
"summary": "List all widgets",
"description": "List all widgets provided by all frontend plugins of a given plugin set.",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "identifier",
"type": "string",
"required": false,
"description": "Filter results by widget identifier.",
"format": "string",
"in": "query"
}
]
},
"options": {
"summary": "Get cross origin headers.",
"description": "Get cross origin headers.",
"tags": [
"Shop"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
}
}
},
"post": {
"summary": "Render the preview for widgets",
"description": "Render the preview for widgets",
"tags": [
"Shop"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Response"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "frontendLang",
"type": "string",
"required": false,
"description": "Language to be used when rendering frontend widgets.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/stock": {
"get": {
"summary": "List stock",
"description": "Lists stock of all warehouses.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Stock",
"items": {
"$ref": "#\/definitions\/Stock"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to stock with a variation. The id of the variation must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/stock\/redistribute": {
"put": {
"summary": "Redistribute stock",
"description": "Redistributes stock of one storage location among one or more storage locations.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/stockmanagement\/stock\/redistribute",
"schema": {
"type": "object",
"required": [
"redistributions",
"variationId",
"quantity",
"currentStorageLocationId",
"currentWarehouseId",
"newStorageLocationId",
"newWarehouseId"
],
"properties": {
"redistributions": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStockRedistribution"
}
},
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"reasonId": {
"type": "integer",
"description": "The reason for the redistribution. Valid reasons are:\n\n\t401: Stock transfer\n\t402: Stock correction by stocktaking\n\t403: Stock transfer because of need for repair\n optional"
},
"quantity": {
"type": "number",
"description": "The quantity to redistribute"
},
"currentStorageLocationId": {
"type": "integer",
"description": "The ID of the current storage location"
},
"currentWarehouseId": {
"type": "integer",
"description": "The ID of the current warehouse"
},
"newStorageLocationId": {
"type": "integer",
"description": "The ID of the new storage location"
},
"newWarehouseId": {
"type": "integer",
"description": "The ID of the new warehouse"
},
"batch": {
"type": "string",
"description": "The batch of the redistribution optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the redistribution optional"
}
}
}
}
]
}
},
"\/rest\/stockmanagement\/stock\/types\/{type}": {
"get": {
"summary": "List stock by warehouse type",
"description": "Lists stock for all warehouses of the same warehouse type. The name of the type must be specified. Currently the only type available is 'sales'.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Stock",
"items": {
"$ref": "#\/definitions\/Stock"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "type",
"type": "string",
"required": true,
"description": "The name of the warehouse type. Currently only 'sales' is available.",
"format": "string",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to stock with a variation. The id of the variation must be specified.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses": {
"get": {
"summary": "List warehouses",
"description": "Lists warehouses without applying any filters.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "integer",
"required": false,
"description": "Related objects to be loaded. repairWarehouse is the only relation currently available.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a warehouse",
"description": "Creates a warehouse.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Warehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/stockmanagement\/warehouses",
"schema": {
"type": "object",
"required": [
"name",
"typeId",
"logisticsType"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the warehouse"
},
"note": {
"type": "string",
"description": "A note for this warehouse optional"
},
"typeId": {
"type": "integer",
"description": "The id of the warehouse type. The following types are available:\n\n 0 = Sales warehouse\n 1 = Repair warehouse\n 4 = Storage warehouse\n 5 = Transit warehouse\n 6 = Distribution warehouse\n 7 = Other"
},
"onStockAvailability": {
"type": "integer",
"description": "Displayed availability of a variation if stock is available optional"
},
"outOfStockAvailability": {
"type": "integer",
"description": "Displayed availability of a variation if no stock is available optional"
},
"splitByShippingProfile": {
"type": "boolean",
"description": "Flag that indicates if for this warehouse orders are split by shipping profiles or not. True = Orders are split by shipping profiles False = Orders will not be split by shipping profiles optional"
},
"storageLocationType": {
"type": "string",
"description": "The storage location type. The following types are available: none smallmedium large europallet optional"
},
"storageLocationZone": {
"type": "integer",
"description": "The zone that the storage location is in optional"
},
"repairWarehouseId": {
"type": "integer",
"description": "The id of the associated repair warehouse optional"
},
"isInventoryModeActive": {
"type": "boolean",
"description": "Flag that indicates if the inventory mode for this warehouse is active or not. True = active False = inactive optional"
},
"logisticsType": {
"type": "string",
"description": "The id of the logistics type of the warehouse. The logistics type states which service provider fulfills the storage and shipping. The following logistics types are available:\n\nown\namazon\ndhlFulfillment"
}
}
}
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/addresses": {
"post": {
"summary": "Create address for existing warehouse",
"description": "Creates an address for an existing warehouse.",
"tags": [
"Account"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AddressWarehouseRelation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}": {
"get": {
"summary": "Get a warehouse",
"description": "Gets a warehouse. The id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Warehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse to be loaded",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Related objects to be loaded. 'repairWarehouse' is the only relation currently available.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks": {
"get": {
"summary": "List racks",
"description": "Lists racks for a warehouse. The id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Rack",
"items": {
"$ref": "#\/definitions\/Rack"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'shelves' and 'storageLocations'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a rack",
"description": "Creates a rack. The id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Rack"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks\/{rackId}": {
"get": {
"summary": "Get a rack",
"description": "Gets a rack. The id of the rack and the id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Rack"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'shelves' and 'storageLocations'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks\/{rackId}\/shelves": {
"get": {
"summary": "List shelves",
"description": "Lists shelves for a warehouse. The id of the rack and the id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Shelf",
"items": {
"$ref": "#\/definitions\/Shelf"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'storageLocations'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a shelf",
"description": "Creates a shelf. The id of the warehouse and the id of the rack must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Shelf"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks\/{rackId}\/shelves\/{shelfId}": {
"get": {
"summary": "Get a shelf",
"description": "Gets a shelf. The id of the shelf, the id of the rack and the id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Shelf"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "shelfId",
"type": "integer",
"required": true,
"description": "The id of the shelf.",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'storageLocations'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks\/{rackId}\/shelves\/{shelfId}\/storageLocations": {
"get": {
"summary": "List storage locations",
"description": "Lists storage locations. The id of the warehouse, the id of the rack and the id of the shelf must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StorageLocation",
"items": {
"$ref": "#\/definitions\/StorageLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "shelfId",
"type": "integer",
"required": true,
"description": "The id of the shelf.",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a storage location",
"description": "Creates a storage location. The id of the warehouse, the id of the rack and the id of the shelf must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "shelfId",
"type": "integer",
"required": true,
"description": "The id of the shelf.",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/racks\/{rackId}\/shelves\/{shelfId}\/storageLocations\/{storageLocationId}": {
"get": {
"summary": "Get a storage location",
"description": "Gets a storage location. The id of the warehouse, the id of the rack, the id of the shelf and the id of the storage location must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "rackId",
"type": "integer",
"required": true,
"description": "The id of the rack.",
"format": "integer",
"in": "path"
},
{
"name": "shelfId",
"type": "integer",
"required": true,
"description": "The id of the shelf.",
"format": "integer",
"in": "path"
},
{
"name": "storageLocationId",
"type": "integer",
"required": true,
"description": "The id of the storage location.",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/storageLocations": {
"get": {
"summary": "List storage locations",
"description": "Lists storage locations that belong to a warehouse. The id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StorageLocation",
"items": {
"$ref": "#\/definitions\/StorageLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "Number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/management\/storageLocations\/{storageLocationId}": {
"get": {
"summary": "Get a storage location",
"description": "Gets a storage location. The id of the storage location and the id of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The id of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "storageLocationId",
"type": "integer",
"required": true,
"description": "The id of the storage location.",
"format": "integer",
"in": "path"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The attributes to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock": {
"get": {
"summary": "List stock by warehouse",
"description": "Lists stock for a warehouse. The ID of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Stock",
"items": {
"$ref": "#\/definitions\/Stock"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse.",
"format": "integer",
"in": "path"
},
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to stock with a variation. The id of the variation must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/bookIncomingItems": {
"put": {
"summary": "Book incoming stock",
"description": "Books incoming stock for multiple variations. The incoming stock will be added to the existing stock. The ID of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/bookIncomingItems",
"schema": {
"type": "object",
"required": [
"variationId",
"deliveredAt",
"currency",
"quantity",
"reasonId"
],
"properties": {
"incomingItems": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStockIntake"
}
},
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"deliveredAt": {
"type": "string",
"description": "The date when stock was booked in. The date is given in W3C format."
},
"orderNumber": {
"type": "string",
"description": "The order number optional"
},
"currency": {
"type": "string",
"description": "The currency"
},
"quantity": {
"type": "number",
"description": "The quantity of a variation"
},
"purchasePrice": {
"type": "number",
"description": "The purchase price optional"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location optional"
},
"reasonId": {
"type": "integer",
"description": "The ID of the reason. The following IDs are available:\n\n101: Incoming items\n102: Booked in by stocktaking\n104: Rebooked into stock because no production errors were found\n106: Maculation canceled\n107: Packing error, items are re-booked\n109: Incoming items (logistics)\n115: Incoming items (second choice)\n116: Booked in by correction\n117: Unpacked item\n180: Incoming items (purchase order)\n181: Incoming items (warehousing)"
},
"supplierId": {
"type": "integer",
"description": "The ID of the supplier optional"
},
"exchangeRate": {
"type": "number",
"description": "The exchange rate optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
}
}
}
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/bookOutgoingItems": {
"put": {
"summary": "Book outgoing stock",
"description": "Books outgoing stock for multiple variations. The ID of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/bookOutgoingItems",
"schema": {
"type": "object",
"required": [
"variationId",
"deliveredAt",
"currency",
"quantity",
"reasonId"
],
"properties": {
"outgoingItems": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStockDischarge"
}
},
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"deliveredAt": {
"type": "string",
"description": "The date when stock was booked in. The date is given in W3C format."
},
"orderNumber": {
"type": "string",
"description": "The order number optional"
},
"currency": {
"type": "string",
"description": "The currency"
},
"quantity": {
"type": "number",
"description": "The quantity of a variation"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location optional"
},
"reasonId": {
"type": "integer",
"description": "The ID of the reason. The following IDs are available:\n\n201: Outbound items\n202: Outbound inventur\n205: Outbound rubbish\n206: Outbound packing error\n207: Outbound defect\n208: Outbound complaint\n209: Outbound logistic\n214: Outbound warehouse movement\n215: Outbound second choise\n216: Outbound correction\n280: Outbound purchase order\n281: Outbound loss"
},
"supplierId": {
"type": "integer",
"description": "The ID of the supplier optional"
},
"exchangeRate": {
"type": "number",
"description": "The exchange rate optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
}
}
}
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/correction": {
"put": {
"summary": "Correct stock",
"description": "Corrects stock. The ID of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/correction",
"schema": {
"type": "object",
"required": [
"variationId",
"quantity",
"storageLocationId"
],
"properties": {
"corrections": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VariationStockCorrection"
}
},
"variationId": {
"type": "integer",
"description": "The ID of the variation"
},
"quantity": {
"type": "number",
"description": "The quantity of the variation"
},
"storageLocationId": {
"type": "integer",
"description": "The ID of the storage location"
},
"reasonId": {
"type": "integer",
"description": "The reason for correction. The following reasons are available:\n\n301: Stock correction\n302: Stock correction by stocktaking\n304: Stock correction because of manufacturer error\n305: Stock correction because of unusable paper\n306: Stock correction because of packing error\n307: Stock correction because of damage\n309: Stock correction (internal offset)\n317: Stock correction because of BBD\n318: Stock correction because of shipping items to FBA\n319: Stock correction because of shipping items to fulfillment service provider\n320: Stock correction because of sample for interested parties\n321: Stock correction because of sample for customers\n322: Stock correction because of sample\n323: Stock correction because quality models are booked in\n324: Stock correction because quality models are booked out\n325: Stock correction because of gift\n326: Stock correction because of malfunction (without return)\n327: Stock correction because of loss\n328: Stock correction because of unpack\n optional"
},
"batch": {
"type": "string",
"description": "The batch of the variation optional"
},
"bestBeforeDate": {
"type": "string",
"description": "The best before date of the variation optional"
}
}
}
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/movements": {
"get": {
"summary": "List stock movements",
"description": "Lists stock movements for a warehouse. The ID of the warehouse must be specified. To get movements older than 3 months, set the 'year' parameter.\nNOTE: You can either get archive entries or non-archive entries. You can not get entries for the current year that are younger and older than 3 months with one request. You need separate requests to get entries older and younger than 3 months. To get all entries younger than 3 month you do not need to specify a year or any createdAt parameter.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of VariationStockMovement",
"items": {
"$ref": "#\/definitions\/VariationStockMovement"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "path"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "The ID of the variation",
"format": "integer",
"in": "query"
},
{
"name": "itemId",
"type": "integer",
"required": false,
"description": "The ID of the item",
"format": "integer",
"in": "query"
},
{
"name": "createdAtFrom",
"type": "string",
"required": false,
"description": "Get entries with createdAt date after this date",
"format": "string",
"in": "query"
},
{
"name": "createdAtTo",
"type": "string",
"required": false,
"description": "Get entries with createdAt date before this date",
"format": "string",
"in": "query"
},
{
"name": "year",
"type": "integer",
"required": false,
"description": "Get entries from the archive for the given year. All movements older than 3 months are stored in the archive.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": true,
"description": "The requested page. The default page that will be returned is page 1.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": true,
"description": "The number of items per page. The default number per page is 50.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/storageLocations": {
"get": {
"summary": "List stock of a warehouse per storage location",
"description": "Lists stock of a warehouse for each variation and storage location. The stock will only be listed if the stock is positive. Negative stock will not be listed. The ID of the warehouse must be specified.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of StockStorageLocation",
"items": {
"$ref": "#\/definitions\/StockStorageLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "updatedAtFrom",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "updatedAtTo",
"type": "string",
"required": false,
"description": "Filter that restricts the search result to stock that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.",
"format": "string",
"in": "query"
},
{
"name": "variationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to stock with a variation.",
"format": "integer",
"in": "query"
},
{
"name": "storageLocationId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to stock of a storage location.",
"format": "integer",
"in": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "Load additional relations for a StockStorageLocation. Possible values:\n
\n - 'storageLocation' = The storageLocation this stock information belongs to.<\/li>\n <\/ul>\n Example:
?with[]=storageLocation<\/code>",
"format": "integer",
"in": "query"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/unpackVariation": {
"put": {
"summary": "Unpack variation",
"description": "Unpacks a variation.",
"tags": [
"StockManagement"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Warehouse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "VariationStockIntake",
"type": "integer",
"required": true,
"description": "The new item that will be booked in as result of the unpacking",
"format": "integer",
"in": "query"
},
{
"name": "VariationStockCorrection",
"type": "integer",
"required": true,
"description": "The item that is unpacked",
"format": "integer",
"in": "query"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/storage\/frontend\/file": {
"delete": {
"summary": "Remove a single object from frontend storage.",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The key of the object to delete.",
"format": "string",
"in": "query"
}
]
},
"get": {
"summary": "Get file information for a single object in frontend storage. Append public cloudfront url to retrieved object.",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The key of the object to get information about.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Upload a single file to frontend storage.",
"description": "If file is an image, generate a thumbnail and store dimensions in metadata.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The key for the uploaded object.",
"format": "string",
"in": "query"
},
{
"name": "maxAge",
"type": "integer",
"required": false,
"description": "Number of seconds until the content of the file expires.",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/storage\/frontend\/file\/metadata": {
"get": {
"summary": "Get assigend metadata for a single storage object",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The key of the object to get metadata for.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Update metadata of an storage object",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The key of the object to update metadata for.",
"format": "string",
"in": "query"
},
{
"name": "metadata",
"type": "integer",
"required": true,
"description": "The metadata to assign to storage object",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/storage\/frontend\/files": {
"delete": {
"summary": "Delete files from frontend storage.",
"description": "Deletes a list of files from frontend storage. A list of storage keys must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyList",
"type": "integer",
"required": true,
"description": "List of storage keys for the files to be deleted.",
"format": "integer",
"in": "query"
}
]
},
"get": {
"summary": "List files from frontend storage. Append public cloudfront url to each retrieved object.",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "continuationToken",
"type": "string",
"required": false,
"description": "The continuationToken<\/code> of a previous request to continue listing objects with.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/frontend\/object-url": {
"get": {
"summary": "Get the URL for a layout document",
"description": "Gets the URL of a layout document. The storage key must be specified. The returned URL expires after 10 minutes.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The storage key for the frontend document to retrieve the URL for. Include the storage key in the request in a key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/layout": {
"delete": {
"summary": "Delete layout documents",
"description": "Deletes a list of layout documents from storage. A list of storage keys must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/bool"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyList",
"type": "integer",
"required": true,
"description": "List of storage keys for the files to be deleted.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Upload a layout document",
"description": "Uploads a layout document to storage. The storage key (i.e. file path) must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageObject"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The storage key for the layout document to upload. Include the storage key (i.e. file path) in the request in a key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/layout\/list": {
"get": {
"summary": "List layout documents",
"description": "Lists up to 1000 layout documents per request. If more than 1000 layout documents are available,\na nextContinuationToken<\/code> is returned. Use this token to get the next (up to) 1000 layout documents.\nUse the same request and include a field with the key continuationToken<\/code> as well as the returned\ntoken from the previous call as the value.\n\nCheck the isTruncated<\/code> field in the response to see if more results are available. If isTruncated<\/code> is true,\nrepeat the request using the token from the nextContinuationToken<\/code> field of the previous response to get all\nresults.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageObjectList"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "continuationToken",
"type": "string",
"required": false,
"description": "Token for listing the next (up to) 1000 layout documents.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/layout\/object-url": {
"get": {
"summary": "Get the URL for a layout document",
"description": "Gets the URL of a layout document. The storage key must be specified. The returned URL expires after 10 minutes.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The storage key for the layout document to retrieve the URL for. Include the storage key in the request in a key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/order-properties\/object-url": {
"get": {
"summary": "Get the URL for a order property file",
"description": "Gets the URL of a order property file. The storage key must be specified. The returned URL expires after 10\nminutes.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The storage key for the order property\n * file to retrieve the URL for. Include the storage key in the request in a\n * key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/plugins\/inbox": {
"delete": {
"summary": "Delete files from the inbox",
"description": "Deletes a list of files from the inbox. A list of storage keys must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "keyList",
"type": "integer",
"required": true,
"description": "List of storage keys for the files to be deleted.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Upload a file to the inbox",
"description": "Uploads a file to the inbox. The storage key (i.e. file path) must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageObject"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": true,
"description": "The storage key for the file to upload. Include the storage key in the request in a key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/plugins\/inbox\/commit": {
"post": {
"summary": "",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/storage\/plugins\/inbox\/list": {
"get": {
"summary": "List files from the inbox",
"description": "Lists all files of all plugins stored in the inbox. A prefix can be specified to list all files of a specific\nplugin folder only.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/StorageObjectList"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "prefix",
"type": "string",
"required": false,
"description": "Prefix to list all files of a specific plugin folder only. The prefix also means the plugin path. The prefix<\/code> key with the value PluginA\/src\/<\/code> will only return files in the src<\/b> folder of PluginA<\/b>.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/storage\/plugins\/inbox\/object-url": {
"get": {
"summary": "Get the content of a file from the inbox",
"description": "Gets the content of a file stored in the inbox. The storage key (i.e. file path) must be specified.",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "key",
"type": "string",
"required": false,
"description": "The storage key for the file to retrieve. Include the storage key in the request in a key<\/code> field.",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/stores\/{plentyId}\/locations": {
"get": {
"summary": "Get the ID of an accounting location of a country",
"description": "Gets the ID of an accounting location of a country. The plenty ID of the client and the ID of the country must be specified.",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/AccountingLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "countryId",
"type": "integer",
"required": false,
"description": "The ID of the country of the accounting location. The default accounting location of the client will be returned if the ID of a country is not specified.",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/system\/cloud\/metrics": {
"get": {
"summary": "Get the cloud metrics for this system",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/CloudMetricsList"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/system\/metrics\/{plentyId}\/{date}": {
"get": {
"summary": "Supply usage data for given plentymarkets system",
"description": "",
"tags": [
"Cloud"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "plentyId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "date",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/system\/settings\/taric_vat_assignment": {
"get": {
"summary": "List taric vat assignments",
"description": "",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of TaricVatAssignment",
"items": {
"$ref": "#\/definitions\/TaricVatAssignment"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page of results",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of results per page",
"format": "integer",
"in": "query"
},
{
"name": "countryId",
"type": "integer",
"required": false,
"description": "The country ID of the taric vat assignments",
"format": "integer",
"in": "query"
},
{
"name": "taricCode",
"type": "integer",
"required": false,
"description": "The taric code of the taric vat assignments",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/system\/settings\/taric_vat_assignment\/{taricCode}\/{countryId}": {
"delete": {
"summary": "Delete taric vat assignment",
"description": "Deletes a taric code. The taric code and the country ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "taricCode",
"type": "string",
"required": true,
"description": "The taric code.",
"format": "string",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The country id.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/system\/settings\/taric_vat_assignment\/{taricCode}\/{countryId}",
"schema": {
"type": "object",
"required": [
"taricCode",
"countryId"
],
"properties": {
"taricCode": {
"type": "integer",
"description": "The taric code matching to \/^[0-9a-z]{1,12}$\/"
},
"countryId": {
"type": "integer",
"description": "The ID of the country that the taric code configuration belongs to"
}
}
}
}
]
},
"get": {
"summary": "Get taric vat assignment",
"description": "Gets a taric vat assignment. The taric code and the country ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TaricVatAssignment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "taricCode",
"type": "string",
"required": true,
"description": "The taric code.",
"format": "string",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The country id.",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create taric vat assignment",
"description": "Creates a taric vat assignment. The taric code and the country ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TaricVatAssignment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "taricCode",
"type": "string",
"required": true,
"description": "The taric code.",
"format": "string",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The country id.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/system\/settings\/taric_vat_assignment\/{taricCode}\/{countryId}",
"schema": {
"type": "object",
"required": [
"taricCode",
"countryId",
"vatField"
],
"properties": {
"taricCode": {
"type": "integer",
"description": "The taric code matching to \/^[0-9a-z]{1,12}$\/"
},
"countryId": {
"type": "integer",
"description": "The ID of the country that the taric code configuration belongs to"
},
"vatField": {
"type": "string",
"description": "The ID of the VAT rate of the taric code \/ country id combination. allowed values are 0, 1, 2, 3"
}
}
}
}
]
},
"put": {
"summary": "Update taric vat assignment",
"description": "Updates a taric vat assignment. The taric code and the country ID must be specified.",
"tags": [
"Order"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TaricVatAssignment"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "taricCode",
"type": "string",
"required": true,
"description": "The taric code.",
"format": "string",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The country id.",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/system\/settings\/taric_vat_assignment\/{taricCode}\/{countryId}",
"schema": {
"type": "object",
"required": [
"taricCode",
"countryId",
"vatField"
],
"properties": {
"taricCode": {
"type": "integer",
"description": "The taric code matching to \/^[0-9a-z]{1,12}$\/"
},
"countryId": {
"type": "integer",
"description": "The ID of the country that the taric code configuration belongs to"
},
"vatField": {
"type": "string",
"description": "The ID of the VAT rate of the taric code \/ country id combination. allowed values are 0, 1, 2, 3"
}
}
}
}
]
}
},
"\/rest\/tags": {
"get": {
"summary": "List tags",
"description": "Lists all tags. The results can be filtered.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified tag information in the results. The following parameters are available: - availabilities = The tag availabilities<\/li>
- names = The tag names<\/li>
- relationship = The tag relationships<\/li><\/ul>More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "tagName",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to tags with the specified tag name. The tag name must be specified.",
"format": "string",
"in": "query"
},
{
"name": "tagAvailability",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to tags with the specified availability type. The availability type must be specified.",
"format": "string",
"in": "query"
},
{
"name": "tagLang",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to tags which have names in the specified language. The language must be specified.",
"format": "string",
"in": "query"
},
{
"name": "color",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to tags with the specified color. The color must be specified.",
"format": "string",
"in": "query"
}
]
},
"post": {
"summary": "Create a tag",
"description": "",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Tag"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/tags",
"schema": {
"type": "object",
"required": [
"tagName",
"tagType",
"names",
"tagLang"
],
"properties": {
"tagName": {
"type": "string",
"description": "The name of the tag."
},
"color": {
"type": "string",
"description": "The color for the tag optional"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagAvailability"
}
},
"tagType": {
"type": "string",
"description": "The type of the tag. The following types are available.\n\nblog\ncategory\ncontent_page\nvariation\nticket\nboard\norder\n allowed values are category, ticket, variation, board, contact, order, messenger, messageBillable"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagName"
}
},
"tagLang": {
"type": "string",
"description": "The lang of the tag name. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn"
}
}
}
}
]
}
},
"\/rest\/tags\/bulk": {
"post": {
"summary": "Create up to 50 tags",
"description": "Creates up to 50 tags. The IDs of the tags must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/tags\/bulk",
"schema": {
"type": "object",
"required": [
"tagName",
"tagType",
"names",
"tagLang"
],
"properties": {
"tagName": {
"type": "string",
"description": "The name of the tag."
},
"color": {
"type": "string",
"description": "The color for the tag optional"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagAvailability"
}
},
"tagType": {
"type": "string",
"description": "The type of the tag. The following types are available.\n\nblog\ncategory\ncontent_page\nvariation\nticket\nboard\norder\n allowed values are category, ticket, variation, board, contact, order, messenger, messageBillable"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagName"
}
},
"tagLang": {
"type": "string",
"description": "The lang of the tag name. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn"
}
}
}
}
]
},
"put": {
"summary": "Update up to 50 tags",
"description": "Updates up to 50 tags. The IDs of the tags must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/tags\/bulk",
"schema": {
"type": "object",
"required": [
"tagName",
"tagType",
"names",
"tagLang"
],
"properties": {
"tagName": {
"type": "string",
"description": "The name of the tag."
},
"color": {
"type": "string",
"description": "The color for the tag optional"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagAvailability"
}
},
"tagType": {
"type": "string",
"description": "The type of the tag. The following types are available.\n\nblog\ncategory\ncontent_page\nvariation\nticket\nboard\norder\n allowed values are category, ticket, variation, board, contact, order, messenger, messageBillable"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagName"
}
},
"tagLang": {
"type": "string",
"description": "The lang of the tag name. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn"
}
}
}
}
]
}
},
"\/rest\/tags\/relationships": {
"delete": {
"summary": "Delete tag relationships",
"description": "Deletes a list of tag relationships. The tag ID, tag type and relation value must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"get": {
"summary": "List relationships",
"description": "Lists all relationships. The results can be filtered.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "with",
"type": "string",
"required": false,
"description": "Includes the specified tag information in the results. The following parameters are available:
- availability = The tag availability<\/li>
- tag = The tag<\/li><\/ul>More than one parameter should be separated by commas.",
"format": "string",
"in": "query"
},
{
"name": "tagId",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to tag relationships with the specified tag ID. The tag ID must be specified.",
"format": "integer",
"in": "query"
},
{
"name": "tagType",
"type": "string",
"required": false,
"description": "Filter restricts the list of results to tag relationships with the specified tag type. The tag type must be specified.",
"format": "string",
"in": "query"
},
{
"name": "relationshipValue",
"type": "integer",
"required": false,
"description": "Filter restricts the list of results to tag relationships with the specified relationship value. This is the ID of the data record. The relationship value must be specified.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create tag relationship",
"description": "Creates a tag relationship by linking a tag to a data record.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TagRelationship"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "tagId",
"type": "integer",
"required": false,
"description": "The ID of the tag.",
"format": "integer",
"in": "query"
},
{
"name": "tagType",
"type": "string",
"required": false,
"description": "The type of tag. Allowed values are category, ticket, variation, board, contact.",
"format": "string",
"in": "query"
},
{
"name": "relationshipValue",
"type": "integer",
"required": false,
"description": "The ID of the data record for which a tag relationship is created.",
"format": "integer",
"in": "query"
},
{
"name": "relatonshipUUID5",
"type": "string",
"required": false,
"description": "The ID of the data record for which a tag relationship is created. For models with uuid5 as primary key.",
"format": "string",
"in": "query"
},
{
"in": "body",
"name": "\/rest\/tags\/relationships",
"schema": {
"type": "object",
"required": [
"tagId",
"tagType",
"relationshipValue"
],
"properties": {
"tagId": {
"type": "integer",
"description": "The ID of the tag"
},
"tagType": {
"type": "string",
"description": "The type of tag. allowed values are category, ticket, variation, board, contact, order, messenger, messageBillable"
},
"relationshipValue": {
"type": "integer",
"description": "The ID of the data record for which a tag relationship is created"
},
"relationshipUUID5": {
"type": "string",
"description": "The ID of the data record for which a tag relationship is created. For models with uuid5 as primary key optional"
}
}
}
}
]
}
},
"\/rest\/tags\/relationships\/{relationshipValue}\/{tagType}\/{id}": {
"delete": {
"summary": "Delete tag relationship",
"description": "Deletes a specific tag relationship that matches the specified data.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationshipValue",
"type": "integer",
"required": true,
"description": "The value of the relationship. This value is the ID of the data record the tag is linked to, e.g. item ID 1234.",
"format": "integer",
"in": "path"
},
{
"name": "relationshipType",
"type": "string",
"required": true,
"description": "The type of the relationship, e.g. category<\/b>, item<\/b> or ticket<\/b>",
"format": "string",
"in": "query"
},
{
"name": "tagType",
"type": "string",
"required": true,
"description": "The type of the tag",
"format": "string",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the tag",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update tag relationship",
"description": "Updates a tag relationship.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TagRelationship"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "relationshipValue",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "tagType",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "id",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/tags\/{id}": {
"delete": {
"summary": "Delete tag",
"description": "Deletes a tag. The ID of the tag must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the tag",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get tag by ID",
"description": "Gets a tag by the ID. The ID of the tag must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Tag"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the tag",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update tag",
"description": "Updates a tag. The ID of the tag must be specified.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Tag"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the tag",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/tags\/{id}",
"schema": {
"type": "object",
"required": [
"tagName",
"tagType",
"names",
"tagLang"
],
"properties": {
"tagName": {
"type": "string",
"description": "The name of the tag."
},
"color": {
"type": "string",
"description": "The color for the tag optional"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagAvailability"
}
},
"tagType": {
"type": "string",
"description": "The type of the tag. The following types are available.\n\nblog\ncategory\ncontent_page\nvariation\nticket\nboard\norder\n allowed values are category, ticket, variation, board, contact, order, messenger, messageBillable"
},
"names": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TagName"
}
},
"tagLang": {
"type": "string",
"description": "The lang of the tag name. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn"
}
}
}
}
]
}
},
"\/rest\/tags\/{id}\/relationships\/{tagType}\/{relationshipUUID}": {
"delete": {
"summary": "Delete tag relationship",
"description": "Deletes a specific tag relationship that matches the specified data.",
"tags": [
"Tag"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/DeleteResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": true,
"description": "The ID of the tag",
"format": "integer",
"in": "path"
},
{
"name": "tagType",
"type": "string",
"required": true,
"description": "The type of the relationship, i.e. board<\/b>",
"format": "string",
"in": "path"
},
{
"name": "relationshipUUID",
"type": "string",
"required": true,
"description": "The UUID of the relationship",
"format": "string",
"in": "path"
}
]
}
},
"\/rest\/tickets": {
"get": {
"summary": "List tickets by filters",
"description": "Lists the tickets by filters.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Ticket",
"items": {
"$ref": "#\/definitions\/Ticket"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "id",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets of a specific ticket ID",
"format": "integer",
"in": "query"
},
{
"name": "typeId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets of specific ticket types",
"format": "integer",
"in": "query"
},
{
"name": "priorityId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets of a specific ticket priority ID",
"format": "integer",
"in": "query"
},
{
"name": "parentTicketId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified parent ticket ID",
"format": "integer",
"in": "query"
},
{
"name": "statusId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified status ID",
"format": "integer",
"in": "query"
},
{
"name": "confidential",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets of a specific confidential value",
"format": "integer",
"in": "query"
},
{
"name": "contactId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified contact ID",
"format": "integer",
"in": "query"
},
{
"name": "deadlineAt",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified deadline. Valid date formats are 'yyyy-mm-dd hh-mm-ss' or 'yyyy-mm-dd'.",
"format": "integer",
"in": "query"
},
{
"name": "title",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified phrase in title",
"format": "integer",
"in": "query"
},
{
"name": "progress",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified progress in percent",
"format": "integer",
"in": "query"
},
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified client (store) ID",
"format": "integer",
"in": "query"
},
{
"name": "source",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specific source value",
"format": "integer",
"in": "query"
},
{
"name": "statusGroupId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified status group ID",
"format": "integer",
"in": "query"
},
{
"name": "roleId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified role ID",
"format": "integer",
"in": "query"
},
{
"name": "ownerId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified owner ID",
"format": "integer",
"in": "query"
},
{
"name": "fulltext",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with full-text search. The search includes id, typeId, priorityId, title, source and the contact's firstName and lastName.",
"format": "integer",
"in": "query"
},
{
"name": "customerClassId",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified customer class ID",
"format": "integer",
"in": "query"
},
{
"name": "resubmissionAt",
"type": "integer",
"required": false,
"description": "Filter that restricts the search result to tickets with a specified resubmission date. Valid date formats are 'yyyy-mm-dd hh-mm-ss' or 'yyyy-mm-dd'.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create ticket",
"description": "Creates a ticket.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Ticket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/tickets",
"schema": {
"type": "object",
"required": [
"typeId",
"statusId",
"title",
"plentyId",
"source",
"owners",
"userId",
"roleId"
],
"properties": {
"typeId": {
"type": "integer",
"description": "The type ID of the ticket"
},
"priorityId": {
"type": "integer",
"description": "The priority ID of the ticket optional"
},
"parentTicketId": {
"type": "integer",
"description": "The ID of the parent ticket optional"
},
"statusId": {
"type": "integer",
"description": "The status ID of the ticket"
},
"confidential": {
"type": "array",
"items": {}
},
"contactId": {
"type": "integer",
"description": "The ID of the contact that is linked with the ticket optional"
},
"contactLastUpdateAt": {
"type": "string",
"description": "The time the contact was last updated optional"
},
"deadlineAt": {
"type": "string",
"description": "The date of the ticket deadline optional"
},
"title": {
"type": "string",
"description": "The title of the ticket"
},
"plentyId": {
"type": "integer",
"description": "The ID of the client (store)"
},
"source": {
"type": "array",
"items": {}
},
"documentsCount": {
"type": "integer",
"description": "The number of documents that are attached to the ticket optional"
},
"orderId": {
"type": "integer",
"description": "The ID of the order linked with the ticket optional"
},
"hasDocuments": {
"type": "integer",
"description": "Displays 1 if the ticket has one or more documents. Displays 0 if the ticket has no document. optional"
},
"resubmissionAt": {
"type": "string",
"description": "The date the ticket should be resubmitted optional"
},
"owners": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketOwner"
}
},
"userId": {
"type": "integer",
"description": "The user ID of the owner"
},
"roleId": {
"type": "integer",
"description": "The role ID of the owner"
}
}
}
}
]
}
},
"\/rest\/tickets\/messages\/{messageId}": {
"get": {
"summary": "Get ticket message for given message ID",
"description": "Gets a ticket message. The ID of the message must be specified.",
"tags": [
"TicketMessage"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TicketMessage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "messageId",
"type": "integer",
"required": true,
"description": "The ID of the ticket message to be returned",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/tickets\/status\/names": {
"get": {
"summary": "List status names",
"description": "Lists status names.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketStatusName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/tickets\/status\/type\/names": {
"get": {
"summary": "List status names with typeId",
"description": "Lists status names with typeId.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketStatusName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/tickets\/types\/names": {
"get": {
"summary": "List type names",
"description": "Lists all type names.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketTypeName"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/tickets\/{ticketId}": {
"get": {
"summary": "Get ticket",
"description": "Gets the ticket. The ID of the ticket must be specified.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Ticket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket to be loaded.",
"format": "integer",
"in": "path"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "An array with relations to be loaded with the ticket. Possible values are 'order' and 'contact'",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create message",
"description": "Creates a message for the ticket. The ID of the ticket must be specified.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/TicketMessage"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update ticket",
"description": "Updates a ticket. The ID of the ticket must be specified.",
"tags": [
"Ticket"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Ticket"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/tickets\/{ticketId}\/messages": {
"get": {
"summary": "List all ticket messages for given ticket ID",
"description": "Lists all ticket messages. The ID of the ticket must be specified.",
"tags": [
"TicketMessage"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketMessage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket containing the messages",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/tickets\/{ticketId}\/messages\/comment": {
"get": {
"summary": "List all internal ticket messages",
"description": "Lists all internal ticket messages. The ID of the ticket must be specified. When type = 'comment', the message is internal.",
"tags": [
"TicketMessage"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketMessage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket containing the messages",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/tickets\/{ticketId}\/messages\/message": {
"get": {
"summary": "List all public ticket messages",
"description": "Lists all public ticket messages. The ID of the ticket must be specified. When type = 'message', the message is public.",
"tags": [
"TicketMessage"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketMessage"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "ticketId",
"type": "integer",
"required": true,
"description": "The ID of the ticket containing the messages",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/user": {
"get": {
"summary": "User",
"description": "The user call returns a JSON object that contains information about the currently logged in API-User.",
"tags": [
"Authentication"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/User"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/user\/authorized_user_with_ui_config": {
"get": {
"summary": "Get authorized user with UiConfig",
"description": "Gets an authorized user with UiConfig. This call returns a JSON object with information about the user after login. This information is used for correctly displaying the plentymarkets back end.",
"tags": [
"Authorization"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/JsonResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/user\/backend_pluginset": {
"get": {
"summary": "get the backend plugin set for user",
"description": "",
"tags": [
"User"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
},
"post": {
"summary": "set the backend plugin set for user",
"description": "",
"tags": [
"User"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/user\/pin_users": {
"get": {
"summary": "get all User with a secret value",
"description": "",
"tags": [
"User"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/users\/me": {
"get": {
"summary": "Get authorized user",
"description": "Gets an authorized user. This call returns a JSON object with information about the user after login. This information is used for correctly displaying the plentymarkets back end.",
"tags": [
"Authorization"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/JsonResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/vat": {
"get": {
"summary": "List VAT configurations.",
"description": "Lists the VAT configurations for the given filter. Possible filters are
locationId<\/code>, countryId<\/code>, taxIdNumber<\/code> and startedAt<\/code>.",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of Vat",
"items": {
"$ref": "#\/definitions\/Vat"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "page",
"type": "integer",
"required": false,
"description": "The requested page.",
"format": "integer",
"in": "query"
},
{
"name": "itemsPerPage",
"type": "integer",
"required": false,
"description": "The number of items per page.",
"format": "integer",
"in": "query"
},
{
"name": "with",
"type": "integer",
"required": false,
"description": "The relations to load with the VAT object. The relations available are location or country.",
"format": "integer",
"in": "query"
},
{
"name": "columns",
"type": "integer",
"required": false,
"description": "The properties to be loaded.",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a VAT configuration",
"description": "",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Vat"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"in": "body",
"name": "\/rest\/vat",
"schema": {
"type": "object",
"required": [
"countryId",
"locationId",
"startedAt",
"vatRates",
"id",
"vatRate"
],
"properties": {
"countryId": {
"type": "integer",
"description": "The ID of the country that the VAT configuration belongs to"
},
"locationId": {
"type": "integer",
"description": "The ID of the location"
},
"taxIdNumber": {
"type": "string",
"description": "The tax id number of VAT configuration."
},
"startedAt": {
"type": "string",
"description": "The date when the VAT configuration went into effect"
},
"invalidFrom": {
"type": "string",
"description": "The date when the VAT configuration should not be used any more"
},
"isRestrictedToDigitalItems": {
"type": "boolean",
"description": "Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods."
},
"marginScheme": {
"type": "string",
"description": "Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'. allowed values are none, vat0, vat1, vat2, vat3"
},
"vatRates": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VatRate"
}
},
"id": {
"type": "integer",
"description": "The ID of the VAT rate allowed values are 0, 1, 2, 3"
},
"name": {
"type": "string",
"description": "The name of a VAT rate"
},
"vatRate": {
"type": "number",
"description": "The percentage of the VAT rate, e.g. 19.00 for 19 %"
}
}
}
}
]
}
},
"\/rest\/vat\/locations\/{locationId}": {
"get": {
"summary": "List VAT configurations of an accounting location",
"description": "Lists the VAT configurations for all countries of one accounting location",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Collection"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "locationId",
"type": "integer",
"required": true,
"description": "The ID of the accounting location",
"format": "integer",
"in": "path"
},
{
"name": "with[]",
"type": "integer",
"required": false,
"description": "The relations to load with the VAT object. The relations available are location and country.",
"format": "integer",
"in": "query"
},
{
"name": "columns[]",
"type": "integer",
"required": false,
"description": "The attributes of the VAT configuration",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/vat\/locations\/{locationId}\/countries\/{countryId}": {
"get": {
"summary": "List VAT configurations for one country of delivery",
"description": "Lists the VAT configurations for a country of delivery of one accounting location. The ID of the accounting location and the ID of the country of delivery must be specified.",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Vat"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "locationId",
"type": "integer",
"required": true,
"description": "The ID of the accounting location",
"format": "integer",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The ID of the country of delivery",
"format": "integer",
"in": "path"
},
{
"name": "with[]",
"type": "integer",
"required": false,
"description": "The relations to load with the VAT object. The relations available are location or country.",
"format": "integer",
"in": "query"
},
{
"name": "columns[]",
"type": "integer",
"required": false,
"description": "The attributes of the VAT configuration",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/vat\/locations\/{locationId}\/countries\/{countryId}\/date\/{date}": {
"get": {
"summary": "Get a VAT configuration for a country in a location.",
"description": "Gets the VAT configuration found by matching the given location, delivery country and date of validity.",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Vat"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "locationId",
"type": "integer",
"required": true,
"description": "The ID of the accounting location",
"format": "integer",
"in": "path"
},
{
"name": "countryId",
"type": "integer",
"required": true,
"description": "The ID of the country of delivery",
"format": "integer",
"in": "path"
},
{
"name": "startDate",
"type": "string",
"required": true,
"description": "The date of validity",
"format": "string",
"in": "query"
},
{
"name": "with[]",
"type": "integer",
"required": false,
"description": "The relations to load with the VAT object. The relations available are location or country.",
"format": "integer",
"in": "query"
},
{
"name": "columns[]",
"type": "integer",
"required": false,
"description": "The attributes of the VAT configuration",
"format": "integer",
"in": "query"
},
{
"name": "date",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/vat\/standard": {
"get": {
"summary": "Get a VAT configuration for the standard accounting location of a client",
"description": "Gets the VAT configuration currently used for the country of the standard accounting location of a client (store). The ID of the client (store) must be specified.",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Vat"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "plentyId",
"type": "integer",
"required": false,
"description": "The plenty ID of the client (store)",
"format": "integer",
"in": "query"
},
{
"name": "startedAt",
"type": "string",
"required": false,
"description": "The date in the W3C format when the vat configuration went into effect",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/vat\/{vatId}": {
"get": {
"summary": "Get a VAT configuration by id",
"description": "",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Vat"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "vatId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a VAT configuration",
"description": "",
"tags": [
"Accounting"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Vat"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "vatId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"in": "body",
"name": "\/rest\/vat\/{vatId}",
"schema": {
"type": "object",
"required": [
"id"
],
"properties": {
"countryId": {
"type": "integer",
"description": "The ID of the country that the VAT configuration belongs to"
},
"locationId": {
"type": "integer",
"description": "The ID of the location"
},
"taxIdNumber": {
"type": "string",
"description": "The tax id number of VAT configuration."
},
"startedAt": {
"type": "string",
"description": "The date when the VAT configuration went into effect"
},
"invalidFrom": {
"type": "string",
"description": "The date when the VAT configuration should not be used any more"
},
"isRestrictedToDigitalItems": {
"type": "boolean",
"description": "Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods."
},
"marginScheme": {
"type": "string",
"description": "Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'. allowed values are none, vat0, vat1, vat2, vat3"
},
"vatRates": {
"type": "array",
"items": {
"$ref": "#\/definitions\/VatRate"
}
},
"id": {
"type": "integer",
"description": "The ID of the VAT rate allowed values are 0, 1, 2, 3"
},
"name": {
"type": "string",
"description": "The name of a VAT rate"
},
"vatRate": {
"type": "number",
"description": "The percentage of the VAT rate, e.g. 19.00 for 19 %"
}
}
}
}
]
}
},
"\/rest\/warehouses\/layouts": {
"post": {
"summary": "Create a warehouse location layout",
"description": "Creates a warehouse location layout",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "parentId",
"type": "integer",
"required": true,
"description": "The parent ID of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The warehouse ID of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "level",
"type": "integer",
"required": true,
"description": "The level of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "shortcut",
"type": "string",
"required": true,
"description": "The shortcut of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "separator",
"type": "string",
"required": true,
"description": "The separator of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "isActiveForPickupPath",
"type": "integer",
"required": true,
"description": "Active flag for pickup path of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "dimensionId",
"type": "integer",
"required": true,
"description": "The warehouse location dimension ID of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "levelId",
"type": "integer",
"required": true,
"description": "The warehouse location level ID of the warehouse location",
"format": "integer",
"in": "query"
},
{
"name": "label",
"type": "string",
"required": true,
"description": "The label of the warehouse location",
"format": "string",
"in": "query"
},
{
"name": "purposeKey",
"type": "string",
"required": true,
"description": "The location type key of the warehouse location",
"format": "string",
"in": "query"
},
{
"name": "statusKey",
"type": "string",
"required": true,
"description": "The location status key of the warehouse location",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations": {
"delete": {
"summary": "Delete multiple warehouse locations",
"description": "Deletes multiple warehouse locations",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationIds",
"type": "integer",
"required": true,
"description": "An array containing all the ID's for the warehouse locations that need to be deleted",
"format": "integer",
"in": "query"
}
]
},
"post": {
"summary": "Create a warehouse location",
"description": "Creates a warehouse location.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "levelId",
"type": "integer",
"required": true,
"description": "The warehouse location level ID of the warehouse location",
"format": "integer",
"in": "query"
},
{
"name": "label",
"type": "string",
"required": true,
"description": "The label of the warehouse location",
"format": "string",
"in": "query"
},
{
"name": "purposeKey",
"type": "string",
"required": true,
"description": "The location type key of the warehouse location",
"format": "string",
"in": "query"
},
{
"name": "statusKey",
"type": "string",
"required": true,
"description": "The location status key of the warehouse location",
"format": "string",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the warehouse location",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/availability\/{warehouseLocationId}": {
"get": {
"summary": "Get availability for storage location",
"description": "Gets availability for storage location",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/locations\/details": {
"get": {
"summary": "Get warehouse location details",
"description": "Gets warehouse location details",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/string"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/warehouses\/locations\/dimensions": {
"post": {
"summary": "Create a warehouse location dimension",
"description": "Creates a warehouse location dimension.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "parentId",
"type": "integer",
"required": true,
"description": "The parent ID of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The warehouse ID of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "level",
"type": "integer",
"required": true,
"description": "The level of the warehouse location dimension",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "shortcut",
"type": "string",
"required": true,
"description": "The shortcut of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "separator",
"type": "string",
"required": true,
"description": "The separator of the warehouse location dimension",
"format": "string",
"in": "query"
},
{
"name": "isActiveForPickupPath",
"type": "integer",
"required": true,
"description": "Active flag for pickup path of the warehouse location dimension",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/dimensions\/{warehouseLocationDimensionId}": {
"delete": {
"summary": "Delete a warehouse location dimension",
"description": "Deletes a warehouse location dimension",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationDimensionId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location dimension",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a warehouse location dimension",
"description": "Gets a warehouse location dimension by ID. The warehouse location ID is required.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationDimensionId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location dimension",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a warehouse location dimension",
"description": "Updates a warehouse location dimension",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationDimensionId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location dimension",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/locations\/group": {
"put": {
"summary": "Edit the purpose and status for a group of storage locations",
"description": "Edits the purpose and status for a group of storage locations by passing the group storage location ID (can be sent as mass assignment)",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WarehouseLocation"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "purpose",
"type": "string",
"required": true,
"description": "The purpose key value for warehouse location purposeKey field",
"format": "string",
"in": "query"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "The status key value for warehouse location status field",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/levels": {
"post": {
"summary": "Create a warehouse location level",
"description": "Creates a warehouse location level.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationLevel"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "parentId",
"type": "integer",
"required": true,
"description": "The parent ID of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "dimensionId",
"type": "integer",
"required": true,
"description": "The warehouse location dimension ID of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "position",
"type": "integer",
"required": true,
"description": "The position of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the warehouse location level",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/levels\/positions": {
"post": {
"summary": "Move a warehouse location level position",
"description": "Moves a warehouse location level position",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "toMove",
"type": "integer",
"required": true,
"description": "The warehouse location level ID that needs needs to be moved",
"format": "integer",
"in": "query"
},
{
"name": "target",
"type": "integer",
"required": true,
"description": "The warehouse location level ID that stands as position for the warehouse location level that needs to be moved",
"format": "integer",
"in": "query"
},
{
"name": "side",
"type": "string",
"required": true,
"description": "The actual position from the left or right side of target",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/levels\/{warehouseLocationLevelId}": {
"delete": {
"summary": "Delete a warehouse location level",
"description": "Deletes a warehouse location level",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationLevelId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location level",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a warehouse location level",
"description": "Gets a warehouse location level by ID. The warehouse location ID is required.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationLevel"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationLevelId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location level",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a warehouse location level",
"description": "Updates a warehouse location level",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationLevel"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationLevelId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location level",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/locations\/multiple_dimensions": {
"post": {
"summary": "Create multiple warehouse location dimensions",
"description": "Creates multiple warehouse location dimension.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "dimensions",
"type": "integer",
"required": true,
"description": "The dimensions array that contains data for creating multiple dimensions",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/positions": {
"post": {
"summary": "Move a warehouse location position",
"description": "Moves a warehouse location position",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "toMove",
"type": "integer",
"required": true,
"description": "The warehouse location ID that needs needs to be moved",
"format": "integer",
"in": "query"
},
{
"name": "target",
"type": "integer",
"required": true,
"description": "The warehouse location ID that stands as position for the warehouse location that needs to be moved",
"format": "integer",
"in": "query"
},
{
"name": "side",
"type": "string",
"required": true,
"description": "The actual position from the left or right side of target",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/previews": {
"post": {
"summary": "Generate warehouse location preview and saves it",
"description": "Generates warehouse location preview and saves it",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "dimensions",
"type": "integer",
"required": true,
"description": "The warehouse location dimensions used by the generator",
"format": "integer",
"in": "query"
},
{
"name": "storageLocationData",
"type": "integer",
"required": true,
"description": "The warehouse location data used by the generator",
"format": "integer",
"in": "query"
},
{
"name": "levelData",
"type": "integer",
"required": true,
"description": "The warehouse location level data used by the generator",
"format": "integer",
"in": "query"
},
{
"name": "save",
"type": "integer",
"required": true,
"description": "The save parameter that triggers the preview method or the process save method",
"format": "integer",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/stock\/{warehouseLocationId}": {
"get": {
"summary": "List warehouse locations stock",
"description": "Lists all warehouse locations stock.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of WarehouseLocation",
"items": {
"$ref": "#\/definitions\/WarehouseLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "$warehouseLocationId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "query"
},
{
"name": "warehouseLocationId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/locations\/{warehouseId}\/label": {
"post": {
"summary": "Generate the warehouse location label",
"description": "Generates the warehouse location label",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The actual warehouse ID",
"format": "integer",
"in": "path"
},
{
"name": "warehouseLocationIds",
"type": "string",
"required": true,
"description": "A string with all warehouse location ID's for which a label needs to be generated",
"format": "string",
"in": "query"
}
]
}
},
"\/rest\/warehouses\/locations\/{warehouseLocationId}": {
"delete": {
"summary": "Delete a warehouse location",
"description": "Deletes a warehouse location",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a warehouse location",
"description": "Gets a warehouse location by ID. The warehouse location ID is required.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a warehouse location",
"description": "Updates a warehouse location",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocation"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseLocationId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/structure\/{warehouseId}": {
"get": {
"summary": "Get a warehouse location structure",
"description": "Gets a warehouse location structure by warehouse ID. The warehouse ID is required.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The actual warehouse ID",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/structure\/{warehouseId}\/moving": {
"get": {
"summary": "Get a warehouse location structure moving",
"description": "Gets a warehouse location structure moving by warehouse ID. The warehouse ID is required.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The actual warehouse ID",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/{warehouseId}\/locations": {
"get": {
"summary": "List warehouse locations",
"description": "Lists all warehouse locations.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page of the response"
},
"totalsCount": {
"type": "integer",
"description": "The total number of entries in the response"
},
"isLastPage": {
"type": "boolean",
"description": "Flag that indicates if the page shown is the last page of the response"
},
"lastPageNumber": {
"type": "integer",
"description": "The last page number"
},
"firstOnPage": {
"type": "integer",
"description": "The index of the first item of the current page result"
},
"lastOnPage": {
"type": "integer",
"description": "The index of the last item of the current page result"
},
"itemsPerPage": {
"type": "integer",
"description": "The requested amount of items per result page"
},
"entries": {
"type": "array",
"description": "List of WarehouseLocation",
"items": {
"$ref": "#\/definitions\/WarehouseLocation"
}
}
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/{warehouseId}\/locations\/dimensions": {
"get": {
"summary": "List warehouse location dimensions",
"description": "Lists all warehouse location dimensions.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/WarehouseLocationDimension"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/{warehouseId}\/locations\/level\/{warehouseLocationLevelId}": {
"get": {
"summary": "List warehouse locations by levelId",
"description": "Lists all warehouse locations by levelId.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "path"
},
{
"name": "levelId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse location level",
"format": "integer",
"in": "query"
},
{
"name": "warehouseLocationLevelId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/warehouses\/{warehouseId}\/locations\/levels": {
"get": {
"summary": "List warehouse location levels",
"description": "Lists all warehouse location levels.",
"tags": [
"Warehouse"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WarehouseLocationLevel"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "warehouseId",
"type": "integer",
"required": true,
"description": "The ID of the warehouse",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/webstores": {
"get": {
"summary": "List clients (stores)",
"description": "Lists all clients (stores)",
"tags": [
"Webstore"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Webstore"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/webstores\/{webstoreId}\/plugin_set": {
"get": {
"summary": "Find a plugin set",
"description": "Retrieve a plugin set by a webstore id",
"tags": [
"Webstore"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/PluginSet"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "webstoreId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Set a plugin set relation to a webstore",
"description": "Set a plugin set relation to a webstore by a webstore id and plugin set id",
"tags": [
"Webstore"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "webstoreId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards": {
"get": {
"summary": "List wizards",
"description": "Lists a wizard",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/wizards\/folders": {
"get": {
"summary": "List wizard folders",
"description": "Lists wizard folders",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/mixed"
}
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
}
}
},
"\/rest\/wizards\/{wizardKey}": {
"get": {
"summary": "Get a wizard",
"description": "Gets a wizard",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/Wizard"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards\/{wizardKey}\/actions\/{actionKey}": {
"post": {
"summary": "Perform an action of a registered actionHandlerClass of a given wizard",
"description": "Performs an action of a registered actionHandlerClass of a given wizard",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "actionKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards\/{wizardKey}\/data": {
"delete": {
"summary": "Delete a wizard data",
"description": "Deletes a wizard data",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a wizard data",
"description": "Gets a wizard data",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a wizard data",
"description": "Creates a wizard data",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a wizard data",
"description": "Updates a wizard data",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards\/{wizardKey}\/data\/{optionId}": {
"delete": {
"summary": "Delete a wizard data's option",
"description": "Deletes a wizard data option",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "optionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"get": {
"summary": "Get a wizard data by optionId",
"description": "Gets a wizard data by optionId",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "optionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"post": {
"summary": "Create a wizard data option",
"description": "Creates a wizard data option",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "optionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
},
"put": {
"summary": "Update a wizard data option",
"description": "Updates a wizard data option",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/mixed"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "optionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards\/{wizardKey}\/formfields\/{formfieldKey}": {
"post": {
"summary": "Load dynamic data",
"description": "",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "formfieldKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/wizards\/{wizardKey}\/settings\/{optionId}": {
"post": {
"summary": "Finalize the wizard",
"description": "",
"tags": [
"Wizard"
],
"security": [
{
"oAuth2": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#\/definitions\/SimpleRestResponse"
}
},
"401": {
"description": "The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."
}
},
"parameters": [
{
"name": "wizardKey",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
},
{
"name": "optionId",
"type": "integer",
"required": true,
"description": "",
"format": "integer",
"in": "path"
}
]
}
},
"\/rest\/io\/customer\/login": {
"post": {
"summary": "plentyMarketplace login",
"description": "Log in to plentyMarketplace.",
"tags": [
"plentyMarketplace"
],
"responses": {
"200": {
"description": "This call does not have a response output."
},
"401": {
"description": "This call does not have an error output."
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"description": "The email address associated with the service center account."
},
"password": {
"type": "string",
"description": "The password associated with the service center account."
}
}
}
}
]
}
},
"\/rest\/partner-portal\/partner-plugin\/visibility": {
"post": {
"summary": "Change plugin visibility",
"description": "Make a plugin visible or invisible on plentyMarketplace.",
"tags": [
"plentyMarketplace"
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "There is no plugin associated with the given item ID on plentyMarketplace."
}
},
"parameters": [
{
"name": "plentyID",
"type": "string",
"required": true,
"description": "Cookie from a successful login.",
"format": "string",
"in": "header"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"plentyID",
"itemId",
"isActive"
],
"properties": {
"plentyID": {
"type": "integer",
"description": "ID of the plentymarkets system used for uploading the plugin."
},
"itemId": {
"type": "integer",
"description": "ID of the plugin on plentyMarketplace."
},
"isActive": {
"type": "boolean",
"description": "Set to true to make the plugin visible on plentyMarketplace. Set to false to make it invisible."
}
}
}
}
]
}
}
},
"securityDefinitions": {
"oAuth2": {
"type": "oauth2",
"description": "Authorization for Plentymarkets REST-API Routes",
"flow": "accessCode",
"authorizationUrl": "https:\/\/example.com\/oauth\/authorize",
"tokenUrl": "https:\/\/example.com\/oauth\/token"
}
},
"definitions": {
"mixed": {
"type": "object",
"properties": {}
},
"TokenData": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The access token. Required for REST call authentication."
},
"tokenType": {
"type": "string",
"description": "The token type. The token type is Bearer."
},
"expiresIn": {
"type": "integer",
"description": "The expiration time in seconds that the access token is valid for"
},
"refreshToken": {
"type": "string",
"description": "The refresh token. Required for refreshing the access token."
}
}
},
"AccountingLocation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the accounting location"
},
"countryId": {
"type": "integer",
"description": "The ID of the country of the accounting location"
},
"name": {
"type": "string",
"description": "The name of the accounting location"
},
"clientId": {
"type": "integer",
"description": "The ID of the client that the accounting location belongs to"
},
"plentyId": {
"type": "integer",
"description": "The plenty ID of the client that the accounting location belongs to"
}
}
},
"PostingAccounts": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": ""
},
"locationId": {
"type": "integer",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"position": {
"type": "integer",
"description": ""
},
"subtype": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"account": {
"type": "string",
"description": ""
}
}
},
"RevenueAccountLocationConfiguration": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the revenue account configuration"
},
"locationId": {
"type": "integer",
"description": "The ID of the accounting location that the configuration belongs to"
},
"accountEu": {
"type": "string",
"description": "The account used for revenues that are exempt from VAT and that were sold within the European Union"
},
"accountExport": {
"type": "string",
"description": "The account used for revenues that are exempt from VAT and that were sold to outside the European Union"
}
}
},
"RevenueAccountCountryConfiguration": {
"type": "object",
"properties": {
"countryId": {
"type": "integer",
"description": "The ID of the country that the account configuration belongs to"
},
"revenueAccountLocationId": {
"type": "integer",
"description": "The ID configuration of the revenue account that these accounts are for."
}
}
},
"DebtorAccountConfiguration": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the debtor account configuration"
},
"locationId": {
"type": "integer",
"description": "The ID of the accounting location that the debtor account is associated with."
},
"mode": {
"type": "string",
"description": "The mode describes the criteria based on which pending amounts are assigned to a debtor account. The following modes are available:\n\n- character = The debtor accounts are selected based on the first character of customer information. The information and the order of the information that will be used are defined with the sequence. There are 3 different sequences available.<\/li>\n
- payment = The debtor accounts are selected based on the payment method.<\/li>\n
- country = The debtor accounts are selected based on the country of delivery.<\/li>\n
- country_payment = The debtor accounts are selected based on two criteria. The first criteria is the country and if the country is same as the country of the accounting location then the payment method is used to select the deptor account.<\/li>\n<\/ul>"
},
"sequence": {
"type": "string",
"description": "The sequence defines the order in which customer information will be used for the debtor account assignment if the character made has been chosen. The following sequences are available:\n
\n- FNV = stands for the sequence: company, lastname, firstname<\/li>\n
- NVF = stands for the sequence: lastname, firstname, company<\/li>\n
- NFV = stands for the sequence: lastname, company, firstname<\/li>\n<\/ul>"
},
"standard": {
"type": "string",
"description": "The standard debtor account that will be used if no matching debtor account can be found."
},
"save": {
"type": "boolean",
"description": "Flag that indicates if the debtor account shall be saved within the contact data."
}
}
},
"Collection": {
"type": "object",
"properties": {}
},
"PostingKeyConfiguration": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"description": "The ID of the accounting location that the configuration belongs to"
}
}
},
"AccountingLocationSettings": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"description": "The ID of the accounting location"
},
"isInvoiceEUNet": {
"type": "boolean",
"description": "Is the invoice net for EU?"
},
"isInvoiceExportNet": {
"type": "boolean",
"description": "Is the invoice net for export?"
},
"showShippingVat": {
"type": "boolean",
"description": "Show the vat for shipping costs on the invoice?"
},
"isSmallBusiness": {
"type": "boolean",
"description": "Is it a small business?"
},
"numberOfDecimalPlaces": {
"type": "integer",
"description": "The number of decimal places for prices"
},
"roundTotalsOnly": {
"type": "boolean",
"description": "Do only round totals?"
}
}
},
"Account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the account"
},
"number": {
"type": "string",
"description": "The number of the account"
},
"companyName": {
"type": "string",
"description": "The company name"
},
"taxIdNumber": {
"type": "string",
"description": "The ID of the tax number"
},
"valuta": {
"type": "integer",
"description": "The valuta date in days specified for the account"
},
"discountDays": {
"type": "integer",
"description": "The early payment discount period in days specified for the account"
},
"discountPercent": {
"type": "number",
"description": "The early payment discount in percent specified for the account"
},
"timeForPaymentAllowedDays": {
"type": "integer",
"description": "The payment due date in days specified for the account"
},
"salesRepresentativeContactId": {
"type": "integer",
"description": "The contact ID of the sales representative"
},
"userId": {
"type": "integer",
"description": "The ID of the account owner"
},
"deliveryTime": {
"type": "integer",
"description": "The delivery time for the supplier"
},
"dealerMinOrderValue": {
"type": "number",
"description": "The minimum order value for the supplier"
},
"supplierCurrency": {
"type": "string",
"description": "The currency used by a supplier"
},
"createdAt": {
"type": "string",
"description": "The time the account was created as unix timestamp"
},
"updatedAt": {
"type": "string",
"description": "The time the account was last updated as unix timestamp"
}
}
},
"Address": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address"
},
"gender": {
"type": "string",
"description": "The gender (\"female\", \"male\" or \"diverse\")"
},
"name1": {
"type": "string",
"description": "The name 1 field (defaults to: company name)"
},
"name2": {
"type": "string",
"description": "The name 2 field (defaults to: first name)"
},
"name3": {
"type": "string",
"description": "The name 3 field (defaults to: last name)"
},
"name4": {
"type": "string",
"description": "The name 4 field (defaults to: c\/o)"
},
"address1": {
"type": "string",
"description": "The address 1 field (defaults to: street|'PACKSTATION'|'POSTFILIALE')"
},
"address2": {
"type": "string",
"description": "The address 2 field (defaults to: houseNumber|packstationNo)"
},
"address3": {
"type": "string",
"description": "The address 3 field (defaults to: additional)"
},
"address4": {
"type": "string",
"description": "The address 4 field is currently undefined and can be freely used."
},
"postalCode": {
"type": "string",
"description": "The postcode"
},
"town": {
"type": "string",
"description": "The town"
},
"countryId": {
"type": "integer",
"description": "The ID of the country"
},
"stateId": {
"type": "integer",
"description": "The ID of the state"
},
"readOnly": {
"type": "boolean",
"description": "Flag that indicates if the data record is read only"
},
"companyName": {
"type": "string",
"description": "The company name (alias for name1, read only<\/i>)"
},
"firstName": {
"type": "string",
"description": "The first name (alias for name2, read only<\/i>)"
},
"lastName": {
"type": "string",
"description": "The last name (alias for name3, read only<\/i>)"
},
"careOf": {
"type": "string",
"description": "The c\/o (alias for name4, read only<\/i>)"
},
"street": {
"type": "string",
"description": "The street (alias for address1, read only<\/i>)"
},
"houseNumber": {
"type": "string",
"description": "The house number (alias for address2, read only<\/i>)"
},
"additional": {
"type": "string",
"description": "The additional address information (alias for address3, read only<\/i>)"
},
"checkedAt": {
"type": "string",
"description": "The time the address was checked as unix timestamp"
},
"createdAt": {
"type": "string",
"description": "The time the address was created as unix timestamp"
},
"updatedAt": {
"type": "string",
"description": "The time the address was last updated as unix timestamp"
},
"taxIdNumber": {
"type": "string",
"description": "The taxIdNumber option (alias for option with typeId 1, read only<\/i>)"
},
"externalId": {
"type": "string",
"description": "The externalId option (alias for option with typeId 2, read only<\/i>)"
},
"entryCertificate": {
"type": "boolean",
"description": "The entryCertificate option (alias for option with typeId 3, read only<\/i>)"
},
"phone": {
"type": "string",
"description": "The phone option (alias for option with typeId 4, read only<\/i>)"
},
"email": {
"type": "string",
"description": "The email option (alias for option with typeId 5, read only<\/i>)"
},
"postident": {
"type": "string",
"description": "The PostIdent option (alias for option with typeId 6, read only<\/i>)"
},
"personalNumber": {
"type": "string",
"description": "The personal number option (alias for option with typeId 7, read only<\/i>)"
},
"fsk": {
"type": "string",
"description": "The age rating option (alias for option with typeId 8, read only<\/i>)"
},
"birthday": {
"type": "string",
"description": "The birthday option (alias for option with typeId 9, read only<\/i>)"
},
"title": {
"type": "string",
"description": "The title option (alias for option with typeId 11, read only<\/i>)"
},
"sessionId": {
"type": "string",
"description": "The fronetnd session ID that was used when the address was created (alias for option with typeId 10, read only<\/i>)"
},
"contactPerson": {
"type": "string",
"description": "The contact person option (alias for option with typeId 12, read only<\/i>)"
},
"packstationNo": {
"type": "string",
"description": "The packstation number (alias for houseNumber and address2, read only<\/i>)"
},
"isPackstation": {
"type": "boolean",
"description": "Flag that indicates if the address is a packstation"
},
"isPostfiliale": {
"type": "boolean",
"description": "Flag that indicates if the address is a postfiliale (post office)"
}
}
},
"AddressContactRelation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address contact relation"
},
"contactId": {
"type": "integer",
"description": "The ID of the contact"
},
"typeId": {
"type": "integer",
"description": "The type ID of the address. Possible values:\n
\n- Invoice address = 1<\/li>\n
- Delivery address = 2<\/li>\n<\/ul>"
},
"addressId": {
"type": "integer",
"description": "The ID of the address"
},
"isPrimary": {
"type": "boolean",
"description": "Flag that indicates if the address is primary"
}
}
},
"AddressOptionType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address option type. It is possible to define individual types. The following types are available by default:\n
\n- 1 = VAT number<\/li>\n
- 2 = External address ID<\/li>\n
- 3 = Entry certificate<\/li>\n
- 4 = Telephone<\/li>\n
- 5 = Email<\/li>\n
- 6 = Post number<\/li>\n
- 7 = Personal id<\/li>\n
- 8 = BBFC (age rating)<\/li>\n
- 9 = Birthday<\/li>\n
- 10 = Session ID<\/li>\n
- 11 = Title<\/li>\n
- 12 = Contact person<\/li>\n<\/ul>"
},
"position": {
"type": "integer",
"description": "The position for sorting"
},
"nonErasable": {
"type": "integer",
"description": "Flag that indicates if the type can be deleted"
}
}
},
"AddressOption": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address option"
},
"addressId": {
"type": "integer",
"description": "The ID of the address"
},
"typeId": {
"type": "integer",
"description": "The ID of the address option type"
},
"value": {
"type": "string",
"description": "The option value"
},
"position": {
"type": "integer",
"description": "The position for sorting"
},
"createdAt": {
"type": "string",
"description": "The time the option was created as unix timestamp"
},
"updatedAt": {
"type": "string",
"description": "The time the option was last updated as unix timestamp"
}
}
},
"AddressPosRelation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address POS relation"
},
"posBaseId": {
"type": "string",
"description": "The ID of the POS base"
},
"addressId": {
"type": "string",
"description": "The ID of the address"
},
"typeId": {
"type": "integer",
"description": "The ID of the relation type"
}
}
},
"AddressRelationType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address relation type. The following types are available by default and cannot be deleted:\n
\n- 1 = Billing address<\/li>\n
- 2 = Delivery address<\/li>\n
- 3 = Sender address<\/li>\n
- 4 = Return address<\/li>\n
- 5 = Client address<\/li>\n
- 6 = Contractor address<\/li>\n
- 7 = Warehouse address<\/li>\n
- 8 = POS address<\/li>\n<\/ul>"
},
"position": {
"type": "integer",
"description": "The position for sorting"
},
"nonErasable": {
"type": "integer",
"description": "Flag that indicates if the type can be deleted"
}
}
},
"AddressWarehouseRelation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the address warehouse relation"
},
"warehouseId": {
"type": "integer",
"description": "The ID of the warehouse"
},
"typeId": {
"type": "integer",
"description": "The ID of the type"
},
"addressId": {
"type": "integer",
"description": "The ID of the address"
}
}
},
"AccountContactRelation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the account contact relation"
},
"accountId": {
"type": "integer",
"description": "The ID of the foreign key account"
},
"contactId": {
"type": "integer",
"description": "The ID of the foreign key contact"
}
}
},
"Contact": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the contact"
},
"externalId": {
"type": "string",
"description": "The external ID of the contact"
},
"number": {
"type": "string",
"description": "The number of the contact (previous customer number)"
},
"typeId": {
"type": "integer",
"description": "The ID of the contact type"
},
"firstName": {
"type": "string",
"description": "The first name of the contact"
},
"lastName": {
"type": "string",
"description": "The last name of the contact"
},
"fullName": {
"type": "string",
"description": "The full name of the contact. A concatenation of first and last name."
},
"email": {
"type": "string",
"description": "The private email address of the contact"
},
"secondaryEmail": {
"type": "string",
"description": "The secondary private email address of the contact"
},
"gender": {
"type": "string",
"description": "The gender of the contact (\"female\", \"male\" or \"diverse\")"
},
"title": {
"type": "string",
"description": "The title of the contact, e.g. a doctorate"
},
"formOfAddress": {
"type": "string",
"description": "The form of address for the contact"
},
"newsletterAllowanceAt": {
"type": "string",
"description": "The time the contact registered for the newsletter as unix timestamp"
},
"classId": {
"type": "integer",
"description": "The ID of the contact class"
},
"blocked": {
"type": "integer",
"description": "The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:\n
\n- 0 = not blocked<\/li>\n
- 1 = blocked<\/li>\n<\/ul>"
},
"rating": {
"type": "integer",
"description": "The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:\n
\n